Agent Feedback Evaluation

Supports development and operations personnel in inspecting and evaluating the quality of content generated by the Agent, helping assess response quality and guide further optimization.

Request Method

POST

Endpoint

https://api-${endpoint}.gptbots.ai/v1/message/quality

Authentication

For details, refer to the authentication method description in the API Overview.

Request

Request Example

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/message/quality' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "answer_id": "123456789", "quality": "FULLY_RESOLVED" }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/message/quality' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
        "answer_id": "123456789",
        "quality": "FULLY_RESOLVED"
}'

This code block in the floating window

Request Headers

Field	Type	Description
Authorization	Bearer ${API Key}	Use Authorization: Bearer ${API Key} for authentication. Get API key from API Key page.
Content-Type	application/json	Data type, value should be application/json.

Request Parameters

Field	Type	Required	Description
answer_id	string	Yes	The reply ID of the Agent.
quality	string	Yes	Quality assurance evaluation of the Agent's response. Possible values: - NONE: No feedback - UNRESOLVED: Unresolved - PARTIALLY_RESOLVED: Partially resolved - FULLY_RESOLVED: Fully resolved

Response

Response Example

{ "affectCount": 2 }

                      
                      {
    "affectCount": 2
}

This code block in the floating window

Successful Response

Field	Type	Description
affectCount	long	The number of successful evaluations in this instance. A value of 2 indicates success.

Error Response

Field	Type	Description
code	int	Error code
message	string	Error details

Error Codes

Code	Message
40000	Parameter error
40127	Developer authentication failed
20059	Agent has been deleted