Section ID:
Values of
DOC-API-MODEL-schema-ove4pre5lb#overview
Comment
Authored text attached to a trace, observation, or other evaluation object.
Meaning and usage
Section ID: DOC-API-MODEL-schema-ove4pre5lb#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-ove4pre5lb#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-ove4pre5lb#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-ove4pre5lb#field-commentidSection ID: DOC-API-MODEL-schema-ove4pre5lb#response-field-commentidcommentId | string | Optional | Identifier of the evaluation comment. |
Section ID: DOC-API-MODEL-schema-ove4pre5lb#field-objecttypeSection ID: DOC-API-MODEL-schema-ove4pre5lb#response-field-objecttypeobjectType | string (COMMENT_OBJECT_TYPE_TRACE, COMMENT_OBJECT_TYPE_OBSERVATION, COMMENT_OBJECT_TYPE_SESSION, COMMENT_OBJECT_TYPE_PROMPT) or integer (int32) | Optional; explicit presence | Kind of evaluation object addressed by the comment. |
Section ID: DOC-API-MODEL-schema-ove4pre5lb#field-objectidSection ID: DOC-API-MODEL-schema-ove4pre5lb#response-field-objectidobjectId | string | Optional | Identifier of the evaluation object addressed by the comment. |
Section ID: DOC-API-MODEL-schema-ove4pre5lb#field-contentSection ID: DOC-API-MODEL-schema-ove4pre5lb#response-field-contentcontent | string | Optional | Text content of the evaluation comment. |
authorUserId | string | Optional | Identifier recorded for the user who authored the comment. A stored author identifier alone does not attest to verified human provenance. |
Section ID: DOC-API-MODEL-schema-ove4pre5lb#field-createdatSection ID: DOC-API-MODEL-schema-ove4pre5lb#response-field-createdatcreatedAt | string (date-time) | Optional | Time when this record was created. |
Section ID: DOC-API-MODEL-schema-ove4pre5lb#field-updatedatSection ID: DOC-API-MODEL-schema-ove4pre5lb#response-field-updatedatupdatedAt | string (date-time) | Optional | Time when this record was last updated. |
Values of objectType
Section ID: DOC-API-MODEL-schema-ove4pre5lb#response-values-objecttype
Kind of evaluation object to which a reviewer comment is attached.
| Value | No. | Form | Meaning |
|---|---|---|---|
COMMENT_OBJECT_TYPE_TRACE | 0 | Canonical | Attach the comment to a trace. |
COMMENT_OBJECT_TYPE_OBSERVATION | 1 | Canonical | Attach the comment to a particular observation. |
COMMENT_OBJECT_TYPE_SESSION | 2 | Canonical | Attach the comment to a session. |
COMMENT_OBJECT_TYPE_PROMPT | 3 | 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
Section ID: DOC-API-MODEL-schema-ove4pre5lb#where-used
| Reference | Relationship |
|---|---|
| List comments | POST /api/v1/evals/list-comments |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-ove4pre5lb