Sign in
/agents/{id}/query

Provide Feedback

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.

If providing feedback on a retrieval, include the message_id from the /query response, and a content_id returned in the query's retrieval_contents list.

For feedback on generations, include message_id and do not include a content_id.

post/agents/{agent_id}/feedback

Path parameters

agent_idstring uuid required

ID of the agent for which to provide feedback

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.

Response

Successful Response

EmptyResponse required

Changes