AI Chat Feedback

Submit thumbs-up/down style feedback for an AI chat exchange (rating: positive or negative), plus optional reason, comment, and language.

POST /api/v4/{customerId}/{engineId}/search/answer/feedback

AI Chat Feedback

cURL

curl --request POST \
  --url https://api.cludo.com/api/v4/{customerId}/{engineId}/search/answer/feedback \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "<string>",
  "exchangeId": "<string>",
  "reason": "<string>",
  "comment": "<string>"
}
'

import requests

url = "https://api.cludo.com/api/v4/{customerId}/{engineId}/search/answer/feedback"

payload = {
    "conversationId": "<string>",
    "exchangeId": "<string>",
    "reason": "<string>",
    "comment": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    conversationId: '<string>',
    exchangeId: '<string>',
    reason: '<string>',
    comment: '<string>'
  })
};

fetch('https://api.cludo.com/api/v4/{customerId}/{engineId}/search/answer/feedback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    conversationId: '<string>',
    exchangeId: '<string>',
    reason: '<string>',
    comment: '<string>'
  })
};

fetch('https://api.cludo.com/api/v4/{customerId}/{engineId}/search/answer/feedback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

400

{
  "message": "The request could not be processed. Check the request body and required parameters."
}

{
  "status": "InternalServerError",
  "code": 500,
  "messages": [
    "Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ]
}

Authorizations

SiteKeyBasicAuth

Authorization · string · header · required

SiteKey authentication. Pass the full value including the SiteKey prefix: SiteKey <base64(customerId:engineId:searchKey)>. Example: SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1.

Path Parameters

customerId · integer · required

Your Cludo account ID.

engineId · integer · required

Search engine ID.

Body

application/json

Provide at least one of rating, reason, or comment with non-empty values.

conversationId · string · required

Must match the conversationId returned with the answer you are rating.

exchangeId · string · required

Must match the exchangeId for that answer.

rating · enum<string>

Thumbs-style sentiment. The API accepts these values case-insensitively (e.g. Positive is valid).

Available options: positive, negative

reason · string

Structured reason for the rating (e.g. a selected option from your UI).

comment · string

Free-form user comment.

Response

200

Feedback recorded successfully. The response has no body.