LoggingEmbeddingGenerator<TInput,TEmbedding> Class

Reference

Definition

Namespace:: Microsoft.Extensions.AI

Assembly:: Microsoft.Extensions.AI.dll

Package:: Microsoft.Extensions.AI v9.0.0-preview.9.24556.5

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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>)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GenerateAsync(IEnumerable<TInput>, EmbeddingGenerationOptions, CancellationToken)	Generates embeddings for each of the supplied `values`.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetService<TService>(Object)	Asks the IEmbeddingGenerator<TInput,TEmbedding> for an object of type `TService`. (Inherited from DelegatingEmbeddingGenerator<TInput,TEmbedding>)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

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

Applies to

Share via