PATCH
/
conversations
/
{conversationId}
/
set-score
curl --request PATCH \
  --url https://api.hyperleapai.com/conversations/{conversationId}/set-score \
  --header 'Content-Type: application/json' \
  --header 'x-hl-api-key: <api-key>' \
  --data '{
  "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "score": 123,
  "scoreText": "<string>",
  "scoreTags": "<string>"
}'
{
  "conversationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "aiSystem": "<string>",
  "model": "<string>",
  "personaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "personaVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "conversationStatus": "<string>",
  "conversationName": "<string>",
  "chatMessages": [
    {
      "role": "<string>",
      "content": "<string>",
      "toolCallId": "<string>",
      "name": "<string>",
      "messageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timestamp": "2023-11-07T05:31:56Z",
      "feedbacks": [
        {
          "feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "score": 0,
          "comments": "<string>",
          "tags": [
            "<string>"
          ],
          "timestamp": "2023-11-07T05:31:56Z",
          "scoreConfidence": 0.5
        }
      ],
      "promptTokens": 123,
      "completionTokens": 123,
      "totalTokens": 123,
      "conversationRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "chatMessagesCount": 123,
  "chatStarted": true,
  "areChatMessagesInBlob": true,
  "chatMessagesBlobUri": "<string>",
  "configuration": {},
  "metadata": {},
  "externalUserId": "<string>",
  "isActive": true,
  "isDeleted": true,
  "promptTokens": 123,
  "completionTokens": 123,
  "totalTokens": 123
}

Authorizations

x-hl-api-key
string
header
required

API Key for authentication

Path Parameters

conversationId
string
required

Body

Response

200
text/plain

OK

The response is of type object.