OpenAIEmbeddingModel

Namespace: Vercel.AI.OpenAI

public sealed class OpenAIEmbeddingModel : IEmbeddingModel

OpenAI embeddings model.

Inheritance: object

Implements: IEmbeddingModel

View source

Constructors

OpenAIEmbeddingModel(OpenAIProvider, string)

public OpenAIEmbeddingModel(OpenAIProvider provider, string modelId)

Creates an embedding model.

Parameters

Name	Type	Description
provider	OpenAIProvider
modelId	string

View source

Fields

DefaultMaxEmbeddingsPerCall

public const int DefaultMaxEmbeddingsPerCall = 2048

Maximum embedding inputs in one request.

Value: int

View source

DefaultMaxInputBytesPerCall

public const int DefaultMaxInputBytesPerCall = 300000

Maximum input bytes in one request.

Value: int

View source

Properties

MaxEmbeddingsPerCall

public int MaxEmbeddingsPerCall { get; }

Maximum values accepted by one call.

Value: int

View source

MaxInputBytesPerCall

public int MaxInputBytesPerCall { get; }

Maximum combined input size accepted by one call.

Value: int

View source

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

Provider

public string Provider { get; }

Provider id.

Value: string

View source

SpecificationVersion

public string SpecificationVersion { get; }

Specification version. Always V4.

Value: string

View source

SupportsParallelCalls

public bool SupportsParallelCalls { get; }

Whether the model accepts parallel embedding calls.

Value: bool

View source

Methods

DoEmbedAsync(IReadOnlyList<string>, IReadOnlyDictionary<string, JsonElement>?, CancellationToken, int?, IReadOnlyDictionary<string, string?>?)

public Task<EmbeddingResult> DoEmbedAsync(IReadOnlyList<string> values, IReadOnlyDictionary<string, JsonElement>? providerOptions, CancellationToken cancellationToken, int? dimensions = null, IReadOnlyDictionary<string, string?>? headers = null)

Embeds each value. Maps to doEmbed. <code class=“paramref”>providerOptions</code> is keyed by provider id. <code class=“paramref”>dimensions</code> is the requested vector width. A provider option for the same setting wins. <code class=“paramref”>headers</code> are sent with this call and override the provider headers.

Parameters

Name	Type	Description
values	IReadOnlyList<string>
providerOptions	IReadOnlyDictionary<string, JsonElement>
cancellationToken	CancellationToken
dimensions	int?
headers	IReadOnlyDictionary<string, string>

Returns: Task<EmbeddingResult>

View source

EmbedAsync(IReadOnlyList<string>, int?, string?, IReadOnlyDictionary<string, string?>?, CancellationToken)

public Task<OpenAIEmbeddingCallResult> EmbedAsync(IReadOnlyList<string> values, int? dimensions, string? user, IReadOnlyDictionary<string, string?>? headers, CancellationToken cancellationToken)

Embeds <code class=“paramref”>values</code>, sending <code class=“paramref”>dimensions</code> and <code class=“paramref”>user</code> when they are set.

Parameters

Name	Type	Description
values	IReadOnlyList<string>
dimensions	int?
user	string
headers	IReadOnlyDictionary<string, string>
cancellationToken	CancellationToken

Returns: Task<OpenAIEmbeddingCallResult>

View source