LoggingEmbeddingGenerator<TInput,TEmbedding> Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.dll

Package:

Microsoft.Extensions.AI v9.1.0-preview.1.25064.3

Source:

LoggingEmbeddingGenerator.cs

A delegating embedding generator that logs embedding generation operations to an ILogger.

generic <typename TInput, typename TEmbedding>
 where TEmbedding : Embeddingpublic ref class LoggingEmbeddingGenerator : Microsoft::Extensions::AI::DelegatingEmbeddingGenerator<TInput, TEmbedding>

public class LoggingEmbeddingGenerator<TInput,TEmbedding> : Microsoft.Extensions.AI.DelegatingEmbeddingGenerator<TInput,TEmbedding> where TEmbedding : Embedding

type LoggingEmbeddingGenerator<'Input, 'Embedding (requires 'Embedding :> Embedding)> = class
    inherit DelegatingEmbeddingGenerator<'Input, 'Embedding (requires 'Embedding :> Embedding)>

Public Class LoggingEmbeddingGenerator(Of TInput, TEmbedding)
Inherits DelegatingEmbeddingGenerator(Of TInput, TEmbedding)

Type Parameters

TInput

Specifies the type of the input passed to the generator.

TEmbedding

Specifies the type of the embedding instance produced by the generator.

Inheritance

Object

DelegatingEmbeddingGenerator<TInput,TEmbedding>

LoggingEmbeddingGenerator<TInput,TEmbedding>

Constructors

LoggingEmbeddingGenerator<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, ILogger)

Initializes a new instance of the LoggingEmbeddingGenerator<TInput,TEmbedding> class.

Properties

InnerGenerator	Gets the inner IEmbeddingGenerator<TInput,TEmbedding>. (Inherited from DelegatingEmbeddingGenerator<TInput,TEmbedding>)
JsonSerializerOptions	Gets or sets JSON serialization options to use when serializing logging data.
Metadata	Gets metadata that describes the IEmbeddingGenerator<TInput,TEmbedding>. (Inherited from DelegatingEmbeddingGenerator<TInput,TEmbedding>)

Methods

Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DelegatingEmbeddingGenerator<TInput,TEmbedding>)
Dispose(Boolean)	Provides a mechanism for releasing unmanaged resources. (Inherited from DelegatingEmbeddingGenerator<TInput,TEmbedding>)
GenerateAsync(IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken)	Generates embeddings for each of the supplied values.
GetService(Type, Object)	Asks the IEmbeddingGenerator<TInput,TEmbedding> for an object of the specified type serviceType. (Inherited from DelegatingEmbeddingGenerator<TInput,TEmbedding>)

Extension Methods

AsBuilder<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>)	Creates a new EmbeddingGeneratorBuilder<TInput,TEmbedding> using innerGenerator as its inner generator.
GenerateAndZipAsync<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken)	Generates embeddings for each of the supplied values and produces a list that pairs each input value with its resulting embedding.
GenerateEmbeddingAsync<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, TInput, EmbeddingGenerationOptions, CancellationToken)	Generates an embedding from the specified value.
GetService<TInput,TEmbedding,TService>(IEmbeddingGenerator<TInput,TEmbedding>, Object)	Asks the IEmbeddingGenerator<TInput,TEmbedding> for an object of type TService.