Section ID:
DOC-API-MODEL-schema-1k4mjul65u#overview
TraceSummary
Evaluation summary for a conversation turn, including its recorded conversation, message and profile attribution.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1k4mjul65u#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1k4mjul65u#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1k4mjul65u#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-traceidSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-traceidtraceId | string | Optional | Identifier of the evaluation trace. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-nameSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-namename | string | Optional | Name recorded for the evaluation trace. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-timestampSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-timestamptimestamp | string (date-time) | Optional | Timestamp associated with the evaluation trace. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-inputjsonSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-inputjsoninputJson | string | Optional | Evaluation input serialized as JSON. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-outputjsonSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-outputjsonoutputJson | string | Optional | Evaluation output serialized as JSON. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-latencysecondsSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-latencysecondslatencySeconds | number (double) or string (NaN, Infinity, -Infinity) | Optional | Elapsed observation latency, in seconds. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-totalcostSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-totalcosttotalCost | number (double) or string (NaN, Infinity, -Infinity) | Optional | Total cost reported for the evaluated generation or aggregate. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-environmentSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-environmentenvironment | string | Optional | Environment label attached to the evaluation record. |
tags | Array of string | Optional | Labels associated with the resource for organization or filtering. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-metadatajsonSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-metadatajsonmetadataJson | string | Optional | Additional attributes serialized as a JSON object. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-bookmarkedSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-bookmarkedbookmarked | boolean | Optional | Whether the evaluation object is bookmarked. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-versionSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-versionversion | string | Optional | Version of the resource represented by this message. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-releaseSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-releaserelease | string | Optional | Application release identifier attached to the trace. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-useridSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-useriduserId | string | Optional | Identifier of the user associated with the operation. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-sessionidSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-sessionidsessionId | string | Optional | Identifier of the evaluation session grouping related traces. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-observationcountSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-observationcountobservationCount | string (int64) | Optional | Number of observations reported for the evaluation object. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-conversationidSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-conversationidconversationId | string | Optional | Identifier of the conversation associated with the trace. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-sourceusermessageidSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-sourceusermessageidsourceUserMessageId | string | Optional | Identifier of the user message that opened the evaluated generation turn. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-profileidSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-profileidprofileId | string | Optional | Identifier of the agent profile associated with the generation. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-confighashSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-confighashconfigHash | string | Optional | Fingerprint of the profile ID, model and resolved prompt hash used to group evaluation results. Other settings are excluded; this is not an immutable profile revision. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-inputtokensSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-inputtokensinputTokens | string (int64) | Optional | Input-token usage reported for the evaluated generation. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-outputtokensSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-outputtokensoutputTokens | string (int64) | Optional | Output-token usage reported for the evaluated generation. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-totaltokensSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-totaltokenstotalTokens | string (int64) | Optional | Total token usage reported for the evaluated generation or aggregate. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-errorcountSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-errorcounterrorCount | string (int64) | Optional | Number of observations reported at error level. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-warningcountSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-warningcountwarningCount | string (int64) | Optional | Number of observations reported at warning level. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-defaultcountSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-defaultcountdefaultCount | string (int64) | Optional | Number of observations reported at the default level. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-debugcountSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-debugcountdebugCount | string (int64) | Optional | Number of observations reported at debug level. Pattern: ^-?\d+$. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-scoresSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-scoresscores | Array of Score | Optional | Evaluation scores returned for the selected objects or query. |
Section ID: DOC-API-MODEL-schema-1k4mjul65u#field-commentcountSection ID: DOC-API-MODEL-schema-1k4mjul65u#response-field-commentcountcommentCount | string (int64) | Optional | Number of comments reported on the evaluation object. Pattern: ^-?\d+$. |
Where used
Section ID: DOC-API-MODEL-schema-1k4mjul65u#where-used
| Reference | Relationship |
|---|---|
| Get a session | POST /api/v1/evals/get-session |
| Get a trace | POST /api/v1/evals/get-trace |
| List traces | POST /api/v1/evals/list-traces |
Models containing this value
| Model | Relationship |
|---|---|
| SessionDetail | Nested in model |
| TraceDetail | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1k4mjul65u