Evaluate Thread

POSThttps://api.confident-ai.com/v1/evaluate/threads/{threadId}

Triggers evaluation of a thread using a specified metric collection and optional chatbot role instructions.

POST/v1/evaluate/threads/{threadId}

curl -X POST "https://api.confident-ai.com/v1/evaluate/threads/{threadId}" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "metricCollection": "Collection Name",
  "chatbotRole": "You are a rich, powerful..."
}'

200

{
  "success": true,
  "data": {
    "id": "THREAD-ID"
  },
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Path parameters

threadIdstringRequired
The thread ID of the thread you wish to evaluate.

Request body

metricCollectionstringRequired
This is the name of the multi-turn metric collection to evaluate the thread.
chatbotRolestring
The role or purpose of the chatbot in the thread.

Response

successboolean
This is true if the thread was successfully evaluated.
dataobject
Show 1 propertyHide 1 property
- idstring
  This is the id of the thread generated by Confident AI, not to be confused with the thread id you supplied.
deprecatedboolean
This is true if this endpoint is deprecated.

Built byConfident AI