Skip to content

Metadata

Structure Class

Metadata dataclass

Bases: _SerdeShape

Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.

Attributes

client_request_id class-attribute instance-attribute
client_request_id: str | None = ...

A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.

end_time class-attribute instance-attribute
end_time: datetime | None = ...

In the final response, endTime is the end time of the agent invocation operation.

operation_total_time_ms class-attribute instance-attribute
operation_total_time_ms: int | None = ...

The total time it took for the agent to complete execution. This field is only set for the final response.

start_time class-attribute instance-attribute
start_time: datetime | None = ...

In the final response, startTime is the start time of the agent invocation operation.

total_time_ms class-attribute instance-attribute
total_time_ms: int | None = ...

The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.

usage class-attribute instance-attribute
usage: Usage | None = ...

Specific to model invocation and contains details about the usage of a foundation model.