Pull Dataset

GEThttps://api.confident-ai.com/v1/datasets/{alias}

Retrieves a list of Goldens or ConversationalGoldens from your dataset.

GET/v1/datasets/{alias}

curl -X GET "https://api.confident-ai.com/v1/datasets/{alias}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "id": "string",
    "version": "string",
    "goldens": [
      {
        "input": "string",
        "actualOutput": "string",
        "expectedOutput": "string",
        "retrievalContext": [
          "string"
        ],
        "context": [
          "string"
        ],
        "toolsCalled": [
          {
            "name": null,
            "description": null,
            "inputParameters": null,
            "output": null,
            "reasoning": null
          }
        ],
        "expectedTools": [
          {
            "name": null,
            "description": null,
            "inputParameters": null,
            "output": null,
            "reasoning": null
          }
        ],
        "additionalMetadata": {},
        "comments": "string",
        "sourceFile": "string",
        "finalized": true,
        "customColumnKeyValues": {}
      }
    ]
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

aliasstringRequired
The unique alias of the dataset.

Query parameters

versionstring
Version to pull. Defaults to the latest version.
finalizedenumdefault: true
Filter by finalized state. Defaults to "true".

Response

successboolean
This is true if the dataset was successfully pulled.
dataobject | object
Show 2 variantsHide 2 variants
- Single-Turnobject
  Dataset with single-turn goldens
  Show 3 propertiesHide 3 properties
  - idstring
    A unique identifier for a dataset
  - versionstring
    The resolved version of the dataset returned. null if the dataset has no versions yet.
  - goldenslist of objects
    Show 12 propertiesHide 12 properties
    inputstring
    This is the input to your LLM application.
    actualOutputstring
    This is the actual output of your LLM application.
    expectedOutputstring
    This is the expected output of your LLM application, which is the ideal actual output.
    retrievalContextlist of strings
    This is the retrieval context of your LLM application.
    contextlist of strings
    This is the ideal retrieval context of your LLM application.
    toolsCalledlist of objects
    This is the tools called by your LLM application.
    Show 5 propertiesHide 5 properties
    namestring
    This is the name of the tool.
    descriptionstring
    This is the description of the tool.
    inputParametersobject
    This is the input parameters that are passed to the tool.
    outputstring
    This is the output of the tool.
    reasoningstring
    This is the reasoning your LLM provided for the tool call.
    expectedToolslist of objects
    This is the expected tools to be called by the LLM application.
    Show 5 propertiesHide 5 properties
    namestring
    This is the name of the tool.
    descriptionstring
    This is the description of the tool.
    inputParametersobject
    This is the input parameters that are passed to the tool.
    outputstring
    This is the output of the tool.
    reasoningstring
    This is the reasoning your LLM provided for the tool call.
    additionalMetadataobject
    This is any additional metadata you wish to associate with the golden.
    commentsstring
    This is any comments you wish to associate with the golden.
    sourceFilestring
    This is the source file from which the golden was retrieved.
    finalizedboolean
    This determines whether the golden has been finalized.
    customColumnKeyValuesobject
    Key-value pairs representing custom table column data for this golden. Keys correspond to the custom column keys defined in the dataset.
- OR
- Multi-Turnobject
  Dataset with multi-turn goldens
  Show 3 propertiesHide 3 properties
  - idstring
    A unique identifier for a dataset
  - versionstring
    The resolved version of the dataset returned. null if the dataset has no versions yet.
  - conversationalGoldenslist of objects
    Show 10 propertiesHide 10 properties
    scenariostring
    This is a description of the conversation context.
    userDescriptionstring
    This is the description of the user in the conversation.
    expectedOutcomestring
    This describes the expected outcome, or ideal conversation flow, of the conversation.
    turnslist of objects
    This is the list of turns in the conversation.
    Show 5 propertiesHide 5 properties
    roleenum
    The role of the turn, either user or assistant.
    Show 2 enum valuesHide 2 enum values
    user
    assistant
    contentstring
    The message content of the turn.
    userIdstring
    The user ID associated with the turn.
    retrievalContextlist of strings
    The contexts retrieved to generate the LLM response for this turn.
    toolsCalledlist of objects
    The tools called to generate the LLM response for this turn.
    Show 5 propertiesHide 5 properties
    namestring
    This is the name of the tool.
    descriptionstring
    This is the description of the tool.
    inputParametersobject
    This is the input parameters that are passed to the tool.
    outputstring
    This is the output of the tool.
    reasoningstring
    This is the reasoning your LLM provided for the tool call.
    contextlist of strings
    This is the context of the conversation.
    additionalMetadataobject
    This is any additional metadata you wish to associate with the golden.
    commentsstring
    This is any comments you wish to associate with the golden.
    sourceFilestring
    This is the source file from which the golden was retrieved.
    finalizedboolean
    This determines whether the golden has been finalized.
    customColumnKeyValuesobject
    Key-value pairs representing custom table column data for this golden. Keys correspond to the custom column keys defined in the dataset.

Built byConfident AI