@valon-technologies/gestalt
    Preparing search index...

    Interface AgentProviderOptions

    Handlers and runtime metadata for an agent provider.

    interface AgentProviderOptions {
        name?: string;
        displayName?: string;
        description?: string;
        version?: string;
        migrations?: MigrationsOption;
        workflows?: readonly WorkflowDefinitionInput[];
        configure?: ConfigureHandler;
        healthCheck?: HealthCheckHandler;
        warnings?: string[] | WarningsHandler;
        start?: StartHandler;
        close?: CloseHandler;
        createSession?: (
            request: CreateAgentProviderSessionRequest,
        ) => MaybePromise<AgentSession>;
        getSession?: (
            request: GetAgentProviderSessionRequest,
        ) => MaybePromise<AgentSession>;
        listSessions?: (
            request: ListAgentProviderSessionsRequest,
        ) => MaybePromise<
            ListAgentProviderSessionsResponse
            | readonly AgentSession[],
        >;
        updateSession?: (
            request: UpdateAgentProviderSessionRequest,
        ) => MaybePromise<AgentSession>;
        createTurn?: (
            request: CreateAgentProviderTurnRequest,
        ) => MaybePromise<AgentTurn>;
        getTurn?: (request: GetAgentProviderTurnRequest) => MaybePromise<AgentTurn>;
        listTurns?: (
            request: ListAgentProviderTurnsRequest,
        ) => MaybePromise<ListAgentProviderTurnsResponse | readonly AgentTurn[]>;
        cancelTurn?: (
            request: CancelAgentProviderTurnRequest,
        ) => MaybePromise<AgentTurn>;
        listTurnEvents?: (
            request: ListAgentProviderTurnEventsRequest,
        ) => MaybePromise<
            ListAgentProviderTurnEventsResponse
            | readonly AgentTurnEvent[],
        >;
        getInteraction?: (
            request: GetAgentProviderInteractionRequest,
        ) => MaybePromise<AgentInteraction>;
        listInteractions?: (
            request: ListAgentProviderInteractionsRequest,
        ) => MaybePromise<
            ListAgentProviderInteractionsResponse
            | readonly AgentInteraction[],
        >;
        resolveInteraction?: (
            request: ResolveAgentProviderInteractionRequest,
        ) => MaybePromise<AgentInteraction>;
        getCapabilities?: (
            request: GetAgentProviderCapabilitiesRequest,
        ) => MaybePromise<AgentProviderCapabilities>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    name? displayName? description? version? migrations? workflows? configure? healthCheck? warnings? start? close? createSession? getSession? listSessions? updateSession? createTurn? getTurn? listTurns? cancelTurn? listTurnEvents? getInteraction? listInteractions? resolveInteraction? getCapabilities?

    Properties

    name?: string
    displayName?: string
    description?: string
    version?: string
    migrations?: MigrationsOption

    Revisions the SDK discovers and runs during provider startup, before the author's own configure handler. The author never calls a runner.

    workflows?: readonly WorkflowDefinitionInput[]

    Workflow definitions declared as static desired state. The host reconciles these on the config-definitions path; declarations cannot depend on config. Only app (integration) providers publish these via GetMetadata.

    configure?: ConfigureHandler
    healthCheck?: HealthCheckHandler
    warnings?: string[] | WarningsHandler
    start?: StartHandler
    close?: CloseHandler
    createSession?: (
        request: CreateAgentProviderSessionRequest,
    ) => MaybePromise<AgentSession>

    Creates a session, minting its id. Must be idempotent on idempotencyKey scoped per context.subject.id; an empty key always creates.

    getSession?: (
        request: GetAgentProviderSessionRequest,
    ) => MaybePromise<AgentSession>
    listSessions?: (
        request: ListAgentProviderSessionsRequest,
    ) => MaybePromise<
        ListAgentProviderSessionsResponse
        | readonly AgentSession[],
    >
    updateSession?: (
        request: UpdateAgentProviderSessionRequest,
    ) => MaybePromise<AgentSession>
    createTurn?: (
        request: CreateAgentProviderTurnRequest,
    ) => MaybePromise<AgentTurn>
    getTurn?: (request: GetAgentProviderTurnRequest) => MaybePromise<AgentTurn>
    listTurns?: (
        request: ListAgentProviderTurnsRequest,
    ) => MaybePromise<ListAgentProviderTurnsResponse | readonly AgentTurn[]>
    cancelTurn?: (
        request: CancelAgentProviderTurnRequest,
    ) => MaybePromise<AgentTurn>
    listTurnEvents?: (
        request: ListAgentProviderTurnEventsRequest,
    ) => MaybePromise<
        ListAgentProviderTurnEventsResponse
        | readonly AgentTurnEvent[],
    >
    getInteraction?: (
        request: GetAgentProviderInteractionRequest,
    ) => MaybePromise<AgentInteraction>
    listInteractions?: (
        request: ListAgentProviderInteractionsRequest,
    ) => MaybePromise<
        ListAgentProviderInteractionsResponse
        | readonly AgentInteraction[],
    >
    resolveInteraction?: (
        request: ResolveAgentProviderInteractionRequest,
    ) => MaybePromise<AgentInteraction>
    getCapabilities?: (
        request: GetAgentProviderCapabilitiesRequest,
    ) => MaybePromise<AgentProviderCapabilities>

    Settings

    Member Visibility

    On This Page

    Properties