Class AgentProvider

Runtime provider implementation for the Gestalt agent provider contract.

Hierarchy (View Summary)

ProviderBase
- AgentProvider

Constructors

constructor

new AgentProvider(options: AgentProviderOptions): AgentProvider
Parameters
- options: AgentProviderOptions
Returns AgentProvider
Overrides ProviderBase.constructor

Properties

name

name: string

`Readonly`displayName

displayName: string

`Readonly`description

description: string

`Readonly`version

version: string

`Readonly`kind

kind: "agent" = ...

Methods

resolveName

resolveName(fallback: string): void
Parameters
- fallback: string
Returns void
Inherited from ProviderBase.resolveName

providerMetadata

providerMetadata(): ProviderMetadata
Returns ProviderMetadata
Inherited from ProviderBase.providerMetadata

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>
Inherited from ProviderBase.configureProvider

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean
Inherited from ProviderBase.supportsHealthCheck

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.healthCheck

startProvider

startProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.startProvider

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>
Inherited from ProviderBase.warnings

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>
Inherited from ProviderBase.closeProvider

createSession

createSession(request: CreateAgentProviderSessionRequest): Promise<AgentSession>
Parameters
- request: CreateAgentProviderSessionRequest
Returns Promise<AgentSession>

getSession

getSession(request: GetAgentProviderSessionRequest): Promise<AgentSession>
Parameters
- request: GetAgentProviderSessionRequest
Returns Promise<AgentSession>

listSessions

listSessions(
request: ListAgentProviderSessionsRequest,
): Promise<ListAgentProviderSessionsResponse | readonly AgentSession[]>
Parameters
- request: ListAgentProviderSessionsRequest
Returns Promise<ListAgentProviderSessionsResponse | readonly AgentSession[]>

updateSession

updateSession(request: UpdateAgentProviderSessionRequest): Promise<AgentSession>
Parameters
- request: UpdateAgentProviderSessionRequest
Returns Promise<AgentSession>

createTurn

createTurn(request: CreateAgentProviderTurnRequest): Promise<AgentTurn>
Parameters
- request: CreateAgentProviderTurnRequest
Returns Promise<AgentTurn>

getTurn

getTurn(request: GetAgentProviderTurnRequest): Promise<AgentTurn>
Parameters
- request: GetAgentProviderTurnRequest
Returns Promise<AgentTurn>

listTurns

listTurns(
request: ListAgentProviderTurnsRequest,
): Promise<ListAgentProviderTurnsResponse | readonly AgentTurn[]>
Parameters
- request: ListAgentProviderTurnsRequest
Returns Promise<ListAgentProviderTurnsResponse | readonly AgentTurn[]>

cancelTurn

cancelTurn(request: CancelAgentProviderTurnRequest): Promise<AgentTurn>
Parameters
- request: CancelAgentProviderTurnRequest
Returns Promise<AgentTurn>

listTurnEvents

listTurnEvents(
request: ListAgentProviderTurnEventsRequest,
): Promise<ListAgentProviderTurnEventsResponse | readonly AgentTurnEvent[]>
Parameters
- request: ListAgentProviderTurnEventsRequest
Returns Promise<ListAgentProviderTurnEventsResponse | readonly AgentTurnEvent[]>

getInteraction

getInteraction(
request: GetAgentProviderInteractionRequest,
): Promise<AgentInteraction>
Parameters
- request: GetAgentProviderInteractionRequest
Returns Promise<AgentInteraction>

listInteractions

listInteractions(
    request: ListAgentProviderInteractionsRequest,
): Promise<
    ListAgentProviderInteractionsResponse
    | readonly AgentInteraction[],
>
Parameters
- request: ListAgentProviderInteractionsRequest
Returns Promise<ListAgentProviderInteractionsResponse | readonly AgentInteraction[]>

resolveInteraction

resolveInteraction(
request: ResolveAgentProviderInteractionRequest,
): Promise<AgentInteraction>
Parameters
- request: ResolveAgentProviderInteractionRequest
Returns Promise<AgentInteraction>

getCapabilities

getCapabilities(
request?: GetAgentProviderCapabilitiesRequest,
): Promise<AgentProviderCapabilities>
Parameters
- request: GetAgentProviderCapabilitiesRequest = {}
Returns Promise<AgentProviderCapabilities>