OpenTelemetryChatClient Class

Definition

Namespace:

Microsoft.Extensions.AI

Assembly:

Microsoft.Extensions.AI.dll

Package:

Microsoft.Extensions.AI v9.3.0-preview.1.25114.11

Source:

OpenTelemetryChatClient.cs

Represents a delegating chat client that implements the OpenTelemetry Semantic Conventions for Generative AI systems.

public ref class OpenTelemetryChatClient sealed : Microsoft::Extensions::AI::DelegatingChatClient

public sealed class OpenTelemetryChatClient : Microsoft.Extensions.AI.DelegatingChatClient

type OpenTelemetryChatClient = class
    inherit DelegatingChatClient

Public NotInheritable Class OpenTelemetryChatClient
Inherits DelegatingChatClient

Inheritance

Object

DelegatingChatClient

OpenTelemetryChatClient

Remarks

This class provides an implementation of the Semantic Conventions for Generative AI systems v1.30, defined 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 client is also subject to change.

Constructors

OpenTelemetryChatClient(IChatClient, ILogger, String)

Initializes a new instance of the OpenTelemetryChatClient class.

Properties

EnableSensitiveData	Gets or sets a value indicating whether potentially sensitive information should be included in telemetry.
InnerClient	Gets the inner IChatClient. (Inherited from DelegatingChatClient)
JsonSerializerOptions	Gets or sets JSON serialization options to use when formatting chat data into telemetry strings.

Methods

Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DelegatingChatClient)
Dispose(Boolean)	Provides a mechanism for releasing unmanaged resources. (Inherited from DelegatingChatClient)
GetResponseAsync(IList<ChatMessage>, ChatOptions, CancellationToken)	Sends chat messages and returns the response.
GetService(Type, Object)	Asks the IChatClient for an object of the specified type serviceType.
GetStreamingResponseAsync(IList<ChatMessage>, ChatOptions, CancellationToken)	Sends chat messages and streams the response.

Extension Methods

AsBuilder(IChatClient)	Creates a new ChatClientBuilder using innerClient as its inner client.
GetResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)	Sends a chat message and returns the response messages.
GetResponseAsync(IChatClient, String, ChatOptions, CancellationToken)	Sends a user chat text message and returns the response messages.
GetService<TService>(IChatClient, Object)	Asks the IChatClient for an object of type TService.
GetStreamingResponseAsync(IChatClient, ChatMessage, ChatOptions, CancellationToken)	Sends a chat message and streams the response messages.
GetStreamingResponseAsync(IChatClient, String, ChatOptions, CancellationToken)	Sends a user chat text message and streams the response messages.
GetResponseAsync<T>(IChatClient, ChatMessage, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a chat message, requesting a response matching the type T.
GetResponseAsync<T>(IChatClient, ChatMessage, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a chat message, requesting a response matching the type T.
GetResponseAsync<T>(IChatClient, IList<ChatMessage>, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends chat messages, requesting a response matching the type T.
GetResponseAsync<T>(IChatClient, IList<ChatMessage>, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends chat messages, requesting a response matching the type T.
GetResponseAsync<T>(IChatClient, String, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a user chat text message, requesting a response matching the type T.
GetResponseAsync<T>(IChatClient, String, JsonSerializerOptions, ChatOptions, Nullable<Boolean>, CancellationToken)	Sends a user chat text message, requesting a response matching the type T.