AzureOpenAITextEmbeddingGenerationService Class

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.AzureOpenAI

Assembly:: Microsoft.SemanticKernel.Connectors.AzureOpenAI.dll

Package:: Microsoft.SemanticKernel.Connectors.AzureOpenAI v1.45.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Azure OpenAI text embedding service.

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

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

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

Inheritance: Object
AzureOpenAITextEmbeddingGenerationService

Implements: IEmbeddingGenerationService<String,Single> ITextEmbeddingGenerationService IAIService

Constructors

AzureOpenAITextEmbeddingGenerationService(String, AzureOpenAIClient, String, ILoggerFactory, Nullable<Int32>)	Initializes a new instance of the AzureOpenAITextEmbeddingGenerationService class.
AzureOpenAITextEmbeddingGenerationService(String, String, String, String, HttpClient, ILoggerFactory, Nullable<Int32>, String)	Initializes a new instance of the AzureOpenAITextEmbeddingGenerationService class.
AzureOpenAITextEmbeddingGenerationService(String, String, TokenCredential, String, HttpClient, ILoggerFactory, Nullable<Int32>, String)	Initializes a new instance of the AzureOpenAITextEmbeddingGenerationService 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.

Applies to

Share via