Queue Goldens

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

Queues Goldens or ConversationalGoldens to a dataset as unfinalized goldens for later review. If the dataset alias does not exist yet, a new dataset is created automatically.

Provide either goldens (single-turn) or conversationalGoldens (multi-turn), but not both.

POST/v1/datasets/{alias}/queue

curl -X POST "https://api.confident-ai.com/v1/datasets/{alias}/queue" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "goldens": [
    {
      "input": "string",
      "actualOutput": "string",
      "expectedOutput": "string",
      "retrievalContext": [
        "string"
      ],
      "context": [
        "string"
      ],
      "toolsCalled": [
        {
          "name": "string",
          "description": "string",
          "inputParameters": {},
          "output": "string",
          "reasoning": "string"
        }
      ],
      "expectedTools": [
        {
          "name": "string",
          "description": "string",
          "inputParameters": {},
          "output": "string",
          "reasoning": "string"
        }
      ],
      "additionalMetadata": {},
      "comments": "string",
      "sourceFile": "string",
      "finalized": true,
      "customColumnKeyValues": {}
    }
  ],
  "conversationalGoldens": [
    {
      "scenario": "string",
      "userDescription": "string",
      "expectedOutcome": "string",
      "turns": [
        {
          "role": "user",
          "content": "string",
          "userId": "string",
          "retrievalContext": [
            "string"
          ],
          "toolsCalled": [
            {
              "name": null,
              "description": null,
              "inputParameters": null,
              "output": null,
              "reasoning": null
            }
          ]
        }
      ],
      "context": [
        "string"
      ],
      "additionalMetadata": {},
      "comments": "string",
      "sourceFile": "string",
      "finalized": true,
      "customColumnKeyValues": {}
    }
  ]
}'

200

{
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/datasets/<DATASET-ID>"
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

aliasstringRequired
The unique alias of the dataset.

Request body

goldenslist of objects
This is a list of single-turn goldens to queue. If you are queueing conversational goldens, this should be null.
Show 12 propertiesHide 12 properties
- inputstringRequired
  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
  - namestringRequired
    This is the name of the tool.
  - descriptionstringRequired
    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
  - namestringRequired
    This is the name of the tool.
  - descriptionstringRequired
    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.
conversationalGoldenslist of objects
This is a list of conversational goldens to queue. If you are queueing single-turn goldens, this should be null.
Show 10 propertiesHide 10 properties
- scenariostringRequired
  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
  - roleenumRequired
    The role of the turn, either user or assistant.
    Show 2 enum valuesHide 2 enum values
    user
    assistant
  - contentstringRequired
    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
    namestringRequired
    This is the name of the tool.
    descriptionstringRequired
    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.

Response

linkstring
A link to the dataset the goldens were queued to.

Built byConfident AI