Skip to content
AgentsKit

@agentskit/adapters β€” Interfaces

API interfaces for @agentskit/adapters.

#Interface: AnthropicConfig

Defined in: packages/adapters/src/anthropic.ts:9

Configuration options for the Anthropic chat adapter.

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/anthropic.ts:10


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/anthropic.ts:12


#maxTokens?

optional maxTokens?: number

Defined in: packages/adapters/src/anthropic.ts:13


#model

model: string

Defined in: packages/adapters/src/anthropic.ts:11


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/anthropic.ts:14


#Interface: ApplyCarbonOptions

Defined in: packages/adapters/src/carbon.ts:73

Configuration options for the carbon estimation utilities.

#Properties

#fallback?

optional fallback?: number

Defined in: packages/adapters/src/carbon.ts:83

Fallback gCO2eq per 1k tokens when no table entry is found.


#keyFor?

optional keyFor?: (candidate) => `$\{string\}:$\{string\}` | undefined

Defined in: packages/adapters/src/carbon.ts:81

How to derive the lookup key for a candidate. Defaults to $\{provider\}:$\{region\} where provider is the candidate id before the first - and region is candidate.region.

#Parameters

candidate

RouterCandidate

#Returns

`$\{string\}:$\{string\}` | undefined


#table?

optional table?: CarbonTable

Defined in: packages/adapters/src/carbon.ts:75

Override the default table.


#Interface: AzureOpenAIConfig

Defined in: packages/adapters/src/azure-openai.ts:8

Configuration options for the Azure OpenAI chat adapter.

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/azure-openai.ts:9


#apiVersion?

optional apiVersion?: string

Defined in: packages/adapters/src/azure-openai.ts:15

Azure REST api-version. Defaults to 2024-10-21.


#deployment

deployment: string

Defined in: packages/adapters/src/azure-openai.ts:13

Deployment name (NOT the underlying model name β€” Azure routes by deployment).


#endpoint

endpoint: string

Defined in: packages/adapters/src/azure-openai.ts:11

Resource endpoint, e.g. https://my-resource.openai.azure.com.


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/azure-openai.ts:18

Surface usage by setting stream_options.include_usage. Defaults to true.


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/azure-openai.ts:16


#Interface: BailConfig

Defined in: packages/adapters/src/bail.ts:7

Configuration options for the bail adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: BedrockConfig

Defined in: packages/adapters/src/bedrock.ts:9

Configuration options for the Amazon Bedrock chat adapter.

#Properties

#client?

optional client?: BedrockRuntimeClientLike

Defined in: packages/adapters/src/bedrock.ts:21

Override the SDK client. Mostly for tests; production code should let the adapter create the client from region + the SDK's default credential chain.


#maxTokens?

optional maxTokens?: number

Defined in: packages/adapters/src/bedrock.ts:15

Override max_tokens (Anthropic on Bedrock requires it). Defaults to 4096.


#model

model: string

Defined in: packages/adapters/src/bedrock.ts:11

Bedrock model id, e.g. anthropic.claude-3-5-sonnet-20241022-v2:0.


#region?

optional region?: string

Defined in: packages/adapters/src/bedrock.ts:13

AWS region (e.g. us-east-1). Falls back to the SDK's default credential chain.


#Interface: BedrockRuntimeClientLike

Defined in: packages/adapters/src/bedrock.ts:31

Minimal structural type for BedrockRuntimeClient so we don't take a hard dep on @aws-sdk/client-bedrock-runtime.

Second options argument is optional so existing one-argument injected clients remain structurally valid.

#Methods

#send()

send(command, options?): Promise<{ body?: AsyncIterable<{ chunk?: { bytes?: Uint8Array<ArrayBufferLike>; }; }, any, any>; }>

Defined in: packages/adapters/src/bedrock.ts:32

#Parameters

command
input

BedrockInvokeInput

options?
abortSignal?

AbortSignal

#Returns

Promise<{ body?: AsyncIterable<{ chunk?: { bytes?: Uint8Array<ArrayBufferLike>; }; }, any, any>; }>


#Interface: CerebrasConfig

Defined in: packages/adapters/src/cerebras.ts:7

Configuration options for the Cerebras chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: CloudflareAiGatewayConfig

Defined in: packages/adapters/src/cloudflare.ts:5

Cloudflare account and optional AI Gateway authentication.

#Extends

#Properties

#accountId

accountId: string

Defined in: packages/adapters/src/cloudflare.ts:6


#apiKey?

optional apiKey?: string

Defined in: packages/adapters/src/openai-compatible.ts:9

#Inherited from

OpenAICompatibleTransportConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAIConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAIConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAIConfig.fetch


#gatewayId

gatewayId: string

