Interface ApiObservation

Observation

interface ApiObservation {
    completionStartTime?: null | string;
    costDetails?: Record<string, number>;
    endTime?: null | string;
    id: string;
    input?: any;
    level: ApiObservationLevel;
    metadata?: any;
    model?: null | string;
    modelParameters?: Record<string, ApiMapValue>;
    name?: null | string;
    output?: any;
    parentObservationId?: null | string;
    promptId?: null | string;
    startTime: string;
    statusMessage?: null | string;
    traceId?: null | string;
    type: string;
    usage?: null | ApiUsage;
    usageDetails?: Record<string, number>;
    version?: null | string;
}

Properties

completionStartTime? costDetails? endTime? id input? level metadata? model? modelParameters? name? output? parentObservationId? promptId? startTime statusMessage? traceId? type usage? usageDetails? version?

Properties

OptionalcompletionStartTime

completionStartTime?: null | string

The completion start time of the observation

Format

date-time

OptionalcostDetails

costDetails?: Record<string, number>

The cost details of the observation. Key is the name of the cost metric, value is the cost in USD. The total key is the sum of all (non-total) cost metrics or the total value ingested.

OptionalendTime

endTime?: null | string

The end time of the observation.

Format

date-time

id

id: string

The unique identifier of the observation

Optionalinput

input?: any

The input data of the observation

level

level: ApiObservationLevel

The level of the observation

Optionalmetadata

metadata?: any

Additional metadata of the observation

Optionalmodel

model?: null | string

The model used for the observation

OptionalmodelParameters

modelParameters?: Record<string, ApiMapValue>

The parameters of the model used for the observation

Optionalname

name?: null | string

The name of the observation

Optionaloutput

output?: any

The output data of the observation

OptionalparentObservationId

parentObservationId?: null | string

The parent observation ID

OptionalpromptId

promptId?: null | string

The prompt ID associated with the observation

startTime

startTime: string

The start time of the observation

Format

date-time

OptionalstatusMessage

statusMessage?: null | string

The status message of the observation

OptionaltraceId

traceId?: null | string

The trace ID associated with the observation

type

type: string

The type of the observation

Optionalusage

usage?: null | ApiUsage

(Deprecated. Use usageDetails and costDetails instead.) The usage data of the observation

OptionalusageDetails

usageDetails?: Record<string, number>

The usage details of the observation. Key is the name of the usage metric, value is the number of units consumed. The total key is the sum of all (non-total) usage metrics or the total value ingested.

Optionalversion

version?: null | string

The version of the observation

Settings

Member Visibility

On This Page

Properties