OpenAICompatibleEmbeddingModel

Namespace: Vercel.AI.OpenAICompatible

public sealed class OpenAICompatibleEmbeddingModel : IEmbeddingModel

OpenAI-compatible embeddings model.

Inheritance: object

Implements: IEmbeddingModel

View source

Constructors

OpenAICompatibleEmbeddingModel(OpenAICompatibleProvider, string)

public OpenAICompatibleEmbeddingModel(OpenAICompatibleProvider provider, string modelId)

Creates an embedding model.

Parameters

Name	Type	Description
provider	OpenAICompatibleProvider
modelId	string

View source

Properties

Endpoint

public Uri? Endpoint { get; set; }

When set, the embedding call uses this URL instead of the provider embeddings route.

Value: Uri

View source

MaxEmbeddingsPerCall

public int MaxEmbeddingsPerCall { get; set; }

Maximum inputs accepted by one request.

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

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

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

public Task<EmbeddingResult> DoEmbedAsync(IReadOnlyList<string> values, int? dimensions, string? user, CancellationToken cancellationToken)

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

Parameters

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

Returns: Task<EmbeddingResult>

View source

DoEmbedAsync(EmbeddingCallOptions, CancellationToken)

public Task<EmbeddingResult> DoEmbedAsync(EmbeddingCallOptions options, CancellationToken cancellationToken)

Embeds values with per-call options. Nothing is kept on the model, so concurrent calls do not see each other.

Parameters

Name	Type	Description
options	EmbeddingCallOptions
cancellationToken	CancellationToken

Returns: Task<EmbeddingResult>

View source