Skip to content
Provider Protocol Provider Protocol

Interface: EmbeddingOptions

@providerprotocol/ai

@providerprotocol/ai / @providerprotocol/ai / EmbeddingOptions

Interface: EmbeddingOptions<TParams>

Section titled “Interface: EmbeddingOptions<TParams>”

Defined in: src/types/embedding.ts:63

Options for creating an embedding instance with the embedding() function.

Example

Section titled “Example”
const options: EmbeddingOptions<OpenAIEmbedParams> = {
  model: openai('text-embedding-3-large'),
  config: { apiKey: process.env.OPENAI_API_KEY },
  params: { dimensions: 1536 }
};

Type Parameters

Section titled “Type Parameters”

TParams

Section titled “TParams”

TParams = unknown

Provider-specific parameter type

Properties

Section titled “Properties”

config?

Section titled “config?”

optional config: ProviderConfig

Defined in: src/types/embedding.ts:68

Provider infrastructure configuration

middleware?

Section titled “middleware?”

optional middleware: Middleware[]

Defined in: src/types/embedding.ts:79

Middleware for intercepting and transforming requests and responses.

Middleware are executed in array order for request/start hooks, and reverse order for response/end hooks.

model

Section titled “model”

model: EmbeddingModelInput

Defined in: src/types/embedding.ts:65

A model reference from a provider factory

params?

Section titled “params?”

optional params: TParams

Defined in: src/types/embedding.ts:71

Provider-specific parameters (passed through unchanged)