Share via

OpenAIClientExtensions.AsEmbeddingGenerator Method

  • Reference

Definition

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

Overloads

AsEmbeddingGenerator(EmbeddingClient, Nullable<Int32>)

Gets an IEmbeddingGenerator<TInput,TEmbedding> for use with this OpenAI.Embeddings.EmbeddingClient.
AsEmbeddingGenerator(OpenAIClient, String, Nullable<Int32>)

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

AsEmbeddingGenerator(EmbeddingClient, Nullable<Int32>)

Gets an IEmbeddingGenerator<TInput,TEmbedding> for use with this OpenAI.Embeddings.EmbeddingClient.

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

Parameters

embeddingClient
OpenAI.Embeddings.EmbeddingClient

The client.

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 OpenAI.Embeddings.EmbeddingClient.

Applies to

AsEmbeddingGenerator(OpenAIClient, String, Nullable<Int32>)

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

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

Parameters

openAIClient
OpenAI.OpenAIClient

The client.

modelId
String

The model to use.

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 OpenAI.Embeddings.EmbeddingClient.

Applies to