VoyageProvider.VoyageEmbeddingModel

Namespace: Vercel.AI.Voyage

public sealed class VoyageProvider.VoyageEmbeddingModel : IEmbeddingModel

Voyage embedding model.

Inheritance: object

Implements: IEmbeddingModel

View source

Constructors

VoyageEmbeddingModel(VoyageProvider, string)

public VoyageEmbeddingModel(VoyageProvider provider, string modelId)

Creates an embedding model.

Parameters

Name	Type	Description
provider	VoyageProvider
modelId	string

View source

Properties

MaxEmbeddingsPerCall

public int MaxEmbeddingsPerCall { get; }

Maximum values in 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

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(VoyageEmbeddingRequest, CancellationToken)

public Task<VoyageEmbeddingResult> EmbedAsync(VoyageEmbeddingRequest request, CancellationToken cancellationToken)

Embeds values and returns usage plus the raw response.

Parameters

Name	Type	Description
request	VoyageEmbeddingRequest
cancellationToken	CancellationToken

Returns: Task<VoyageEmbeddingResult>

View source