Skip to content

CohereEmbeddingModel

Namespace: Vercel.AI.Cohere

public sealed class CohereEmbeddingModel : IEmbeddingModel

Cohere embedding model.

Inheritance: object

Implements: IEmbeddingModel

View source

CohereEmbeddingModel(CohereProvider, string)

Section titled “CohereEmbeddingModel(CohereProvider, string)”
public CohereEmbeddingModel(CohereProvider provider, string modelId)

Creates an embedding model.

Parameters

Name Type Description
provider CohereProvider
modelId string

View source

public string ModelId { get; }

Model id.

Value: string

View source

public string Provider { get; }

Provider id.

Value: string

View source

public string SpecificationVersion { get; }

Specification version. Always V4.

Value: string

View source

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

Section titled “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

Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product