Skip to main content

Interface: Provider

Defined in: packages/client/src/types.ts:321

Extends​

Properties​

asksFirst?​

readonly optional asksFirst?: boolean

Defined in: packages/client/src/types.ts:329

The visitor's own AI, to propose first: while it isn't ready, the chat providers after it wait until the visitor picks one (ai.chooseInstead(id)), unless the client has fallback: "auto".

connect?​

optional connect?: () => Promise<void>

Defined in: packages/client/src/types.ts:340

Resolve needs-action: pair with the engine, start a model download… Must be called from a user gesture.

Returns​

Promise<void>

createSession​

createSession: (options) => Promise<ProviderSession>

Defined in: packages/client/src/types.ts:345

Parameters​

options​

SessionOptions

Returns​

Promise<ProviderSession>

decide?​

optional decide?: (request) => Promise<DecideResult<Record<string, DecideQuestion>>>

Defined in: packages/client/src/types.ts:349

Answer typed questions; present on providers that offer decide.

Parameters​

request​

DecideRequest

Returns​

Promise<DecideResult<Record<string, DecideQuestion>>>

detect​

detect: () => Promise<void>

Defined in: packages/client/src/types.ts:335

Check availability. Cheap and safe to call often.

Returns​

Promise<void>

disconnect?​

optional disconnect?: () => void

Defined in: packages/client/src/types.ts:342

Forget the visitor's grant in this browser, if any.

Returns​

void

embed?​

optional embed?: (request) => Promise<EmbedResult>

Defined in: packages/client/src/types.ts:347

Embed texts; present on providers that offer embed.

Parameters​

request​

EmbedRequest

Returns​

Promise<EmbedResult>

getState​

getState: () => ProviderState

Defined in: packages/client/src/types.ts:331

Current state; the core re-reads it after onChange fires.

Returns​

ProviderState

id​

id: string

Defined in: packages/client/src/types.ts:191

Inherited from​

ProviderInfo.id

label​

label: string

Defined in: packages/client/src/types.ts:192

Inherited from​

ProviderInfo.label

locality​

locality: Locality

Defined in: packages/client/src/types.ts:193

Inherited from​

ProviderInfo.locality

manage?​

optional manage?: () => void

Defined in: packages/client/src/types.ts:344

Open the visitor's own settings for this site (their AI and model), from a click.

Returns​

void

offers?​

readonly optional offers?: readonly Service[]

Defined in: packages/client/src/types.ts:323

What it serves. Default ["chat"]; an embedder alone is ["embed"].

onChange​

onChange: (listener) => () => void

Defined in: packages/client/src/types.ts:333

Subscribe to state changes. Returns the unsubscribe function.

Parameters​

listener​

() => void

Returns​

() => void