PURISTA

Appearance

PURISTA API

PURISTA API / @purista/ai / ModelProvider

Interface: ModelProvider ​

Defined in: packages/ai/src/providers/runtime/ModelProvider.ts:146

Minimal interface providers must satisfy so they can be swapped at runtime.

Properties ​

capabilities ​

readonly capabilities: ModelProviderCapabilities

Defined in: packages/ai/src/providers/runtime/ModelProvider.ts:148

name ​

readonly name: string

Defined in: packages/ai/src/providers/runtime/ModelProvider.ts:147

Methods ​

embed()? ​

optional embed(request): Promise<ProviderEmbedResponse>

Defined in: packages/ai/src/providers/runtime/ModelProvider.ts:152

Parameters ​

request ​

ProviderEmbedRequest

Returns ​

Promise<ProviderEmbedResponse>

embedMany()? ​

optional embedMany(request): Promise<ProviderEmbedManyResponse>

Defined in: packages/ai/src/providers/runtime/ModelProvider.ts:153

Parameters ​

request ​

ProviderEmbedManyRequest

Returns ​

Promise<ProviderEmbedManyResponse>

generate()? ​

optional generate(request): Promise<ProviderResponse>

Defined in: packages/ai/src/providers/runtime/ModelProvider.ts:149

Parameters ​

request ​

ProviderRequest

Returns ​

Promise<ProviderResponse>

generateJson()? ​

optional generateJson<T>(request): Promise<ProviderJsonResponse<T>>

Defined in: packages/ai/src/providers/runtime/ModelProvider.ts:151

Type Parameters ​

T ​

T = unknown

Parameters ​

request ​

ProviderJsonRequest

Returns ​

Promise<ProviderJsonResponse<T>>

rerank()? ​

optional rerank<Document>(request): Promise<ProviderRerankResponse<Document>>

Defined in: packages/ai/src/providers/runtime/ModelProvider.ts:154

Type Parameters ​

Document ​

Document = string | Record<string, unknown>

Parameters ​

request ​

ProviderRerankRequest<Document>

Returns ​

Promise<ProviderRerankResponse<Document>>

stream()? ​

optional stream(request): ProviderStream

Defined in: packages/ai/src/providers/runtime/ModelProvider.ts:150

Parameters ​

request ​

ProviderRequest

Returns ​

ProviderStream