Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

IEmbeddingGenerator Interface

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Package:
Microsoft.Extensions.AI.Abstractions v10.7.0
Source:
IEmbeddingGenerator.cs

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
Implements

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

Name Description
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

Name Description
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

Feedback

Was this page helpful?