Share via

AzureAIInferenceExtensions.AsEmbeddingGenerator Method

  • Reference

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.AzureAIInference.dll
Package:
Microsoft.Extensions.AI.AzureAIInference v9.0.0-preview.9.24556.5

Gets an IEmbeddingGenerator<TInput,TEmbedding> for use with this EmbeddingsClient.

public static Microsoft.Extensions.AI.IEmbeddingGenerator<string,Microsoft.Extensions.AI.Embedding<float>> AsEmbeddingGenerator (this Azure.AI.Inference.EmbeddingsClient embeddingsClient, string? modelId = default, int? dimensions = default);
static member AsEmbeddingGenerator : Azure.AI.Inference.EmbeddingsClient * string * Nullable<int> -> Microsoft.Extensions.AI.IEmbeddingGenerator<string, Microsoft.Extensions.AI.Embedding<single>>
<Extension()>
Public Function AsEmbeddingGenerator (embeddingsClient As EmbeddingsClient, Optional modelId As String = Nothing, Optional dimensions As Nullable(Of Integer) = Nothing) As IEmbeddingGenerator(Of String, Embedding(Of Single))

Parameters

embeddingsClient
EmbeddingsClient

The client.

modelId
String

The id of the model to use. If null, it may be provided per request via ModelId.

dimensions
Nullable<Int32>

The number of dimensions to generate in each embedding.

Returns

IEmbeddingGenerator<String,Embedding<Single>>

An IEmbeddingGenerator<TInput,TEmbedding> that may be used to generate embeddings via the EmbeddingsClient.

Applies to