IEmbeddingGenerator<TInput,TEmbedding> 接口

定义

命名空间:
Microsoft.Extensions.AI
程序集:
Microsoft.Extensions.AI.Abstractions.dll
包:
Microsoft.Extensions.AI.Abstractions v10.7.0
Source:
IEmbeddingGenerator{TInput,TEmbedding}.cs

表示嵌入的生成器。

generic <typename TInput, typename TEmbedding>
 where TEmbedding : Embeddingpublic interface class IEmbeddingGenerator : IDisposable, Microsoft::Extensions::AI::IEmbeddingGenerator
public interface IEmbeddingGenerator<in TInput,TEmbedding> : IDisposable, Microsoft.Extensions.AI.IEmbeddingGenerator where TEmbedding : Embedding
type IEmbeddingGenerator<'Input, 'Embedding (requires 'Embedding :> Embedding)> = interface
    interface IEmbeddingGenerator
    interface IDisposable
Public Interface IEmbeddingGenerator(Of In TInput, TEmbedding)
Implements IDisposable, IEmbeddingGenerator

类型参数

TInput

将从中生成嵌入的类型。

这是逆变类型参数。 即，可以使用指定的类型，也可以使用派生程度较低的任何类型。 有关协变和逆变的详细信息，请参阅泛型中的协变和逆变。
TEmbedding

要生成的嵌入类型。

派生
实现
IEmbeddingGenerator IDisposable

注解

除非另行指定，否则所有成员 IEmbeddingGenerator<TInput,TEmbedding> 都是线程安全的供并发使用。 预计多个请求同时使用支持的所有实现 IEmbeddingGenerator<TInput,TEmbedding> 。 实例仍在使用中时，不得释放实例。

但是，这些实现 IEmbeddingGenerator<TInput,TEmbedding> 可能会改变提供给 GenerateAsync(IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken)的参数，例如通过配置选项实例。 因此，接口的使用者应避免将这些参数的共享实例用于并发调用，否则应通过构造确保不使用 IEmbeddingGenerator<TInput,TEmbedding> 此类突变的实例。

方法

名称 说明
Dispose()

执行与释放、释放或重置非托管资源关联的应用程序定义任务。

(继承自 IDisposable)
GenerateAsync(IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken)

为每个提供的 values项生成嵌入项。
GetService(Type, Object)

IEmbeddingGenerator<TInput,TEmbedding>请求指定类型的serviceType对象。

(继承自 IEmbeddingGenerator)

扩展方法

名称 说明
AsBuilder<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>)

创建一个新的 EmbeddingGeneratorBuilder<TInput,TEmbedding> 使用 innerGenerator 作为其内部生成器。
GenerateAndZipAsync<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken)

生成每个提供的 values 嵌入项，并生成一个列表，该列表将每个输入值与其生成的嵌入配对。
GenerateAsync<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, TInput, EmbeddingGenerationOptions, CancellationToken)

从指定 value生成嵌入。
GetRequiredService(IEmbeddingGenerator, Type, Object)

IEmbeddingGenerator<TInput,TEmbedding>请求指定类型的serviceType对象，如果一个对象不可用，则会引发异常。
GetRequiredService<TService>(IEmbeddingGenerator, Object)

IEmbeddingGenerator<TInput,TEmbedding>询问类型的TService对象，如果对象不可用，则会引发异常。
GetService<TService>(IEmbeddingGenerator, Object)

IEmbeddingGenerator<TInput,TEmbedding>请求类型的对象TService。

适用于

另请参阅