DOC-API-MODEL-schema-1iroqctqt1#overview
MessageFeedback
One user's feedback on an assistant-generated message.
kind must select a listed feedback representation. Requiredness and allowed values are declared separately.
Type-reference view: API Schema 9frhv4euve, API Schema 9ftjkkjhfa. Request and response views describe this type; they do not declare an endpoint.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1iroqctqt1#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1iroqctqt1#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
| In responses | View fields |
In requests
Section ID: DOC-API-MODEL-schema-1iroqctqt1#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1iroqctqt1#request-field-kindkind | string (FEEDBACK_KIND_THUMB, FEEDBACK_KIND_SCALE) or integer (int32) (0, 1) | Required in requests | Rating representation used to interpret the feedback value. |
Section ID: DOC-API-MODEL-schema-1iroqctqt1#request-field-thumbupthumbUp | boolean | Optional | Positive when true and negative when false; used for THUMB feedback. |
Section ID: DOC-API-MODEL-schema-1iroqctqt1#request-field-ratingrating | string (int64) | Optional | Numeric quality rating for SCALE feedback; the scale endpoints mean poor and excellent. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1iroqctqt1#request-field-reasonreason | string | Optional | Optional explanation for the rating. Maximum length: 1000. |
Section ID: DOC-API-MODEL-schema-1iroqctqt1#request-field-ratedatratedAt | string (date-time) | Optional | Timestamp when feedback was submitted (server-set) |
Section ID: DOC-API-MODEL-schema-1iroqctqt1#request-field-ratedbyratedBy | string | Optional | Identifier of the user who submitted this feedback. Set by the server from the authenticated user identity; never client-supplied. Each user has one feedback entry per message. |
Values of kind
Section ID: DOC-API-MODEL-schema-1iroqctqt1#request-values-kind
Value scale used to interpret recorded feedback.
| Value | No. | Form | Meaning |
|---|---|---|---|
FEEDBACK_KIND_THUMB | 0 | Canonical | See meaning below. |
FEEDBACK_KIND_SCALE | 1 | Canonical | See meaning below. |
FEEDBACK_KIND_THUMB
Binary positive or negative feedback, represented by a thumbs-up or thumbs-down choice.
binary thumbs up / down
FEEDBACK_KIND_SCALE
Feedback expressed as an integer rating from 1 through 10.
1-10 integer scale
Request validation
Section ID: DOC-API-MODEL-schema-1iroqctqt1#request-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
kind | Required value | true |
kind | Defined enum value | true |
rating | At most | 10 |
rating | At least | 0 |
reason | Maximum length | 1000 |
In responses
Section ID: DOC-API-MODEL-schema-1iroqctqt1#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1iroqctqt1#field-kindSection ID: DOC-API-MODEL-schema-1iroqctqt1#response-field-kindkind | string (FEEDBACK_KIND_THUMB, FEEDBACK_KIND_SCALE) or integer (int32) | Required in requests | Rating representation used to interpret the feedback value. |
Section ID: DOC-API-MODEL-schema-1iroqctqt1#field-thumbupSection ID: DOC-API-MODEL-schema-1iroqctqt1#response-field-thumbupthumbUp | boolean | Optional | Positive when true and negative when false; used for THUMB feedback. |
Section ID: DOC-API-MODEL-schema-1iroqctqt1#field-ratingSection ID: DOC-API-MODEL-schema-1iroqctqt1#response-field-ratingrating | string (int64) | Optional | Numeric quality rating for SCALE feedback; the scale endpoints mean poor and excellent. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1iroqctqt1#field-reasonSection ID: DOC-API-MODEL-schema-1iroqctqt1#response-field-reasonreason | string | Optional | Optional explanation for the rating. |
Section ID: DOC-API-MODEL-schema-1iroqctqt1#field-ratedatSection ID: DOC-API-MODEL-schema-1iroqctqt1#response-field-ratedatratedAt | string (date-time) | Optional | Timestamp when feedback was submitted (server-set) |
Section ID: DOC-API-MODEL-schema-1iroqctqt1#field-ratedbySection ID: DOC-API-MODEL-schema-1iroqctqt1#response-field-ratedbyratedBy | string | Optional | Identifier of the user who submitted this feedback. Set by the server from the authenticated user identity; never client-supplied. Each user has one feedback entry per message. |
Values of kind
Section ID: DOC-API-MODEL-schema-1iroqctqt1#response-values-kind
Value scale used to interpret recorded feedback.
| Value | No. | Form | Meaning |
|---|---|---|---|
FEEDBACK_KIND_THUMB | 0 | Canonical | See meaning below. |
FEEDBACK_KIND_SCALE | 1 | Canonical | See meaning below. |
FEEDBACK_KIND_THUMB
Binary positive or negative feedback, represented by a thumbs-up or thumbs-down choice.
binary thumbs up / down
FEEDBACK_KIND_SCALE
Feedback expressed as an integer rating from 1 through 10.
1-10 integer scale
DOC-API-MODEL-schema-1iroqctqt1#validation
Request validation
Section ID: DOC-API-MODEL-schema-1iroqctqt1#response-validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
kind | Required value | true |
kind | Defined enum value | true |
rating | At most | 10 |
rating | At least | 0 |
reason | Maximum length | 1000 |
Where used
Section ID: DOC-API-MODEL-schema-1iroqctqt1#where-used
| Reference | Relationship |
|---|---|
| Withdraw your rating on a message | POST /api/v1/llm/delete-message-rating |
| Get full conversation state | POST /api/v1/llm/conversation-state |
| Rate an assistant message | POST /api/v1/llm/rate-message |
| Send a message and wait for the result | POST /api/v1/llm/send-message-sync |
| Submit client-side tool results and wait for the next segment | POST /api/v1/llm/submit-client-tool-results-sync |
| Append a message without generating | POST /api/v1/llm/append-message |
| Send a message to a conversation | POST /api/v1/llm/send-message |
| ReceiveMessageRequest | API JSON uses JSON field names (camelCase). |
| ClientToolDispatch | API JSON uses JSON field names (camelCase). |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1iroqctqt1