OpenTelemetryEmbeddingGenerator<TInput,TEmbedding> Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.dll

Package:

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

A delegating embedding generator that implements the OpenTelemetry Semantic Conventions for Generative AI systems.

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

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

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

Public NotInheritable Class OpenTelemetryEmbeddingGenerator(Of TInput, TEmbedding)
Inherits DelegatingEmbeddingGenerator(Of TInput, TEmbedding)

Type Parameters

TInput

The type of input used to produce embeddings.

TEmbedding

The type of embedding generated.

Inheritance

Object

DelegatingEmbeddingGenerator<TInput,TEmbedding>

OpenTelemetryEmbeddingGenerator<TInput,TEmbedding>

Remarks

The draft specification this follows is available at https://opentelemetry.io/docs/specs/semconv/gen-ai/. The specification is still experimental and subject to change; as such, the telemetry output by this generator is also subject to change.

Constructors

OpenTelemetryEmbeddingGenerator<TInput,TEmbedding>(IEmbeddingGenerator<TInput,TEmbedding>, ILogger, String)

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

Properties

InnerGenerator	Gets the inner IEmbeddingGenerator<TInput,TEmbedding>. (Inherited from DelegatingEmbeddingGenerator<TInput,TEmbedding>)
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.