Defined in: packages/adapters/src/cloudflare.ts:7


#gatewayToken?

optional gatewayToken?: string

Defined in: packages/adapters/src/cloudflare.ts:8


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAIConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAIConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAIConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAIConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAIConfig.retry


#Interface: CohereConfig

Defined in: packages/adapters/src/cohere.ts:7

Configuration options for the adapter support.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: CreateAdapterConfig

Defined in: packages/adapters/src/types.ts:8

Optional second AbortSignal keeps one-argument callbacks assignable (extra parameters are optional). createAdapter races send against abort and will not start work after pre-abort.

#Properties

#abort?

optional abort?: () => void

Defined in: packages/adapters/src/types.ts:17

#Returns

void


#parse

parse: (stream, response?) => AsyncIterableIterator<StreamChunk>

Defined in: packages/adapters/src/types.ts:13

#Parameters

stream

ReadableStream

response?

Response

#Returns

AsyncIterableIterator<StreamChunk>


#send

send: (request, signal?) => Promise<ReadableStream<any> | Response>

Defined in: packages/adapters/src/types.ts:9

#Parameters

request

AdapterRequest

signal?

AbortSignal

#Returns

Promise<ReadableStream<any> | Response>


#Interface: CredentialRefreshable

Defined in: packages/adapters/src/credential-rotation.ts:45

Credential provider that can refresh expiring credentials.

#Properties

#refreshCredentials

refreshCredentials: (next) => Promise<void>

Defined in: packages/adapters/src/credential-rotation.ts:52

Opt-in adapters that support credential rotation expose this method. Stock AgentsKit adapters do not implement it unless documented otherwise. Calling it replaces the in-memory secret. The next request uses the new value; in-flight requests are unaffected.

#Parameters

next

string

#Returns

Promise<void>


#Interface: DeepSeekConfig

Defined in: packages/adapters/src/deepseek.ts:6

Configuration options for the DeepSeek chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: DeepSeekEmbedderConfig

Defined in: packages/adapters/src/embedders/deepseek.ts:6

Configuration options for the DeepSeek embedder.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:12

#Inherited from

OpenAICompatibleEmbedderConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:14

#Inherited from

OpenAICompatibleEmbedderConfig.baseUrl


#model

model: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:13

#Inherited from

OpenAICompatibleEmbedderConfig.model


#Interface: DeprecationPolicy

Defined in: packages/adapters/src/deprecation.ts:38

Policy for handling deprecated model identifiers.

#Properties

#logger?

optional logger?: (msg) => void

Defined in: packages/adapters/src/deprecation.ts:42

Sink for warnings. Defaults to console.warn.

#Parameters

msg

string

#Returns

void


#onDeprecation

onDeprecation: DeprecationAction

Defined in: packages/adapters/src/deprecation.ts:39


#table?

optional table?: ModelDeprecation[]

Defined in: packages/adapters/src/deprecation.ts:40


#Interface: EnsembleBranchResult

Defined in: packages/adapters/src/ensemble.ts:18

A result returned by ensemble adapter.

#Properties

#chunks

chunks: StreamChunk[]

Defined in: packages/adapters/src/ensemble.ts:21


#error?

optional error?: Error

Defined in: packages/adapters/src/ensemble.ts:22


#id

id: string

Defined in: packages/adapters/src/ensemble.ts:19


#text

text: string

Defined in: packages/adapters/src/ensemble.ts:20


#Interface: EnsembleCandidate

Defined in: packages/adapters/src/ensemble.ts:8

A candidate used by ensemble adapter.

#Properties

#adapter

adapter: AdapterFactory

Defined in: packages/adapters/src/ensemble.ts:10


#id

id: string

Defined in: packages/adapters/src/ensemble.ts:9


#weight?

optional weight?: number

Defined in: packages/adapters/src/ensemble.ts:12

Weight used by 'weighted-vote' aggregator. Default 1.


#Interface: EnsembleOptions

Defined in: packages/adapters/src/ensemble.ts:37

Configuration options for the ensemble adapter.

#Properties

#aggregate?

optional aggregate?: EnsembleAggregator

Defined in: packages/adapters/src/ensemble.ts:40

How to combine branches into the single output text. Default 'majority-vote'.


#candidates

candidates: EnsembleCandidate[]

Defined in: packages/adapters/src/ensemble.ts:38


#onBranches?

optional onBranches?: (branches) => void

Defined in: packages/adapters/src/ensemble.ts:44

Observability hook β€” fires once with every branch's result.

#Parameters

branches

EnsembleBranchResult[]

#Returns

void


#timeoutMs?

optional timeoutMs?: number

Defined in: packages/adapters/src/ensemble.ts:42

Per-candidate timeout in ms. Branches that time out are marked with an error.


