Language

IEmbeddingGenerator Interface

Definition

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

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
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.

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 for an object of the specified type serviceType.

Extension Methods

Name Description
GetRequiredService(IEmbeddingGenerator, Type, Object)

Asks the IEmbeddingGenerator for an object of the specified type serviceType and throws an exception if one isn't available.
GetRequiredService(IEmbeddingGenerator, Object)

Asks the IEmbeddingGenerator for an object of type TService and throws an exception if one isn't available.
GetService(IEmbeddingGenerator, Object)

Asks the IEmbeddingGenerator for an object of type TService.

Applies to