Generate Journey Goldens

(v2)

POST

Generates multi-turn goldens for the chosen paths of a journey and adds them to a multi-turn dataset. Your project's platform model writes one scenario and expected outcome per path from its states' instructions and edge conditions, so this consumes usage; if no platform model is configured, or writing one fails, the scenario is the path's instructions joined in order. Each golden remembers its path, so the journey reports coverage and path results for it.

POST/v2/journeys/{journeyId}/goldens

curl -X POST "https://api.confident-ai.com/v2/journeys/{journeyId}/goldens" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "datasetId": "<DATASET-ID>",
  "personaId": "<PERSONA-ID>",
  "paths": [
    {
      "stateIds": [
        "<JOURNEY-STATE-ID>"
      ],
      "count": 3
    }
  ]
}'

200

{
  "success": true,
  "data": {
    "goldenCount": 9
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/journeys/<JOURNEY-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

journeyIdstringRequired
The id of the journey.

Request body

datasetIdstringRequired
The id of the dataset to add the goldens to. It must be a multi-turn dataset in this project.
personaIdstring | null
The id of a persona to attach to every golden, so the simulated user is played in its voice and the scenarios are written for it. Send null or omit it for no persona.
pathslist of objectsRequired
The paths to generate goldens for, and how many for each. At most 50, the most paths a journey lists. A path listed twice uses its last count.
Show 2 propertiesHide 2 properties
- stateIdslist of stringsRequired
  The ids of the path's states, in order from the root state, exactly as the journey lists them under paths. A path that is not one of the journey's paths is skipped.
- countintegerRequired
  How many goldens to generate for the path, at most 100. They all share one scenario, and differ only in how each simulated conversation plays out.

Response

Generate Journey Goldens succeeded.

successboolean
Indicates if the request was successful.
dataobject
How many goldens were generated from a journey's paths.
Show 1 propertyHide 1 property
- goldenCountinteger
  The number of goldens created.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI