IEmbeddingGenerator<TInput,TEmbedding> インターフェイス

定義

名前空間:
Microsoft.Extensions.AI
アセンブリ:
Microsoft.Extensions.AI.Abstractions.dll
パッケージ:
Microsoft.Extensions.AI.Abstractions v10.6.0
ソース:
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に求めます。

適用対象

こちらもご覧ください