IEmbeddingGenerator<TInput,TEmbedding> Interface

Définition

Représente un générateur d’incorporations.

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

Paramètres de type

TInput

Type à partir duquel les incorporations seront générées.

Ce paramètre de type est contravariant. Cela signifie que vous pouvez utiliser le type spécifié ou tout type moins dérivé. Pour plus d’informations sur la covariance et la contravariance, consultez Covariance et contravariance dans les génériques.
TEmbedding

Type d’incorporation à générer.

Dérivé
Implémente

Remarques

Sauf indication contraire, tous les membres sont IEmbeddingGenerator<TInput,TEmbedding> thread-safe pour une utilisation simultanée. On s’attend à ce que toutes les implémentations de IEmbeddingGenerator<TInput,TEmbedding> la prise en charge soient utilisées simultanément par plusieurs requêtes. Les instances ne doivent pas être supprimées pendant que l’instance est toujours en cours d’utilisation.

Toutefois, les implémentations de IEmbeddingGenerator<TInput,TEmbedding> peuvent muter les arguments fournis GenerateAsync(IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken), par exemple en configurant l’instance d’options. Par conséquent, les consommateurs de l’interface doivent éviter d’utiliser des instances partagées de ces arguments pour les appels simultanés ou s’assurer par la construction qu’aucune instance n’est IEmbeddingGenerator<TInput,TEmbedding> utilisée qui peut utiliser cette mutation.

Méthodes

Nom Description
Dispose()

Effectue des tâches définies par l’application associées à la libération, à la libération ou à la réinitialisation des ressources non managées.

(Hérité de IDisposable)
GenerateAsync(IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken)

Génère des incorporations pour chacun des fichiers fournis values.

GetService(Type, Object)

Demande l’objet IEmbeddingGenerator<TInput,TEmbedding> du type serviceTypespécifié.

(Hérité de IEmbeddingGenerator)

Méthodes d’extension

Nom Description
AsBuilder<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>)

Crée une nouvelle EmbeddingGeneratorBuilder<TInput,TEmbedding> utilisation innerGenerator en tant que générateur interne.

GenerateAndZipAsync<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken)

Génère des incorporations pour chacun des éléments fournis values et produit une liste qui associe chaque valeur d’entrée à son incorporation résultante.

GenerateAsync<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, TInput, EmbeddingGenerationOptions, CancellationToken)

Génère une incorporation à partir de l’élément spécifié value.

GetRequiredService(IEmbeddingGenerator, Type, Object)

Demande l’objet IEmbeddingGenerator<TInput,TEmbedding> du type serviceType spécifié et lève une exception si elle n’est pas disponible.

GetRequiredService<TService>(IEmbeddingGenerator, Object)

Demande l’objet IEmbeddingGenerator<TInput,TEmbedding> de type TService et lève une exception si un objet n’est pas disponible.

GetService<TService>(IEmbeddingGenerator, Object)

Demande l’objet IEmbeddingGenerator<TInput,TEmbedding> de type TService.

S’applique à

Voir aussi