Set Thread Evaluation

Set the evaluation (OK / KO / NEUTRAL / NOT_EVALUATED) for a conversation thread.

POST /api/v1/conversations/{thread_id}/evaluation

Set Thread Evaluation

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/conversations/{thread_id}/evaluation \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "evaluation": "<string>"
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/conversations/{thread_id}/evaluation"

payload = { "evaluation": "<string>" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({evaluation: '<string>'})
};

fetch('https://{tenant_id}.api.useago.com/api/v1/conversations/{thread_id}/evaluation', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "id": "<string>",
  "object": "thread",
  "user_email": "<string>",
  "evaluation": "<string>",
  "evaluation_comment": "<string>",
  "reviewed_at": "<string>",
  "admin_status": {
    "id": "<string>",
    "name": "<string>",
    "object": "thread_admin_status",
    "color": "<string>"
  },
  "admin_tags": [],
  "llm_judge_evaluated": false,
  "llm_judge_need_review": false,
  "cx_score": 123,
  "created_at": "<string>",
  "updated_at": "<string>",
  "message_count": 0
}

Authorizations

X-API-Key · string · header · required

Path Parameters

thread_id · string · required

Body

application/json

evaluation · string · required

Response

200 - application/json

OK

id · string · required

object · string · default: thread

user_email · string | null

evaluation · string | null

evaluation_comment · string | null

reviewed_at · string | null

admin_status · ThreadAdminStatusOut · object | null

Show child attributes

admin_tags · ThreadAdminTagOut · object[]

Show child attributes

llm_judge_evaluated · boolean · default: false

llm_judge_need_review · boolean · default: false

cx_score · number | null

created_at · string | null

updated_at · string | null

message_count · integer · default: 0