COcontextualai
/agents/{id}/query

Provide Feedback

Changed on

Provide feedback for a generation or a retrieval. Feedback can be used to track overall Agent performance through the Feedback page in the Contextual UI, and as a basis for model fine-tuning.

post/agents/{agent_id}/feedback

Request

  • Base URL
    https://api.contextual.ai/v1
  • URL
    https://api.contextual.ai/v1/agents/{agent_id}/feedback
  • Auth
    HTTP bearer

Path parameters

agent_idstring uuid required

ID of the agent for which to provide feedback

Request body

message_idstring uuid required

ID of the message on which to provide feedback.

feedback'thumbs_up' | 'thumbs_down' | 'flagged' | 'removed' required
explanationstring

Optional explanation for the feedback.

content_idstring uuid

ID of the content on which to provide feedback, if feedback is on retrieval. Do not set (or set to null) while providing generation feedback.

query_categorystring

The query category for the feedback.

Response

Successful Response

feedback_idstring uuid required

ID of the submitted or updated feedback.

Changes