Class CallbackContext

The context of various callbacks within an agent run.

Hierarchy (view full)

ReadonlyContext
- CallbackContext
  - ToolContext

Index

Constructors

Properties

_eventActions _invocationContext

Accessors

state eventActions invocationContext userContent invocationId agentName appName userId sessionId

Methods

loadArtifact saveArtifact

Constructors

constructor

new CallbackContext(invocationContext, options?): CallbackContext
Parameters
- invocationContext: InvocationContext
- options: {
  eventActions?: EventActions;
  } = {}
  - OptionaleventActions?: EventActions
Returns CallbackContext
Overrides ReadonlyContext.constructor
- Defined in packages/adk/src/agents/callback-context.ts:18

Properties

`Readonly`_eventActions

_eventActions: EventActions

TODO: make this public for Agent Development Kit, but private for users.

`Protected` `Readonly`_invocationContext

_invocationContext: InvocationContext

Accessors

state

get state(): State
The delta-aware state of the current session. For any state change, you can mutate this object directly, e.g. ctx.state['foo'] = 'bar'

Returns State
Overrides ReadonlyContext.state
- Defined in packages/adk/src/agents/callback-context.ts:38

eventActions

get eventActions(): EventActions
Gets the event actions associated with this context.

Returns EventActions
- Defined in packages/adk/src/agents/callback-context.ts:93

invocationContext

get invocationContext(): InvocationContext
Returns InvocationContext
- Defined in packages/adk/src/agents/callback-context.ts:97

userContent

get userContent(): Content
The user content that started this invocation. READONLY field.

Returns Content
Inherited from ReadonlyContext.userContent
- Defined in packages/adk/src/agents/readonly-context.ts:17

invocationId

get invocationId(): string
The current invocation id.

Returns string
Inherited from ReadonlyContext.invocationId
- Defined in packages/adk/src/agents/readonly-context.ts:24

agentName

get agentName(): string
The name of the agent that is currently running.

Returns string
Inherited from ReadonlyContext.agentName
- Defined in packages/adk/src/agents/readonly-context.ts:31

appName

get appName(): string
The application name for this invocation. READONLY field.

Returns string
Inherited from ReadonlyContext.appName
- Defined in packages/adk/src/agents/readonly-context.ts:38

userId

get userId(): string
The user ID for this invocation. READONLY field.

Returns string
Inherited from ReadonlyContext.userId
- Defined in packages/adk/src/agents/readonly-context.ts:45

sessionId

get sessionId(): string
The session ID for this invocation. READONLY field.

Returns string
Inherited from ReadonlyContext.sessionId
- Defined in packages/adk/src/agents/readonly-context.ts:52

Methods

loadArtifact

loadArtifact(filename, version?): Promise<Part>
Loads an artifact attached to the current session.
Parameters
- filename: string
  The filename of the artifact.
- Optionalversion: number
  The version of the artifact. If undefined, the latest version will be returned.
Returns Promise<Part>
The artifact.
- Defined in packages/adk/src/agents/callback-context.ts:49

saveArtifact

saveArtifact(filename, artifact): Promise<number>
Saves an artifact and records it as delta for the current session.
Parameters
- filename: string
  The filename of the artifact.
- artifact: Part
  The artifact to save.
Returns Promise<number>
The version of the artifact.
- Defined in packages/adk/src/agents/callback-context.ts:73