OpenAITextEmbeddingGenerationService Class

Definition

Namespace:

Microsoft.SemanticKernel.Connectors.OpenAI

Assembly:

Microsoft.SemanticKernel.Connectors.OpenAI.dll

Package:

Microsoft.SemanticKernel.Connectors.OpenAI v1.45.0

OpenAI implementation of ITextEmbeddingGenerationService

public sealed class OpenAITextEmbeddingGenerationService : Microsoft.SemanticKernel.Embeddings.IEmbeddingGenerationService<string,float>, Microsoft.SemanticKernel.Embeddings.ITextEmbeddingGenerationService

type OpenAITextEmbeddingGenerationService = class
    interface ITextEmbeddingGenerationService
    interface IEmbeddingGenerationService<string, single>
    interface IAIService

Public NotInheritable Class OpenAITextEmbeddingGenerationService
Implements IEmbeddingGenerationService(Of String, Single), ITextEmbeddingGenerationService

Inheritance

Object

OpenAITextEmbeddingGenerationService

Implements

IEmbeddingGenerationService<String,Single> ITextEmbeddingGenerationService IAIService

Constructors

OpenAITextEmbeddingGenerationService(String, OpenAIClient, ILoggerFactory, Nullable<Int32>)	Initializes a new instance of the OpenAITextEmbeddingGenerationService class.
OpenAITextEmbeddingGenerationService(String, String, String, HttpClient, ILoggerFactory, Nullable<Int32>)	Initializes a new instance of the OpenAITextEmbeddingGenerationService class.

Properties

Attributes

Gets the AI service attributes.

Methods

GenerateEmbeddingsAsync(IList<String>, Kernel, CancellationToken)

Generates an embedding from the given data.

Extension Methods

AsEmbeddingGenerator<TValue,TEmbedding>(IEmbeddingGenerationService<TValue,TEmbedding>)	Creates an IEmbeddingGenerator<TInput,TEmbedding> for the specified IEmbeddingGenerationService<TValue,TEmbedding>.
GenerateEmbeddingAsync<TValue,TEmbedding>(IEmbeddingGenerationService<TValue,TEmbedding>, TValue, Kernel, CancellationToken)	Generates an embedding from the given value.
GetDimensions<TValue,TEmbedding>(IEmbeddingGenerationService<TValue,TEmbedding>)	Gets the dimensions from service's IEmbeddingGenerationService<TValue,TEmbedding>.
GetApiVersion(IAIService)	Gets the API version from service's Attributes
GetEndpoint(IAIService)	Gets the endpoint from service's Attributes.
GetModelId(IAIService)	Gets the model identifier from service's Attributes.