@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;
        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?: string
    displayName?: string
    description?: string
    version?: string
    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 subject (createdBySubjectId); 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>
    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>