Class InvocationContext

An invocation context represents the data of a single invocation of an agent.

An invocation:

  1. Starts with a user message and ends with a final response.
  2. Can contain one or multiple agent calls.
  3. Is handled by runner.run_async().

An invocation runs an agent until it does not request to transfer to another agent.

An agent call:

  1. Is handled by agent.run().
  2. Ends when agent.run() ends.

An LLM agent call is an agent with a BaseLLMFlow. An LLM agent call can contain one or multiple steps.

An LLM agent runs steps in a loop until:

  1. A final response is generated.
  2. The agent transfers to another agent.
  3. The end_invocation is set to true by any callbacks or tools.

A step:

  1. Calls the LLM only once and yields its response.
  2. Calls the tools and yields their responses if requested.

The summarization of the function response is considered another step, since it is another llm call.

A step ends when it's done calling llm and tools, or if the end_invocation is set to true at any time.

┌─────────────────────── invocation ──────────────────────────┐
┌──────────── llm_agent_call_1 ────────────┐ ┌─ agent_call_2 ─┐
┌──── step_1 ────────┐ ┌───── step_2 ──────┐
[call_llm] [call_tool] [call_llm] [transfer]

Constructors

constructor

Properties

artifactService? sessionService memoryService? pluginManager invocationId branch? agent userContent? session endInvocation liveRequestQueue? activeStreamingTools? transcriptionCache? runConfig? transferContext?

Accessors

appName userId

Methods

incrementLlmCallCount createChildContext

Constructors

constructor

Properties

Optional ReadonlyartifactService

artifactService?: BaseArtifactService

ReadonlysessionService

sessionService: BaseSessionService

Optional ReadonlymemoryService

memoryService?: BaseMemoryService

ReadonlypluginManager

pluginManager: PluginManager

The plugin manager for this invocation context.

ReadonlyinvocationId

invocationId: string

The id of this invocation context. Readonly.

Optional Readonlybranch

branch?: string

The branch of the invocation context.

The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3.

Branch is used when multiple sub-agents shouldn't see their peer agents' conversation history.

agent

agent: BaseAgent

The current agent of this invocation context. Readonly.

Optional ReadonlyuserContent

userContent?: Content

The user content that started this invocation. Readonly.

Readonlysession

session: Session

The current session of this invocation context. Readonly.

endInvocation

endInvocation: boolean = false

Whether to end this invocation.

Set to True in callbacks or tools to terminate this invocation.

OptionalliveRequestQueue

liveRequestQueue?: LiveRequestQueue

The queue to receive live requests.

OptionalactiveStreamingTools

activeStreamingTools?: Record<string, ActiveStreamingTool>

The running streaming tools of this invocation.

OptionaltranscriptionCache

transcriptionCache?: TranscriptionEntry[]

Caches necessary, data audio or contents, that are needed by transcription.

OptionalrunConfig

runConfig?: RunConfig

Configurations for live agents under this invocation.

OptionaltransferContext

transferContext?: TransferContext

Transfer context for multi-agent workflows Tracks agent transfer chain for telemetry

Accessors

appName

userId

Methods

incrementLlmCallCount

createChildContext

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods