Simulate Conversation

POSThttps://api.confident-ai.com/v1/simulate

Simulate the next conversation turn from a conversational golden.

POST/v1/simulate

curl -X POST "https://api.confident-ai.com/v1/simulate" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationalGolden": {
    "scenario": "A frustrated user asking for a refund.",
    "userDescription": "A white male who is a customer for over 2 years."
  }
}'

200

{
  "success": true,
  "data": {
    "simulationId": "SIMULATION-ID",
    "completed": false,
    "userResponse": "I'd like my refund please.",
    "turns": [
      {
        "role": "assistant",
        "content": "Hey, how can I help you today?"
      },
      {
        "role": "user",
        "content": "I'd like my refund please."
      }
    ]
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request body

conversationalGoldenobjectRequired
A Conversational Golden that is used to simulate your conversations
Show 11 propertiesHide 11 properties
- idstring
  Server-assigned identifier, returned when the dataset is pulled. Use it to update or delete this golden. Not accepted when pushing.
- 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

successboolean
This is true if the next turn in the conversation was successfully simulated.
dataobject
Show 4 propertiesHide 4 properties
- simulationIdstring
  This is the unique ID for the simulation.
- completedboolean
  This is true if the conversation is complete, which means the expected outcome has been reached.
- userResponsestring
  This is the simulated user response of the last turn in the conversation.
- turnslist of objects
  This is the list of all the 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.
deprecatedboolean
This is true if this endpoint is deprecated.

Built byConfident AI