Skip to content
Docs Try Aspire

ChatCompletionsClientSettings Properties

Class Properties 8 members
Represents configuration settings for Azure AI Chat Completions client.
ConnectionString Section titled ConnectionString nullable string?
Gets or sets the connection string used to connect to the AI Foundry account.
public string? ConnectionString { get; set; }
DeploymentName Section titled DeploymentName nullable string?
Gets or sets the name of the AI model deployment to use for chat completions.
public string? DeploymentName { get; set; }
Gets or sets a boolean value that indicates whether the OpenTelemetry metrics are enabled or not.
public bool DisableMetrics { get; set; }
Telemetry is recorded by Microsoft.Extensions.AI.
Gets or sets a boolean value that indicates whether the OpenTelemetry tracing is disabled or not.
public bool DisableTracing { get; set; }
Telemetry is recorded by Microsoft.Extensions.AI.
EnableSensitiveTelemetryData Section titled EnableSensitiveTelemetryData bool
Gets or sets a boolean value indicating whether potentially sensitive information should be included in telemetry.
public bool EnableSensitiveTelemetryData { get; set; }
By default, telemetry includes metadata, such as token counts, but not raw inputs and outputs, such as message content, function call arguments, and function call results. The default value can be overridden by setting the OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT environment variable to "true". Explicitly setting this property will override the environment variable.
Endpoint Section titled Endpoint nullable Uri?
Gets or sets the endpoint URI for the Azure AI service.
public Uri? Endpoint { get; set; }
Key Section titled Key nullable string?
Gets or sets the API key used for authentication with the Azure AI service.
public string? Key { get; set; }
TokenCredential Section titled TokenCredential nullable TokenCredential?
Gets or sets the token credential used for Azure authentication.
public TokenCredential? TokenCredential { get; set; }