BertOnnxTextEmbeddingGenerationService Class

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.Onnx

Assembly:: Microsoft.SemanticKernel.Connectors.Onnx.dll

Package:: Microsoft.SemanticKernel.Connectors.Onnx v1.45.0-alpha

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.

Provides a text embedding generation service using a BERT ONNX model.

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

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

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

Inheritance: Object
BertOnnxTextEmbeddingGenerationService

Implements: IEmbeddingGenerationService<String,Single> ITextEmbeddingGenerationService IAIService IDisposable

Properties

Name	Description
Attributes	Gets the AI service attributes.

Methods

Name	Description
Create(Stream, Stream, BertOnnxOptions)	Creates a new instance of the BertOnnxTextEmbeddingGenerationService class.
Create(String, String, BertOnnxOptions)	Creates a new instance of the BertOnnxTextEmbeddingGenerationService class.
CreateAsync(Stream, Stream, BertOnnxOptions, CancellationToken)	Creates a new instance of the BertOnnxTextEmbeddingGenerationService class.
CreateAsync(String, String, BertOnnxOptions, CancellationToken)	Creates a new instance of the BertOnnxTextEmbeddingGenerationService class.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GenerateEmbeddingsAsync(IList<String>, Kernel, CancellationToken)	Generates an embedding from the given `data`.

Extension Methods

Name	Description
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`.
GetApiVersion(IAIService)	Gets the API version from `service`'s Attributes
GetDimensions<TValue,TEmbedding>(IEmbeddingGenerationService<TValue,TEmbedding>)	Gets the dimensions from `service`'s IEmbeddingGenerationService<TValue,TEmbedding>.
GetEndpoint(IAIService)	Gets the endpoint from `service`'s Attributes.
GetModelId(IAIService)	Gets the model identifier from `service`'s Attributes.

Applies to