IEmbeddingGenerator Interface

Reference

Definition

Namespace:: Microsoft.Extensions.AI

Assembly:: Microsoft.Extensions.AI.Abstractions.dll

Package:: Microsoft.Extensions.AI.Abstractions v9.4.0-preview.1.25207.5

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.

Represents a generator of embeddings.

public interface class IEmbeddingGenerator : IDisposable

public interface IEmbeddingGenerator : IDisposable

type IEmbeddingGenerator = interface
    interface IDisposable

Public Interface IEmbeddingGenerator
Implements IDisposable

Derived: Microsoft.Extensions.AI.DelegatingEmbeddingGenerator<TInput,TEmbedding>

Microsoft.Extensions.AI.IEmbeddingGenerator<TInput,TEmbedding>

Microsoft.Extensions.AI.OllamaEmbeddingGenerator

Implements: IDisposable

Remarks

This base interface is used to allow for embedding generators to be stored in a non-generic manner. To use the generator to create embeddings, instances typed as this base interface first need to be cast to the generic interface IEmbeddingGenerator<TInput,TEmbedding>.

Methods

Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable)
GetService(Type, Object)	Asks the IEmbeddingGenerator<TInput,TEmbedding> for an object of the specified type `serviceType`.

Extension Methods

GetRequiredService(IEmbeddingGenerator, Type, Object)	Asks the IEmbeddingGenerator<TInput,TEmbedding> for an object of the specified type `serviceType` and throws an exception if one isn't available.
GetRequiredService<TService>(IEmbeddingGenerator, Object)	Asks the IEmbeddingGenerator<TInput,TEmbedding> for an object of type `TService` and throws an exception if one isn't available.
GetService<TService>(IEmbeddingGenerator, Object)	Asks the IEmbeddingGenerator<TInput,TEmbedding> for an object of type `TService`.

Applies to

Share via