Evaluate Thread | Confident AI Docs

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

idstringRequired

The id of the thread you wish to evaluate.

CONFIDENT_API_KEYstringRequired

The API key of your Confident AI project.

metricCollectionstringRequired

This is the name of the multi-turn metric collection to evaluate the thread.

chatbotRolestringOptional

The role or purpose of the chatbot in the thread.

successboolean

This is true if the thread was successfully evaluated.

dataobject

deprecatedboolean

This is true if this endpoint is deprecated.

1	import requests
2
3	url = "https://api.confident-ai.com/v1/evaluate/threads/id"
4
5	payload = {
6	"metricCollection": "Collection Name",
7	"chatbotRole": "You are a rich, powerful..."
8	}
9	headers = {
10	"CONFIDENT_API_KEY": "<PROJECT-API-KEY>",
11	"Content-Type": "application/json"
12	}
13
14	response = requests.post(url, json=payload, headers=headers)
15
16	print(response.json())