OpenAIEmbeddingGenerator Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.OpenAI.dll

Package:

Microsoft.Extensions.AI.OpenAI v9.0.0-preview.9.24525.1

An IEmbeddingGenerator<TInput,TEmbedding> for an OpenAI OpenAI.Embeddings.EmbeddingClient.

public ref class OpenAIEmbeddingGenerator sealed : IDisposable, Microsoft::Extensions::AI::IEmbeddingGenerator<System::String ^, Microsoft::Extensions::AI::Embedding<float> ^>

public sealed class OpenAIEmbeddingGenerator : IDisposable, Microsoft.Extensions.AI.IEmbeddingGenerator<string,Microsoft.Extensions.AI.Embedding<float>>

type OpenAIEmbeddingGenerator = class
    interface IEmbeddingGenerator<string, Embedding<single>>
    interface IDisposable

Public NotInheritable Class OpenAIEmbeddingGenerator
Implements IDisposable, IEmbeddingGenerator(Of String, Embedding(Of Single))

Inheritance

Object

OpenAIEmbeddingGenerator

Implements

IEmbeddingGenerator<String,Embedding<Single>> IDisposable

Constructors

OpenAIEmbeddingGenerator(EmbeddingClient, Nullable<Int32>)	Initializes a new instance of the OpenAIEmbeddingGenerator class.
OpenAIEmbeddingGenerator(OpenAIClient, String, Nullable<Int32>)	Initializes a new instance of the OpenAIEmbeddingGenerator class.

Properties

Metadata

Gets metadata that describes the IEmbeddingGenerator<TInput,TEmbedding>.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GenerateAsync(IEnumerable<String>, EmbeddingGenerationOptions, CancellationToken)	Generates embeddings for each of the supplied values.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetService<TService>(Object)	Asks the IEmbeddingGenerator<TInput,TEmbedding> for an object of type TService.
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IDisposable.Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Extension Methods

GenerateAndZipAsync<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken)	Generates embeddings for each of the supplied values and produces a list that pairs each input value with its resulting embedding.
GenerateEmbeddingAsync<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, TInput, EmbeddingGenerationOptions, CancellationToken)	Generates an embedding from the specified value.