#Interface: FallbackCandidate

Defined in: packages/adapters/src/fallback.ts:21

A candidate used by fallback adapter.

#Properties

#adapter

adapter: AdapterFactory

Defined in: packages/adapters/src/fallback.ts:23


#id

id: string

Defined in: packages/adapters/src/fallback.ts:22


#Interface: FallbackOptions

Defined in: packages/adapters/src/fallback.ts:8

Configuration options for the fallback adapter.

#Properties

#onFallback?

optional onFallback?: (from) => void

Defined in: packages/adapters/src/fallback.ts:15

Observability hook β€” fires when one adapter fails and the chain advances.

#Parameters

from
error

Error

id

string

index

number

#Returns

void


#shouldRetry?

optional shouldRetry?: (error, index) => boolean

Defined in: packages/adapters/src/fallback.ts:13

Predicate deciding whether an error from a given adapter should trigger fall-through to the next. Default: always retry the next.

#Parameters

error

Error

index

number

#Returns

boolean


#Interface: FireworksConfig

Defined in: packages/adapters/src/fireworks.ts:6

Configuration options for the Fireworks chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: GeminiConfig

Defined in: packages/adapters/src/gemini.ts:9

Configuration options for the Gemini chat adapter.

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/gemini.ts:10


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/gemini.ts:12


#model

model: string

Defined in: packages/adapters/src/gemini.ts:11


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/gemini.ts:13


#Interface: GeminiEmbedderConfig

Defined in: packages/adapters/src/embedders/gemini.ts:10

Configuration options for the Gemini embedder.

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/embedders/gemini.ts:11


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/embedders/gemini.ts:13


#model?

optional model?: string

Defined in: packages/adapters/src/embedders/gemini.ts:12


#Interface: GenericAdapterConfig

Defined in: packages/adapters/src/types.ts:23

Configuration options for the adapter configuration.

#Properties

#send

send: (request, signal?) => Promise<ReadableStream<any>>

Defined in: packages/adapters/src/types.ts:24

#Parameters

request

AdapterRequest

signal?

AbortSignal

#Returns

Promise<ReadableStream<any>>


#Interface: GrokConfig

Defined in: packages/adapters/src/grok.ts:6

Configuration options for the xAI Grok chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: GrokEmbedderConfig

Defined in: packages/adapters/src/embedders/grok.ts:6

Configuration options for the xAI Grok embedder.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:12

#Inherited from

OpenAICompatibleEmbedderConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:14

#Inherited from

OpenAICompatibleEmbedderConfig.baseUrl


#model

model: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:13

#Inherited from

OpenAICompatibleEmbedderConfig.model


#Interface: GroqConfig

Defined in: packages/adapters/src/groq.ts:7

Configuration options for the Groq chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: HuggingFaceConfig

Defined in: packages/adapters/src/huggingface.ts:6

Configuration options for the Hugging Face chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: KimiConfig

Defined in: packages/adapters/src/kimi.ts:6

Configuration options for the Moonshot Kimi chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: KimiEmbedderConfig

Defined in: packages/adapters/src/embedders/kimi.ts:6

Configuration options for the Moonshot Kimi embedder.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:12

#Inherited from

OpenAICompatibleEmbedderConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:14

#Inherited from

OpenAICompatibleEmbedderConfig.baseUrl


#model

model: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:13

#Inherited from

OpenAICompatibleEmbedderConfig.model


#Interface: LangChainConfig

Defined in: packages/adapters/src/langchain.ts:12

Configuration options for the LangChain and LangGraph adapters.

#Properties

#mode?

optional mode?: "stream" | "events"

Defined in: packages/adapters/src/langchain.ts:14


#runnable

runnable: LangChainRunnable

Defined in: packages/adapters/src/langchain.ts:13


#Interface: LangGraphConfig

Defined in: packages/adapters/src/langchain.ts:110

Configuration options for the LangChain and LangGraph adapters.

#Properties

#graph

graph: LangChainRunnable

Defined in: packages/adapters/src/langchain.ts:111


#Interface: LlamaCppConfig

Defined in: packages/adapters/src/llamacpp.ts:6

Configuration options for the llama.cpp chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: LMStudioConfig

Defined in: packages/adapters/src/lmstudio.ts:6

Configuration options for the LM Studio chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: MistralConfig

Defined in: packages/adapters/src/mistral.ts:6

Configuration options for the Mistral chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: MockAdapterOptions

Defined in: packages/adapters/src/mock.ts:18

Configuration options for the mock and recording adapters.

#Properties

#delayMs?

optional delayMs?: number

Defined in: packages/adapters/src/mock.ts:25

ms between yielded chunks. Default 0 (synchronous).


