Comment
Authored text attached to a trace, observation, or other evaluation object.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
commentId | string | Optional | Identifier of the evaluation comment. |
objectType | string (COMMENT_OBJECT_TYPE_TRACE, COMMENT_OBJECT_TYPE_OBSERVATION, COMMENT_OBJECT_TYPE_SESSION, COMMENT_OBJECT_TYPE_PROMPT) or integer (int32) | Optional | Kind of evaluation object addressed by the comment or annotation queue item. |
objectId | string | Optional | Identifier of the evaluation object addressed by the comment or queue item. |
content | string | Optional | Text content of the evaluation comment. |
authorUserId | string | Optional | Identifier recorded for the user who authored the comment. |
createdAt | string (date-time) | Optional | Time when this record was created. |
updatedAt | string (date-time) | Optional | Time when this record was last updated. |
Values of objectType
Kind of evaluation object to which a reviewer comment is attached.
| Value | No. | Form | Meaning |
|---|---|---|---|
COMMENT_OBJECT_TYPE_TRACE | 1 | Canonical | Attach the comment to a trace. |
COMMENT_OBJECT_TYPE_OBSERVATION | 2 | Canonical | Attach the comment to a particular observation. |
COMMENT_OBJECT_TYPE_SESSION | 3 | Canonical | Attach the comment to a session. |
COMMENT_OBJECT_TYPE_PROMPT | 4 | Canonical | Attach the comment to a specific prompt version using that version's UUID, not the prompt name. A comment on one version does not appear on later versions. |
Where used
| Reference | Relationship |
|---|---|
| List comments | POST /api/v1/evals/list-comments |
Download the public reference contract.
Document: DOC-API-MODEL-comment.