GoogleEmbeddingModel
Namespace: Vercel.AI.Google
public sealed class GoogleEmbeddingModel : IEmbeddingModelGemini embedding model. One value uses :embedContent; several values use :batchEmbedContents.
Inheritance: object
Implements: IEmbeddingModel
Constructors
Section titled “Constructors”GoogleEmbeddingModel(GoogleProvider, string)
Section titled “GoogleEmbeddingModel(GoogleProvider, string)”public GoogleEmbeddingModel(GoogleProvider provider, string modelId)Creates an embedding model.
Parameters
| Name | Type | Description |
|---|---|---|
provider |
GoogleProvider | |
modelId |
string |
Fields
Section titled “Fields”MaxEmbeddingsPerCall
Section titled “MaxEmbeddingsPerCall”public const int MaxEmbeddingsPerCall = 100Maximum values in one Generative Language batch.
Value: int
Properties
Section titled “Properties”ModelId
Section titled “ModelId”public string ModelId { get; }Model id.
Value: string
Provider
Section titled “Provider”public string Provider { get; }Provider id.
Value: string
SpecificationVersion
Section titled “SpecificationVersion”public string SpecificationVersion { get; }Specification version. Always V4.
Value: string
Methods
Section titled “Methods”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>
Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product