#history?

optional history?: AdapterRequest[]

Defined in: packages/adapters/src/mock.ts:27

Track every request the adapter received. Useful for assertions.


#response

response: MockResponse | MockResponse[]

Defined in: packages/adapters/src/mock.ts:23

Static chunks, a request-aware function, or a sequence of responses (the i-th call returns the i-th item, looping when exhausted).


#Interface: ModelDeprecation

Defined in: packages/adapters/src/deprecation.ts:24

Deprecation metadata for a model identifier.

#Properties

#model

model: string

Defined in: packages/adapters/src/deprecation.ts:26


#note?

optional note?: string

Defined in: packages/adapters/src/deprecation.ts:32

Optional human-readable reason / link.


#provider

provider: string

Defined in: packages/adapters/src/deprecation.ts:25


#successor?

optional successor?: string

Defined in: packages/adapters/src/deprecation.ts:30

Suggested successor β€” used when onDeprecation: 'remap'.


#sunsetOn?

optional sunsetOn?: string

Defined in: packages/adapters/src/deprecation.ts:28

ISO date the provider's sunset takes effect.


#Interface: ModelProviderConfig

Defined in: packages/adapters/src/provider.ts:18

Provider-agnostic configuration. Switching provider is a config change only: the returned value is always the same AdapterFactory shape.

#Properties

#apiKey?

optional apiKey?: string

Defined in: packages/adapters/src/provider.ts:22

Optional for cliproxyapi (local proxy); required for the others.


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/provider.ts:23


#maxTokens?

optional maxTokens?: number

Defined in: packages/adapters/src/provider.ts:26

Anthropic only.


#model

model: string

Defined in: packages/adapters/src/provider.ts:20


#provider

provider: ModelProviderId

Defined in: packages/adapters/src/provider.ts:19


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/provider.ts:24


#Interface: OllamaConfig

Defined in: packages/adapters/src/ollama.ts:9

Configuration options for the Ollama chat adapter.

#Properties

#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/ollama.ts:11


#model

model: string

Defined in: packages/adapters/src/ollama.ts:10


#multiModal?

optional multiModal?: boolean

Defined in: packages/adapters/src/ollama.ts:12


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/ollama.ts:13


#Interface: OllamaEmbedderConfig

Defined in: packages/adapters/src/embedders/ollama.ts:10

Configuration options for the Ollama embedder.

#Properties

#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/embedders/ollama.ts:12


#model?

optional model?: string

Defined in: packages/adapters/src/embedders/ollama.ts:11


#Interface: OpenAICompatibleConfig

Defined in: packages/adapters/src/openai-compatible.ts:5

Configuration for provider presets that require Bearer authentication.

#Extends

#Extended by

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAIConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAIConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAIConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAIConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAIConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAIConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAIConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAIConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAIConfig.retry


#Interface: OpenAICompatibleEmbedderConfig

Defined in: packages/adapters/src/embedders/openai-compatible.ts:11

Configuration options for the OpenAI-compatible embedder.

#Extended by

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:12


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:14


#model

model: string

Defined in: packages/adapters/src/embedders/openai-compatible.ts:13


#Interface: OpenAICompatibleTransportConfig

Defined in: packages/adapters/src/openai-compatible.ts:8

Transport configuration for endpoints with optional Bearer authentication.

#Extends

#Extended by

#Properties

#apiKey?

optional apiKey?: string

Defined in: packages/adapters/src/openai-compatible.ts:9


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAIConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAIConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAIConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAIConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAIConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAIConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAIConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAIConfig.retry


#Interface: OpenAIConfig

Defined in: packages/adapters/src/openai.ts:8

Configuration options for the OpenAI chat adapter.

#Extended by

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.


#model

model: string

Defined in: packages/adapters/src/openai.ts:10


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15


#Interface: OpenAIEmbedderConfig

Defined in: packages/adapters/src/embedders/openai.ts:10

Configuration options for the OpenAI embedder.

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/embedders/openai.ts:11


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/embedders/openai.ts:13


#model?

optional model?: string

Defined in: packages/adapters/src/embedders/openai.ts:12


#Interface: OpenRouterConfig

Defined in: packages/adapters/src/openrouter.ts:7

Configuration options for the OpenRouter chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAIConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAIConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAIConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAIConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAIConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAIConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAIConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAIConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAIConfig.retry


#Interface: RecordedTurn

Defined in: packages/adapters/src/mock.ts:161

One recorded request and response turn.

#Properties

#chunks

chunks: StreamChunk[]

Defined in: packages/adapters/src/mock.ts:167

Every chunk yielded by the wrapped adapter.


#recordedAt

recordedAt: string

Defined in: packages/adapters/src/mock.ts:163

