Class Context

constructor

• new Context(
      options: {
          eventActions?: EventActions;
          functionCallId?: string;
          invocationContext: InvocationContext;
          toolConfirmation?: ToolConfirmation;
      },
  ): Context

  Parameters

  • options: {
        eventActions?: EventActions;
        functionCallId?: string;
        invocationContext: InvocationContext;
        toolConfirmation?: ToolConfirmation;
    }

    The configuration options for the Context.

    • OptionaleventActions?: EventActions

      The event actions of the current call.

    • OptionalfunctionCallId?: string

      The function call id of the current tool call. This id was returned in the function call event from LLM to identify a function call. If LLM didn't return this id, ADK will assign one to it. This id is used to map function call response to the original function call.

    • invocationContext: InvocationContext

      The invocation context.

    • OptionaltoolConfirmation?: ToolConfirmation

      The tool confirmation of the current tool call.

  Returns Context

ReadonlyeventActions

Optional ReadonlyfunctionCallId

OptionaltoolConfirmation

actions

• get actions(): EventActions

  Returns EventActions

state

• get state(): State

  The delta-aware state of the current session.

  Returns State

getAuthResponse

• getAuthResponse(authConfig: AuthConfig): AuthCredential | undefined

  Gets the auth credential for the given auth config.

  Parameters

  • authConfig: AuthConfig

    The auth config to get the auth credential for.

  Returns AuthCredential | undefined

  The auth credential for the given auth config.

listArtifacts

• listArtifacts(): Promise<string[]>

  Lists the filenames of the artifacts attached to the current session.

  Returns Promise<string[]>

  A promise that resolves to a list of artifact filenames.

loadArtifact

• loadArtifact(filename: string, version?: number): Promise<Part | undefined>

  Loads an artifact attached to the current session.

  Parameters

  • filename: string

    The filename of the artifact.

  • Optionalversion: number

    The version of the artifact. If not provided, the latest version will be used.

  Returns Promise<Part | undefined>

  A promise that resolves to the loaded artifact.

requestConfirmation

• requestConfirmation(
      __namedParameters: { hint?: string; payload?: unknown },
  ): void

  Requests confirmation for the current tool call.

  Parameters

  • __namedParameters: { hint?: string; payload?: unknown }

  Returns void

requestCredential

• requestCredential(authConfig: AuthConfig): void

  Parameters

  • authConfig: AuthConfig

  Returns void

saveArtifact

• saveArtifact(filename: string, artifact: Part): Promise<number>

  Saves an artifact attached to the current session.

  Parameters

  • filename: string

    The filename of the artifact.

  • artifact: Part

    The artifact to save.

  Returns Promise<number>

  A promise that resolves to the version of the saved artifact.

searchMemory

• searchMemory(query: string): Promise<SearchMemoryResponse>

  Searches the memory of the current user.

  Parameters

  • query: string

    The query to search memory for.

  Returns Promise<SearchMemoryResponse>

  A promise that resolves to SearchMemoryResponse containing the matching memories.