Skip to main content
Section ID: DOC-API-MODEL-schema-1ju9tclufp#overview

Observation

Timed evaluation span or generation record with model usage, inputs, outputs, and scores. A generation observation originates the profile and configuration attribution promoted to its trace; callers can read those links directly on either record.

Meaning and usage​

Section ID: DOC-API-MODEL-schema-1ju9tclufp#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-1ju9tclufp#fields

UsageFields and validation
In responsesView fields

In responses​

Section ID: DOC-API-MODEL-schema-1ju9tclufp#response

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-observationidSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-observationidobservationIdstringOptionalIdentifier of the evaluation observation.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-traceidSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-traceidtraceIdstringOptionalIdentifier of the evaluation trace.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-parentobservationidSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-parentobservationidparentObservationIdstringOptionalIdentifier of the parent observation within the trace.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-typeSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-typetypestring (OBSERVATION_TYPE_SPAN, OBSERVATION_TYPE_GENERATION, OBSERVATION_TYPE_EVENT, OBSERVATION_TYPE_TOOL, OBSERVATION_TYPE_RETRIEVER, OBSERVATION_TYPE_AGENT, OBSERVATION_TYPE_CHAIN, OBSERVATION_TYPE_EMBEDDING, OBSERVATION_TYPE_EVALUATOR, OBSERVATION_TYPE_GUARDRAIL) or integer (int32)Optional; explicit presenceObservation kind reported by the evaluation provider.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-nameSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-namenamestringOptionalOperation name recorded for the evaluation observation.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-levelSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-levellevelstring (OBSERVATION_LEVEL_DEBUG, OBSERVATION_LEVEL_DEFAULT, OBSERVATION_LEVEL_WARNING, OBSERVATION_LEVEL_ERROR) or integer (int32)Optional; explicit presenceObservation log level reported by the evaluation provider.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-statusmessageSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-statusmessagestatusMessagestringOptionalDiagnostic text explaining the reported state.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-starttimeSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-starttimestartTimestring (date-time)OptionalBeginning of the time interval represented by this operation.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-endtimeSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-endtimeendTimestring (date-time)OptionalEnd of the time interval represented by this operation.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-completionstarttimeSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-completionstarttimecompletionStartTimestring (date-time)OptionalTime to first token, generations only.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-latencysecondsSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-latencysecondslatencySecondsnumber (double) or string (NaN, Infinity, -Infinity)OptionalElapsed observation latency, in seconds.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-inputjsonSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-inputjsoninputJsonstringOptionalEvaluation input serialized as JSON.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-outputjsonSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-outputjsonoutputJsonstringOptionalEvaluation output serialized as JSON.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-metadatajsonSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-metadatajsonmetadataJsonstringOptionalAdditional attributes serialized as a JSON object.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-modelSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-modelmodelstringOptionalModel identifier recorded for the evaluated generation.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-modelparametersjsonSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-modelparametersjsonmodelParametersJsonstringOptionalModel parameters recorded as a serialized JSON object.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-inputtokensSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-inputtokensinputTokensstring (int64)OptionalInput-token usage reported for the evaluated generation. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-outputtokensSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-outputtokensoutputTokensstring (int64)OptionalOutput-token usage reported for the evaluated generation. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-totaltokensSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-totaltokenstotalTokensstring (int64)OptionalTotal token usage reported for the evaluated generation or aggregate. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-inputcostSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-inputcostinputCostnumber (double) or string (NaN, Infinity, -Infinity)OptionalCost attributed to model input by the evaluation provider.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-outputcostSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-outputcostoutputCostnumber (double) or string (NaN, Infinity, -Infinity)OptionalCost attributed to model output by the evaluation provider.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-totalcostSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-totalcosttotalCostnumber (double) or string (NaN, Infinity, -Infinity)OptionalTotal cost reported for the evaluated generation or aggregate.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-environmentSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-environmentenvironmentstringOptionalEnvironment label attached to the evaluation record.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-versionSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-versionversionstringOptionalVersion of the resource represented by this message.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-promptnameSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-promptnamepromptNamestringOptionalName of the versioned prompt associated with the generation.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-promptversionSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-promptversionpromptVersionstring (int64)OptionalVersion of the prompt associated with the generation. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-scoresSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-scoresscoresArray of ScoreOptionalEvaluation scores returned for the selected objects or query.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-commentcountSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-commentcountcommentCountstring (int64)OptionalNumber of comments reported on the evaluation object. Pattern: ^-?\d+$.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-conversationidSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-conversationidconversationIdstringOptionalIdentifier of the conversation associated with this evaluation observation, when recorded.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-sourceusermessageidSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-sourceusermessageidsourceUserMessageIdstringOptionalIdentifier of the user message that opened the evaluated generation turn.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-profileidSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-profileidprofileIdstringOptionalIdentifier of the agent profile associated with the generation.
Section ID: DOC-API-MODEL-schema-1ju9tclufp#field-confighashSection ID: DOC-API-MODEL-schema-1ju9tclufp#response-field-confighashconfigHashstringOptionalFingerprint 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.

Values of type​

Section ID: DOC-API-MODEL-schema-1ju9tclufp#response-values-type

Semantic category of a trace observation, including categories accepted from upstream even when the platform does not emit them. Current emitters produce GENERATION, TOOL, RETRIEVER and SPAN; the other declared categories can still describe upstream observations.

ValueNo.FormMeaning
OBSERVATION_TYPE_SPAN0CanonicalA timed unit of work represented as a span.
OBSERVATION_TYPE_GENERATION1CanonicalA model-generation operation and its recorded inputs, outputs and usage.
OBSERVATION_TYPE_EVENT2CanonicalA point-in-time event rather than a timed operation.
OBSERVATION_TYPE_TOOL3CanonicalExecution of a tool call.
OBSERVATION_TYPE_RETRIEVER4CanonicalRetrieval of supporting documents or other context.
OBSERVATION_TYPE_AGENT5CanonicalAn agent-level operation reported in the trace.
OBSERVATION_TYPE_CHAIN6CanonicalA sequence or chain of related processing steps.
OBSERVATION_TYPE_EMBEDDING7CanonicalComputation of vector embeddings.
OBSERVATION_TYPE_EVALUATOR8CanonicalAn evaluator operation that assesses another result.
OBSERVATION_TYPE_GUARDRAIL9CanonicalA guardrail check on inputs, outputs or processing.

Values of level​

Section ID: DOC-API-MODEL-schema-1ju9tclufp#response-values-level

Diagnostic severity attached to an evaluation observation.

ValueNo.FormMeaning
OBSERVATION_LEVEL_DEBUG0CanonicalDetailed diagnostic information intended for debugging.
OBSERVATION_LEVEL_DEFAULT1CanonicalOrdinary observation information without an elevated warning or error level.
OBSERVATION_LEVEL_WARNING2CanonicalA condition reported at warning severity.
OBSERVATION_LEVEL_ERROR3CanonicalA condition reported at error severity.

Where used​

Section ID: DOC-API-MODEL-schema-1ju9tclufp#where-used

ReferenceRelationship
Get a tracePOST /api/v1/evals/get-trace
List observationsPOST /api/v1/evals/list-observations
Models containing this value
ModelRelationship
TraceDetailNested in model

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-1ju9tclufp