ISO timestamp when this turn was recorded.


#request

request: AdapterRequest

Defined in: packages/adapters/src/mock.ts:165

The request that produced this turn.


#Interface: RecordingSink

Defined in: packages/adapters/src/mock.ts:178

Sink that stores recorded adapter turns.

#Methods

#push()

push(turn): void | Promise<void>

Defined in: packages/adapters/src/mock.ts:179

#Parameters

turn

RecordedTurn

#Returns

void | Promise<void>


#Interface: ReplicateConfig

Defined in: packages/adapters/src/replicate.ts:8

Configuration options for the Replicate chat adapter.

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/replicate.ts:9


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/replicate.ts:15

Override the prediction endpoint base.


#model

model: string

Defined in: packages/adapters/src/replicate.ts:11

Replicate model id, e.g. meta/meta-llama-3-70b-instruct.


#toInput?

optional toInput?: (request) => Record<string, unknown>

Defined in: packages/adapters/src/replicate.ts:17

Map AdapterRequest β†’ Replicate input object. Defaults to \{ prompt \}.

#Parameters

request

AdapterRequest

#Returns

Record<string, unknown>


#version?

optional version?: string

Defined in: packages/adapters/src/replicate.ts:13

Optional pinned version hash (for non-official models).


#Interface: ResolveModelInput

Defined in: packages/adapters/src/deprecation.ts:70

Input used to resolve a model against a deprecation table.

#Properties

#model

model: string

Defined in: packages/adapters/src/deprecation.ts:72


#provider

provider: string

Defined in: packages/adapters/src/deprecation.ts:71


#Interface: ResolveModelResult

Defined in: packages/adapters/src/deprecation.ts:78

A result returned by model deprecation handling.

#Properties

#deprecation?

optional deprecation?: ModelDeprecation

Defined in: packages/adapters/src/deprecation.ts:82


#model

model: string

Defined in: packages/adapters/src/deprecation.ts:80

Final model id to use (may differ from input if remapped).


#remapped

remapped: boolean

Defined in: packages/adapters/src/deprecation.ts:81


#Interface: RetryOptions

Defined in: packages/adapters/src/retry.ts:12

Retry policy for adapter fetches only: 3 total attempts, 500 ms base, 8000 ms cap, full jitter, statuses 408/429/500/502/503/504, and non-abort transport errors. Positive fractional attempts floor; invalid values reject with AK_CONFIG_INVALID without making a request.

#Example

`const retry: RetryOptions = { maxAttempts: 4, retryOn: ({ response }) => response?.status === 429 }`

#Properties

#baseDelayMs?

optional baseDelayMs?: number

Defined in: packages/adapters/src/retry.ts:16

First retry delay before jitter. Default 500 ms.


#jitter?

optional jitter?: boolean

Defined in: packages/adapters/src/retry.ts:20

Enable full jitter. Default true.


#maxAttempts?

optional maxAttempts?: number

Defined in: packages/adapters/src/retry.ts:14

Total fetch attempts, including the first. Default 3.


#maxDelayMs?

optional maxDelayMs?: number

Defined in: packages/adapters/src/retry.ts:18

Maximum backoff and Retry-After delay. Default 8000 ms.


#onRetry?

optional onRetry?: (info) => void

Defined in: packages/adapters/src/retry.ts:24

Called immediately before a retry wait; thrown errors fail the retry operation.

#Parameters

info
attempt

number

delayMs

number

reason

string

#Returns

void


#retryOn?

optional retryOn?: (info) => boolean

Defined in: packages/adapters/src/retry.ts:22

Select failed responses or errors to retry.

#Parameters

info
attempt

number

error?

unknown

response?

Response

#Returns

boolean


#sleep?

optional sleep?: (ms) => Promise<void>

Defined in: packages/adapters/src/retry.ts:26

One-argument wait override. Default uses @agentskit/net's abortable sleep.

#Parameters

ms

number

#Returns

Promise<void>


#Interface: RotatingCredentials

Defined in: packages/adapters/src/credential-rotation.ts:24

Credential provider that returns the current credential.

#Properties

#current

current: CredentialResolver

Defined in: packages/adapters/src/credential-rotation.ts:26

Resolve the current secret. Opt-in adapters call this on every request.


#onRotate

onRotate: (handler) => () => void

Defined in: packages/adapters/src/credential-rotation.ts:30

Subscribe to rotation events. Returns an unsubscribe handle.

#Parameters

handler

(event) => void

#Returns

() => void


#rotate

rotate: (next) => Promise<string>

Defined in: packages/adapters/src/credential-rotation.ts:28

Replace the in-memory secret. Returns the new value.

#Parameters

next

string

#Returns

Promise<string>


#Interface: RouterCandidate

