Class AgentProvider

Base class shared by all TypeScript SDK provider implementations.

Hierarchy (View Summary)

RuntimeProvider
- AgentProvider

Constructors

constructor

new AgentProvider(options: AgentProviderOptions): AgentProvider
Parameters
- options: AgentProviderOptions
Returns AgentProvider
Overrides RuntimeProvider.constructor
- Defined in ../../src/agent.ts:200

Properties

`Readonly`kind

kind: "agent" = ...

name

name: string

`Readonly`displayName

displayName: string

`Readonly`description

description: string

`Readonly`version

version: string

Methods

createSession

createSession(
request: CreateAgentProviderSessionRequest,
): Promise<MessageInit<AgentSession>>
Parameters
- request: CreateAgentProviderSessionRequest
Returns Promise<MessageInit<AgentSession>>
- Defined in ../../src/agent.ts:217

getSession

getSession(
request: GetAgentProviderSessionRequest,
): Promise<MessageInit<AgentSession>>
Parameters
- request: GetAgentProviderSessionRequest
Returns Promise<MessageInit<AgentSession>>
- Defined in ../../src/agent.ts:227

listSessions

listSessions(
request: ListAgentProviderSessionsRequest,
): Promise<MessageInit<AgentSession>[]>
Parameters
- request: ListAgentProviderSessionsRequest
Returns Promise<MessageInit<AgentSession>[]>
- Defined in ../../src/agent.ts:237

updateSession

updateSession(
request: UpdateAgentProviderSessionRequest,
): Promise<MessageInit<AgentSession>>
Parameters
- request: UpdateAgentProviderSessionRequest
Returns Promise<MessageInit<AgentSession>>
- Defined in ../../src/agent.ts:247

createTurn

createTurn(
request: CreateAgentProviderTurnRequest,
): Promise<MessageInit<AgentTurn>>
Parameters
- request: CreateAgentProviderTurnRequest
Returns Promise<MessageInit<AgentTurn>>
- Defined in ../../src/agent.ts:257

getTurn

getTurn(request: GetAgentProviderTurnRequest): Promise<MessageInit<AgentTurn>>
Parameters
- request: GetAgentProviderTurnRequest
Returns Promise<MessageInit<AgentTurn>>
- Defined in ../../src/agent.ts:267

listTurns

listTurns(
request: ListAgentProviderTurnsRequest,
): Promise<MessageInit<AgentTurn>[]>
Parameters
- request: ListAgentProviderTurnsRequest
Returns Promise<MessageInit<AgentTurn>[]>
- Defined in ../../src/agent.ts:277

cancelTurn

cancelTurn(
request: CancelAgentProviderTurnRequest,
): Promise<MessageInit<AgentTurn>>
Parameters
- request: CancelAgentProviderTurnRequest
Returns Promise<MessageInit<AgentTurn>>
- Defined in ../../src/agent.ts:287

listTurnEvents

listTurnEvents(
request: ListAgentProviderTurnEventsRequest,
): Promise<AgentTurnEventInit[]>
Parameters
- request: ListAgentProviderTurnEventsRequest
Returns Promise<AgentTurnEventInit[]>
- Defined in ../../src/agent.ts:297

getInteraction

getInteraction(
request: GetAgentProviderInteractionRequest,
): Promise<MessageInit<AgentInteraction>>
Parameters
- request: GetAgentProviderInteractionRequest
Returns Promise<MessageInit<AgentInteraction>>
- Defined in ../../src/agent.ts:307

listInteractions

listInteractions(
request: ListAgentProviderInteractionsRequest,
): Promise<MessageInit<AgentInteraction>[]>
Parameters
- request: ListAgentProviderInteractionsRequest
Returns Promise<MessageInit<AgentInteraction>[]>
- Defined in ../../src/agent.ts:317

resolveInteraction

resolveInteraction(
request: ResolveAgentProviderInteractionRequest,
): Promise<MessageInit<AgentInteraction>>
Parameters
- request: ResolveAgentProviderInteractionRequest
Returns Promise<MessageInit<AgentInteraction>>
- Defined in ../../src/agent.ts:327

getCapabilities

getCapabilities(
request?: Message,
): Promise<MessageInit<AgentProviderCapabilities>>
Parameters
- request: Message = ...
Returns Promise<MessageInit<AgentProviderCapabilities>>
- Defined in ../../src/agent.ts:337

resolveName

resolveName(fallback: string): void
Parameters
- fallback: string
Returns void
Inherited from RuntimeProvider.resolveName
- Defined in ../../src/provider.ts:102

runtimeMetadata

runtimeMetadata(): ProviderMetadata
Returns ProviderMetadata
Inherited from RuntimeProvider.runtimeMetadata
- Defined in ../../src/provider.ts:108

configureProvider

configureProvider(name: string, config: Record<string, unknown>): Promise<void>
Parameters
- name: string
- config: Record<string, unknown>
Returns Promise<void>
Inherited from RuntimeProvider.configureProvider
- Defined in ../../src/provider.ts:127

supportsHealthCheck

supportsHealthCheck(): boolean
Returns boolean
Inherited from RuntimeProvider.supportsHealthCheck
- Defined in ../../src/provider.ts:131

healthCheck

healthCheck(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.healthCheck
- Defined in ../../src/provider.ts:135

startProvider

startProvider(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.startProvider
- Defined in ../../src/provider.ts:139

warnings

warnings(): Promise<string[]>
Returns Promise<string[]>
Inherited from RuntimeProvider.warnings
- Defined in ../../src/provider.ts:143

closeProvider

closeProvider(): Promise<void>
Returns Promise<void>
Inherited from RuntimeProvider.closeProvider
- Defined in ../../src/provider.ts:153