InvokeAgentScope Class

Provides OpenTelemetry tracing scope for AI agent invocation operations.

Initialize the agent invocation scope.

Constructor

InvokeAgentScope(request: Request, scope_details: InvokeAgentScopeDetails, agent_details: AgentDetails, caller_details: CallerDetails | None = None, span_details: SpanDetails | None = None)

Parameters

Name	Description
request Required	Request details for the invocation
scope_details Required	Scope-level configuration (endpoint)
agent_details Required	The details of the agent being invoked
caller_details	Optional composite caller details (human user and/or calling agent for A2A scenarios) Default value: None
span_details	Optional span configuration (parent context, timing, kind) Default value: None

Methods

record_input_messages	Record the input messages for telemetry tracking. Accepts plain strings (auto-wrapped as OTEL ChatMessage with role user) or a structured InputMessages container.
record_output_messages	Record the output messages for telemetry tracking. Accepts plain strings (auto-wrapped as OTEL OutputMessage with role assistant) or a structured OutputMessages container.
record_response	Record response information for telemetry tracking.
start	Create and start a new scope for agent invocation tracing.

record_input_messages

Record the input messages for telemetry tracking.

Accepts plain strings (auto-wrapped as OTEL ChatMessage with role user) or a structured InputMessages container.

record_input_messages(messages: str | list[str] | InputMessages) -> None

Parameters

Name	Description
messages Required	List of input message strings or an InputMessages container

record_output_messages

Record the output messages for telemetry tracking.

Accepts plain strings (auto-wrapped as OTEL OutputMessage with role assistant) or a structured OutputMessages container.

record_output_messages(messages: str | list[str] | OutputMessages) -> None

Parameters

Name	Description
messages Required	List of output message strings or an OutputMessages container

record_response

Record response information for telemetry tracking.

record_response(response: str) -> None

Parameters

Name	Description
response Required	The response string to record

start

Create and start a new scope for agent invocation tracing.

static start(request: Request, scope_details: InvokeAgentScopeDetails, agent_details: AgentDetails, caller_details: CallerDetails | None = None, span_details: SpanDetails | None = None) -> InvokeAgentScope

Parameters

Name	Description
request Required	Request details for the invocation
scope_details Required	Scope-level configuration (endpoint)
agent_details Required	The details of the agent being invoked
caller_details	Optional composite caller details (human user and/or calling agent for A2A scenarios) Default value: None
span_details	Optional span configuration (parent context, timing, kind) Default value: None

Returns

Type	Description
	A new InvokeAgentScope instance