Defined in: packages/adapters/src/router.ts:15

A candidate used by model routing.

#Properties

#adapter

adapter: AdapterFactory

Defined in: packages/adapters/src/router.ts:17


#capabilities?

optional capabilities?: AdapterCapabilities

Defined in: packages/adapters/src/router.ts:32

Capability override. Defaults to adapter.capabilities. Used to reject candidates missing required features (e.g. tools, multiModal).


#cost?

optional cost?: number

Defined in: packages/adapters/src/router.ts:24

Relative cost hint (lower wins for policy='cheapest'). Only relative values matter β€” use $/1M tokens or any consistent unit.


#gCO2PerKtok?

optional gCO2PerKtok?: number

Defined in: packages/adapters/src/router.ts:41

Estimated grid CO2 intensity (gCO2eq per 1k tokens) for this adapter+region. Lower wins for policy='greenest'. Use applyCarbonTable() to populate from DEFAULT_CARBON_TABLE or a custom table.


#id

id: string

Defined in: packages/adapters/src/router.ts:16


#latencyMs?

optional latencyMs?: number

Defined in: packages/adapters/src/router.ts:26

Typical latency in ms. Lower wins for policy='fastest'.


#region?

optional region?: DataRegion

Defined in: packages/adapters/src/router.ts:19

Data residency region for this adapter endpoint.


#tags?

optional tags?: string[]

Defined in: packages/adapters/src/router.ts:34

Free-form tags used by classifier routing (e.g. 'fast', 'coding').


#Interface: RouterOptions

Defined in: packages/adapters/src/router.ts:58

Configuration options for the model routing.

#Properties

#candidates

candidates: RouterCandidate[]

Defined in: packages/adapters/src/router.ts:59


#classify?

optional classify?: (request) => string | string[] | undefined

Defined in: packages/adapters/src/router.ts:70

Fast path: inspect the request, return a candidate id or tag(s). Return undefined to fall back to policy.

#Parameters

request

AdapterRequest

#Returns

string | string[] | undefined


#onRoute?

optional onRoute?: (decision) => void

Defined in: packages/adapters/src/router.ts:72

Observability hook β€” fires once per decision.

#Parameters

decision
id

string

reason

string

request

AdapterRequest

#Returns

void


#policy?

optional policy?: RouterPolicy

Defined in: packages/adapters/src/router.ts:65

Policy when classify doesn't pick a candidate. Default 'cheapest'.


#region?

optional region?: DataRegion

Defined in: packages/adapters/src/router.ts:61

Require all selected adapters to match this data-residency region.


#regionOf?

optional regionOf?: (request) => DataRegion | undefined

Defined in: packages/adapters/src/router.ts:63

Dynamic region selector. Takes precedence over region.

#Parameters

request

AdapterRequest

#Returns

DataRegion | undefined


#Interface: TogetherConfig

Defined in: packages/adapters/src/together.ts:6

Configuration options for the Together AI chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: VercelAIConfig

Defined in: packages/adapters/src/vercel-ai.ts:10

Configuration options for the Vercel AI SDK adapter.

#Properties

#api

api: string

Defined in: packages/adapters/src/vercel-ai.ts:11


#headers?

optional headers?: Record<string, string>

Defined in: packages/adapters/src/vercel-ai.ts:12


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/vercel-ai.ts:13


#Interface: VertexConfig

Defined in: packages/adapters/src/vertex.ts:9

Configuration options for the Vertex AI chat adapter.

#Properties

#accessToken

accessToken: string | (() => string | Promise<string>)

Defined in: packages/adapters/src/vertex.ts:22

OAuth2 access token, or a function returning one (called per request).

Use the google-auth-library (or gcloud auth print-access-token) to mint these β€” the adapter intentionally doesn't take that as a hard dep.


#model

model: string

Defined in: packages/adapters/src/vertex.ts:15

Vertex model id, e.g. gemini-2.5-pro.


#project

project: string

Defined in: packages/adapters/src/vertex.ts:11

GCP project id.


#publisher?

optional publisher?: string

Defined in: packages/adapters/src/vertex.ts:24

Override the publisher (defaults to google; set for partner publishers).


#region

region: string

Defined in: packages/adapters/src/vertex.ts:13

Region, e.g. us-central1.


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/vertex.ts:25


#Interface: VLLMConfig

Defined in: packages/adapters/src/vllm.ts:6

Configuration options for the vLLM chat adapter.

#Extends

#Properties

#apiKey

apiKey: string

Defined in: packages/adapters/src/openai.ts:9

#Inherited from

OpenAICompatibleConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAICompatibleConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAICompatibleConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAICompatibleConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAICompatibleConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAICompatibleConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAICompatibleConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAICompatibleConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAICompatibleConfig.retry


