Share via

AzureAIInferenceExtensions.AsIEmbeddingGenerator Method

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.AzureAIInference.dll
Package:
Microsoft.Extensions.AI.AzureAIInference v9.6.0-preview.1.25310.2

Overloads

AsIEmbeddingGenerator(EmbeddingsClient, String, Nullable<Int32>)

Source:
AzureAIInferenceExtensions.cs

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

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

Parameters

embeddingsClient
EmbeddingsClient

The client.

defaultModelId
String

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

defaultModelDimensions
Nullable<Int32>

The number of dimensions generated in each embedding.

Returns

IEmbeddingGenerator<String,Embedding<Single>>

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

Applies to

AsIEmbeddingGenerator(ImageEmbeddingsClient, String, Nullable<Int32>)

Source:
AzureAIInferenceExtensions.cs

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

public static Microsoft.Extensions.AI.IEmbeddingGenerator<Microsoft.Extensions.AI.DataContent,Microsoft.Extensions.AI.Embedding<float>> AsIEmbeddingGenerator(this Azure.AI.Inference.ImageEmbeddingsClient imageEmbeddingsClient, string? defaultModelId = default, int? defaultModelDimensions = default);
static member AsIEmbeddingGenerator : Azure.AI.Inference.ImageEmbeddingsClient * string * Nullable<int> -> Microsoft.Extensions.AI.IEmbeddingGenerator<Microsoft.Extensions.AI.DataContent, Microsoft.Extensions.AI.Embedding<single>>
<Extension()>
Public Function AsIEmbeddingGenerator (imageEmbeddingsClient As ImageEmbeddingsClient, Optional defaultModelId As String = Nothing, Optional defaultModelDimensions As Nullable(Of Integer) = Nothing) As IEmbeddingGenerator(Of DataContent, Embedding(Of Single))

Parameters

imageEmbeddingsClient
ImageEmbeddingsClient

The client.

defaultModelId
String

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

defaultModelDimensions
Nullable<Int32>

The number of dimensions generated in each embedding.

Returns

IEmbeddingGenerator<DataContent,Embedding<Single>>

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

Applies to