ADK for TypeScript: API Reference
    Preparing search index...

    ADK for TypeScript: API Reference - v2.2.0

    Enumerations

    AuthCredentialTypes
    CodeExecutionLanguage
    ContextCompactionTrigger
    EventType
    FeatureName
    FeatureStage
    FileContentEncoding
    GoogleLLMVariant
    LogLevel
    NodeStatus
    OAuthGrantType
    PolicyOutcome
    ProtocolType
    RunSkillInlineScriptErrorCode
    StreamingMode
    ToolErrorType
    TrackingScope

    Classes

    A2AAgentExecutor
    ActiveStreamingTool
    AdkDefaultRequestHandler
    Agent
    AgentControlledContextCompactor
    AgentEngineSandboxCodeExecutor
    AgentRegistry
    AgentRegistrySingleMCPToolset
    AgentTool
    AgentTransferLlmRequestProcessor
    AlreadyExistsError
    AnchoredContextCompactor
    ApigeeLlm
    App
    AsyncQueue
    AuthCredentialMissingError
    AuthHandler
    AuthPreprocessor
    AuthProviderRegistry
    AutoAuthCredentialExchanger
    BaseAgent
    BaseAuthCredentialExchanger
    BaseCodeExecutor
    BaseEnvironment
    BaseExampleProvider
    BaseLlm
    BaseLlmRequestProcessor
    BaseLlmResponseProcessor
    BaseNode
    BasePlanner
    BasePlugin
    BaseRetrievalTool
    BaseSessionService
    BaseTool
    BaseToolset
    BranchPath
    BuiltInCodeExecutor
    BuiltInPlanner
    BuiltInTool
    ChromeBuiltInLlm
    ChromeModelUnavailableError
    ConsolidateContextTool
    ContainerCodeExecutor
    ContentRequestProcessor
    Context
    ContextCompactorRequestProcessor
    CredentialExchangeError
    CredentialRefresherRegistry
    DatabaseSessionService
    Edge
    EnterpriseWebSearchTool
    ExampleTool
    ExitLoopTool
    FileArtifactService
    FilesRetrieval
    FinishTaskTool
    ForwardingArtifactService
    FunctionNode
    FunctionTool
    GCPSkillRegistry
    GcsArtifactService
    Gemini
    GlobalInstructionPlugin
    GoogleMapsGroundingTool
    GoogleSearchTool
    Graph
    InMemoryArtifactService
    InMemoryCredentialService
    InMemoryMemoryService
    InMemoryPolicyEngine
    InMemoryRunner
    InMemorySessionService
    InputValidationError
    IntentMismatchError
    InteractionsRequestProcessor
    InvocationContext
    JoinNode
    ListSkillsTool
    LiveRequestQueue
    LlamaIndexRetrieval
    LLMRegistry
    LlmSummarizer
    LoadArtifactsTool
    LoadMcpResourceTool
    LoadMemoryTool
    LoadSkillResourceTool
    LoadSkillTool
    LocalEnvironment
    LoggingPlugin
    LongRunningFunctionTool
    LoopAgent
    MCPSessionManager
    MCPTool
    MCPToolset
    NodeContext
    NodeReportedError
    NodeSchemaValidationError
    NodeTimeoutError
    NodeTool
    NotFoundError
    OAuth2BearerExchanger
    OAuth2CredentialExchanger
    OAuth2DiscoveryManager
    OpenApiSpecParser
    OpenAPIToolset
    OperationParser
    ParallelAgent
    ParallelWorker
    PlanReActPlanner
    PluginManager
    PreloadMemoryTool
    ReadonlyContext
    ReflectAndRetryModelPlugin
    ReflectAndRetryToolPlugin
    RemoteA2AAgent
    RequestInput
    RestApiTool
    RoutedAgent
    RoutedLlm
    Runner
    RunSkillInlineScriptTool
    RunSkillScriptTool
    ScopedArtifactService
    ScopedFailureTracker
    SearchSkillsTool
    SecurityPlugin
    SequentialAgent
    ServiceAccountCredentialExchanger
    SessionNotFoundError
    SessionStateCredentialService
    SkillToolset
    State
    StateSchemaError
    Task
    TokenBasedContextCompactor
    ToolAuthHandler
    ToolConfirmation
    ToolContextCredentialStore
    ToolExecutionError
    ToolNode
    TrajectoryThoughtPruningCompactor
    TruncatingContextCompactor
    UnsafeLocalCodeExecutor
    UrlContextTool
    VertexAiExampleStore
    VertexAiMemoryBankService
    VertexAiRagMemoryService
    VertexAiSearchTool
    VertexAiSessionService
    VertexRagRetrievalTool
    WebMCPTool
    WebMCPToolset
    Workflow
    WorkflowNode

    Interfaces

    ActiveStreamingToolParams
    ActivityEvent
    AgentEngineSandboxCodeExecutorOptions
    AgentExecutorConfig
    AgentInfo
    AgentSkillMetadata
    AgentToolConfig
    AnchoredContextCompactorOptions
    ApigeeLlmParams
    ApiParameter
    ApiParameterInit
    AppendEventRequest
    AppOptions
    ArtifactVersion
    AuthConfig
    AuthCredential
    AuthPreparationResult
    BaseAgentConfig
    BaseArtifactService
    BaseAuthProvider
    BaseContextCompactor
    BaseCredentialExchanger
    BaseCredentialRefresher
    BaseCredentialService
    BaseLlmConnection
    BaseMemoryService
    BaseNodeConfig
    BasePolicyEngine
    BaseSummarizer
    BaseToolParams
    Binding
    BuildNodeOptions
    CallCodeEvent
    ChromeBuiltInDiagnostic
    ChromeBuiltInLlmParams
    ChromeCreateCoreOptions
    ChromeCreateMonitor
    ChromeCreateOptions
    ChromeExpectedModality
    ChromeLanguageModelFactory
    ChromeLanguageModelSession
    ChromeMessage
    ChromeMessageContent
    ChromePromptOptions
    CodeExecutionInput
    CodeExecutionResult
    CodeResultEvent
    CompactedEvent
    CompositeSessionKey
    ConnectionUriFilter
    ConnectionUriResult
    ContainerCodeExecutorOptions
    ContentEvent
    CreateEventParams
    CreateNodeErrorEventParams
    CreateSessionRequest
    DataStoreParams
    DeleteArtifactRequest
    Endpoint
    ErrorEvent
    Event
    EventActions
    Example
    ExampleStoreApiClient
    ExchangeResult
    ExecuteCodeParams
    ExecutionResult
    ExecutorContext
    FeatureConfig
    File
    FilesRetrievalConstructorParams
    FilesRetrievalParams
    FinishedEvent
    Frontmatter
    FunctionNodeConfig
    GcpAuthProviderScheme
    GCPSkillRegistryOptions
    GeminiParams
    GetSessionConfig
    GetSessionRequest
    HttpAuth
    HttpCredentials
    Interface
    InvocationContextParams
    ListAgentsResponse
    ListBindingsResponse
    ListEndpointsResponse
    ListMcpServersResponse
    ListSessionsRequest
    ListSessionsResponse
    ListVersionsRequest
    LiveRequest
    LlamaIndexNode
    LlamaIndexNodeWithScore
    LlamaIndexRetrievalParams
    LlamaIndexRetriever
    LlmAgentConfig
    LlmRequest
    LlmResponse
    LlmSummarizerOptions
    LoadArtifactRequest
    LoadWebPageOptions
    LocalEnvironmentOptions
    Logger
    LoopAgentConfig
    McpServer
    MemoryEntry
    NodeContextOptions
    NodeErrorEvent
    NodeInfo
    NodeResult
    NodeState
    OAuth2Auth
    OpenIdConnectWithConfig
    OperationEndpoint
    OtelExportersConfig
    OTelHooks
    ParallelWorkerConfig
    ParsedOperation
    ParsedOperationInput
    PolicyCheckResult
    PreparedRetryConfig
    ReflectAndRetryModelPluginOptions
    ReflectAndRetryToolPluginOptions
    RemoteA2AAgentConfig
    RequestInputParams
    Resources
    ResumabilityConfig
    RetryConfig
    RoutedAgentConfig
    RunAsyncToolRequest
    RunConfig
    RunnerConfig
    RunNodeOptions
    SaveArtifactRequest
    ScheduleDynamicNode
    ScheduleDynamicNodeOptions
    Script
    SearchEngineParams
    SearchExamplesRequest
    SearchExamplesResponse
    SearchExamplesResult
    SearchMemoryRequest
    SearchMemoryResponse
    ServiceAccount
    ServiceAccountCredential
    Session
    SessionArtifactService
    SessionLoadArtifactRequest
    SessionSaveArtifactRequest
    Skill
    SkillRegistry
    StdioConnectionParams
    StoredContentsExample
    StreamableHTTPConnectionParams
    ThoughtEvent
    ToA2aOptions
    TokenBasedContextCompactorOptions
    ToolAuthHandlerOptions
    ToolCallEvent
    ToolCallPolicyContext
    ToolConfirmationEvent
    ToolFailureResponse
    ToolNodeConfig
    ToolProcessLlmRequest
    ToolResultEvent
    TrajectoryThoughtPruningCompactorOptions
    TranscriptionEntry
    TruncatingContextCompactorOptions
    UnsafeLocalCodeExecutorOptions
    UserInputRequest
    VertexAiCreateSessionRequest
    VertexAiMemoryBankServiceOptions
    VertexAiRagMemoryServiceOptions
    VertexAISearchConfig
    VertexAISearchDataStoreSpec
    VertexAiSessionServiceOptions
    WebMCPDocument
    WebMCPExecuteToolOptions
    WebMCPGetToolsOptions
    WebMCPModelContext
    WebMCPRegisteredTool
    WebMCPToolAnnotations
    WebMCPToolParams
    WebMCPToolsetOptions
    WorkflowInstructionScope

    Type Aliases

    A2AStreamEventData
    A2aUserBuilder
    AfterA2ARequestCallback
    AfterAgentCallback
    AfterEventCallback
    AfterExecuteCallback
    AfterModelCallback
    AfterToolCallback
    AgentRouter
    AuthScheme
    BaseLlmType
    BeforeA2ARequestCallback
    BeforeAgentCallback
    BeforeExecuteCallback
    BeforeModelCallback
    BeforeToolCallback
    ChainElement
    ChromeModelAvailability
    CustomCredentialExchangers
    DeleteSessionRequest
    DynamicEntry
    EdgeItem
    ErrorClass
    FunctionNodeHandler
    FunctionNodeResult
    InstructionProvider
    IntentMismatchReason
    ListArtifactKeysRequest
    LlmAgentSchema
    LlmRouter
    MCPConnectionParams
    NodeLike
    NodeOptions
    PerItemFailuresCounter
    RequireConfirmation
    ResumeInputs
    Route
    RouteKey
    RouteValue
    RoutingMap
    RunnableNode
    RunnableRoot
    RunnerOrRunnerConfig
    SchemaLike
    SingleAfterModelCallback
    SingleAfterToolCallback
    SingleAgentCallback
    SingleBeforeModelCallback
    SingleBeforeToolCallback
    StructuredEvent
    TaskExecutable
    ToolExecuteArgument
    ToolExecuteFunction
    ToolInputParameters
    ToolOptions
    ToolPredicate
    ToolUnion
    UserInputKind
    VertexAiSearchToolParams
    WorkflowConfig

    Variables

    ADK_HANDLE_MODEL_ERROR_TOOL_NAME
    AGENT_REGISTRY_BASE_URL
    AUTH_PREPROCESSOR
    CONTENT_REQUEST_PROCESSOR
    DEFAULT_ROUTE
    EXIT_LOOP
    FINISH_TASK_SUCCESS_RESULT
    FINISH_TASK_TOOL_NAME
    functionsExportedForTestingOnly
    GCP_MCP_SERVER_DESTINATION_ID
    getUserChoiceTool
    GLOBAL_SCOPE_KEY
    GOOGLE_MAPS_GROUNDING
    IN_MODEL_TOOL_SYMBOL
    INTERACTIONS_REQUEST_PROCESSOR
    INTERNAL_AUTH_PREFIX
    LOAD_ARTIFACTS
    LOAD_MEMORY
    LOAD_WEB_PAGE
    logger
    PRELOAD_MEMORY
    REFLECT_AND_RETRY_RESPONSE_TYPE
    REQUEST_CONFIRMATION_FUNCTION_CALL_NAME
    REQUEST_CREDENTIAL_FUNCTION_CALL_NAME
    REQUEST_INPUT_FUNCTION_CALL_NAME
    requestInputTool
    RESERVED_TOOL_CALL_ERROR_TYPE
    START
    URL_CONTEXT
    version

    Functions

    asRunnableRoot
    bearerTokenUserBuilder
    cleanName
    commonPrefixOf
    createApiParameter
    createEvent
    createEventActions
    createNodeErrorEvent
    createNodeState
    createRestApiTool
    createRestApiToolFromJson
    createResumabilityConfig
    createSession
    createSubBranch
    credentialToParam
    determineAgentForResumption
    dictToAuthScheme
    exchangeCredential
    findEventByFunctionCallId
    findEventByLastFunctionResponseId
    findMatchingFunctionCall
    geminiInitParams
    generateClientFunctionCallId
    generateParamDoc
    generateReturnDoc
    getA2AAgentCard
    getA2aRequestMetadata
    getArtifactServiceFromUri
    getAskUserConfirmationFunctionCalls
    getClientLabels
    getFeatureConfig
    getFunctionCalls
    getFunctionResponses
    getGcpExporters
    getGcpResource
    getLogger
    getModelContext
    getPendingUserInputRequests
    getSessionServiceFromUri
    getTypeHint
    getUserInputRequests
    hasThoughts
    hasTrailingCodeExecutionResult
    isAgentTool
    isApp
    isAuthCredential
    isBaseAgent
    isBaseExampleProvider
    isBaseLlm
    isBasePlanner
    isBaseTool
    isBaseToolset
    isBuiltInPlanner
    isCompactedEvent
    isFeatureEnabled
    isFinalResponse
    isFunctionTool
    isGemini2OrAbove
    isGemini35LiveTranslate
    isGemini3xFlashLive
    isGemini3xLive
    isGoogleApi
    isInModelTool
    isIntentMismatchError
    isLlmAgent
    isLoopAgent
    isNodeErrorEvent
    isNodeReportedError
    isNodeSchemaValidationError
    isNodeState
    isNodeTimeoutError
    isParallelAgent
    isRequestInput
    isRoutableLlmAgent
    isRoutedAgent
    isRunnableRoot
    isRunner
    isScratchpadEvent
    isSequentialAgent
    isSessionArtifactService
    isStateSchemaError
    isToolNotFound
    isWebMCPSupported
    isWorkflow
    loadAllSkillsInDir
    loadSkillFromDir
    loadSkillFromZipBuffer
    loadWebPage
    maybeSetOtelProviders
    mergeStates
    node
    normalizeRetryExceptions
    openidDictToSchemeCredential
    openidUrlToSchemeCredential
    overrideFeatureEnabled
    populateClientFunctionCallId
    prepareRetryConfig
    pruneThoughts
    registerFeature
    renameReservedKeywords
    requireAgent
    requiresUserInput
    resetLogger
    resolveScopeKey
    runWithClientLabel
    serviceAccountDictToSchemeCredential
    serviceAccountSchemeCredential
    setLogger
    setLogLevel
    stringifyContent
    stripAdkIdentityPreamble
    toA2a
    tokenToSchemeCredential
    toSnakeCaseName
    toStructuredEvents
    trimTempDeltaState
    trimTempState
    validateAppName
    validateSkillDir
    withTemporaryFeatureOverride
    zodObjectToSchema

    References

    CallbackContext → Context
    LlmAgent → Agent
    ToolContext → Context