#Interface: WebLlmConfig

Defined in: packages/adapters/src/webllm.ts:15

Browser-only adapter backed by WebLLM (https://github.com/mlc-ai/web-llm). Models run on-device via WebGPU; no network for inference. The MLCEngine is loaded lazily on first stream so apps can ship the import without paying the wasm cost up front.

@mlc-ai/web-llm is an optional peer dependency β€” install it alongside this package when you opt into browser-only inference.

#Properties

#engine?

optional engine?: WebLlmEngineLike

Defined in: packages/adapters/src/webllm.ts:22

Override the engine to inject a pre-loaded one (the MLCEngine spin-up is non-trivial β€” apps usually warm it once, not per turn).


#model

model: string

Defined in: packages/adapters/src/webllm.ts:17

Model id from MLC's catalog, e.g. Llama-3.1-8B-Instruct-q4f16_1-MLC.


#onProgress?

optional onProgress?: (info) => void

Defined in: packages/adapters/src/webllm.ts:24

Engine progress callback (model download / compile percent).

#Parameters

info
progress

number

text

string

#Returns

void


#Interface: WebLlmEngineLike

Defined in: packages/adapters/src/webllm.ts:30

Data type used by the WebLLM chat adapter.

#Properties

#chat

chat: object

Defined in: packages/adapters/src/webllm.ts:32

#completions

completions: object

completions.create()

create(params): AsyncIterable<{ choices: object[]; }, any, any> | Promise<AsyncIterable<{ choices: object[]; }, any, any>>

Parameters
params
messages

object[]

stream

true

Returns

AsyncIterable<{ choices: object[]; }, any, any> | Promise<AsyncIterable<{ choices: object[]; }, any, any>>

#Methods

#reload()

reload(model, opts?): Promise<void>

Defined in: packages/adapters/src/webllm.ts:31

#Parameters

model

string

opts?
initProgressCallback?

(i) => void

#Returns

Promise<void>


#Interface: WorkersAiConfig

Defined in: packages/adapters/src/cloudflare.ts:24

Workers AI REST configuration; no Cloudflare runtime binding is required.

#Extends

#Properties

#accountId

accountId: string

Defined in: packages/adapters/src/cloudflare.ts:25


#apiKey?

optional apiKey?: string

Defined in: packages/adapters/src/openai-compatible.ts:9

#Inherited from

OpenAICompatibleTransportConfig.apiKey


#baseUrl?

optional baseUrl?: string

Defined in: packages/adapters/src/openai.ts:11

#Inherited from

OpenAIConfig.baseUrl


#capabilities?

optional capabilities?: Partial<AdapterCapabilities>

Defined in: packages/adapters/src/openai.ts:25

Explicit capability facts take precedence over model-name heuristics.

#Inherited from

OpenAIConfig.capabilities


#fetch?

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/adapters/src/openai.ts:14

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

RequestInfo | URL

init?

RequestInit

Returns

Promise<Response>

#Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters
input

string | Request | URL

init?

RequestInit

Returns

Promise<Response>

#Inherited from

OpenAIConfig.fetch


#headers?

optional headers?: HeadersInit

Defined in: packages/adapters/src/openai.ts:13

#Inherited from

OpenAIConfig.headers


#includeUsage?

optional includeUsage?: boolean

Defined in: packages/adapters/src/openai.ts:23

Ask the provider to include token usage in the final stream chunk via stream_options: \{ include_usage: true \}. Off by default because some OpenAI-compatible providers (OpenRouter proxies to a long tail of backends) reject unknown params with a 4xx and break the whole stream. Turn this on for vanilla api.openai.com.

#Inherited from

OpenAIConfig.includeUsage


#model

model: string

Defined in: packages/adapters/src/openai.ts:10

#Inherited from

OpenAIConfig.model


#path?

optional path?: string

Defined in: packages/adapters/src/openai.ts:12

#Inherited from

OpenAIConfig.path


#retry?

optional retry?: RetryOptions

Defined in: packages/adapters/src/openai.ts:15

#Inherited from

OpenAIConfig.retry

Explore nearby

On this page

Interface: AnthropicConfigPropertiesapiKeybaseUrl?maxTokens?modelretry?Interface: ApplyCarbonOptionsPropertiesfallback?keyFor?ParameterscandidateReturnstable?Interface: AzureOpenAIConfigPropertiesapiKeyapiVersion?deploymentendpointincludeUsage?retry?Interface: BailConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: BedrockConfigPropertiesclient?maxTokens?modelregion?Interface: BedrockRuntimeClientLikeMethodssend()Parameterscommandinputoptions?abortSignal?ReturnsInterface: CerebrasConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: CloudflareAiGatewayConfigExtendsPropertiesaccountIdapiKey?Inherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromgatewayIdgatewayToken?headers?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: CohereConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: CreateAdapterConfigPropertiesabort?ReturnsparseParametersstreamresponse?ReturnssendParametersrequestsignal?ReturnsInterface: CredentialRefreshablePropertiesrefreshCredentialsParametersnextReturnsInterface: DeepSeekConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: DeepSeekEmbedderConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited frommodelInherited fromInterface: DeprecationPolicyPropertieslogger?ParametersmsgReturnsonDeprecationtable?Interface: EnsembleBranchResultPropertieschunkserror?idtextInterface: EnsembleCandidatePropertiesadapteridweight?Interface: EnsembleOptionsPropertiesaggregate?candidatesonBranches?ParametersbranchesReturnstimeoutMs?Interface: FallbackCandidatePropertiesadapteridInterface: FallbackOptionsPropertiesonFallback?ParametersfromerroridindexReturnsshouldRetry?ParameterserrorindexReturnsInterface: FireworksConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: GeminiConfigPropertiesapiKeybaseUrl?modelretry?Interface: GeminiEmbedderConfigPropertiesapiKeybaseUrl?model?Interface: GenericAdapterConfigPropertiessendParametersrequestsignal?ReturnsInterface: GrokConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: GrokEmbedderConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited frommodelInherited fromInterface: GroqConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: HuggingFaceConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: KimiConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: KimiEmbedderConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited frommodelInherited fromInterface: LangChainConfigPropertiesmode?runnableInterface: LangGraphConfigPropertiesgraphInterface: LlamaCppConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: LMStudioConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: MistralConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: MockAdapterOptionsPropertiesdelayMs?history?responseInterface: ModelDeprecationPropertiesmodelnote?providersuccessor?sunsetOn?Interface: ModelProviderConfigPropertiesapiKey?baseUrl?maxTokens?modelproviderretry?Interface: OllamaConfigPropertiesbaseUrl?modelmultiModal?retry?Interface: OllamaEmbedderConfigPropertiesbaseUrl?model?Interface: OpenAICompatibleConfigExtendsExtended byPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: OpenAICompatibleEmbedderConfigExtended byPropertiesapiKeybaseUrl?modelInterface: OpenAICompatibleTransportConfigExtendsExtended byPropertiesapiKey?baseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: OpenAIConfigExtended byPropertiesapiKeybaseUrl?capabilities?fetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?Returnsheaders?includeUsage?modelpath?retry?Interface: OpenAIEmbedderConfigPropertiesapiKeybaseUrl?model?Interface: OpenRouterConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: RecordedTurnPropertieschunksrecordedAtrequestInterface: RecordingSinkMethodspush()ParametersturnReturnsInterface: ReplicateConfigPropertiesapiKeybaseUrl?modeltoInput?ParametersrequestReturnsversion?Interface: ResolveModelInputPropertiesmodelproviderInterface: ResolveModelResultPropertiesdeprecation?modelremappedInterface: RetryOptionsExamplePropertiesbaseDelayMs?jitter?maxAttempts?maxDelayMs?onRetry?ParametersinfoattemptdelayMsreasonReturnsretryOn?Parametersinfoattempterror?response?Returnssleep?ParametersmsReturnsInterface: RotatingCredentialsPropertiescurrentonRotateParametershandlerReturnsrotateParametersnextReturnsInterface: RouterCandidatePropertiesadaptercapabilities?cost?gCO2PerKtok?idlatencyMs?region?tags?Interface: RouterOptionsPropertiescandidatesclassify?ParametersrequestReturnsonRoute?ParametersdecisionidreasonrequestReturnspolicy?region?regionOf?ParametersrequestReturnsInterface: TogetherConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: VercelAIConfigPropertiesapiheaders?retry?Interface: VertexConfigPropertiesaccessTokenmodelprojectpublisher?regionretry?Interface: VLLMConfigExtendsPropertiesapiKeyInherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited fromInterface: WebLlmConfigPropertiesengine?modelonProgress?ParametersinfoprogresstextReturnsInterface: WebLlmEngineLikePropertieschatcompletionscompletions.create()ParametersparamsmessagesstreamReturnsMethodsreload()Parametersmodelopts?initProgressCallback?ReturnsInterface: WorkersAiConfigExtendsPropertiesaccountIdapiKey?Inherited frombaseUrl?Inherited fromcapabilities?Inherited fromfetch?Call SignatureParametersinputinit?ReturnsCall SignatureParametersinputinit?ReturnsInherited fromheaders?Inherited fromincludeUsage?Inherited frommodelInherited frompath?Inherited fromretry?Inherited from