AzureOpenAIClientOptions Class

  • Reference

Definition

Namespace:
Azure.AI.OpenAI
Assembly:
Azure.AI.OpenAI.dll
Package:
Azure.AI.OpenAI v2.0.0-beta.5
Source:
AzureOpenAIClientOptions.cs

Defines the scenario-independent, client-level options for the Azure-specific OpenAI client.

public class AzureOpenAIClientOptions : System.ClientModel.Primitives.ClientPipelineOptions
type AzureOpenAIClientOptions = class
    inherit ClientPipelineOptions
Public Class AzureOpenAIClientOptions
Inherits ClientPipelineOptions
Inheritance
Object
ClientPipelineOptions
AzureOpenAIClientOptions

Constructors

AzureOpenAIClientOptions(AzureOpenAIClientOptions+ServiceVersion)

Initializes a new instance of AzureOpenAIClientOptions

Properties

ApplicationId

An optional application ID to use as part of the request User-Agent header.
Audience

The authorization audience to use when authenticating with Azure authentication tokens
NetworkTimeout

The timeout applied to an individual network operation.

(Inherited from ClientPipelineOptions)
RetryPolicy

Gets or sets the PipelinePolicy to be used by the ClientPipeline for handling retry logic.

(Inherited from ClientPipelineOptions)
Transport

Gets or sets the PipelineTransport to be used by the ClientPipeline for sending and receiving HTTP messages.

(Inherited from ClientPipelineOptions)

Methods

AddPolicy(PipelinePolicy, PipelinePosition)

Adds the provided PipelinePolicy to the default ClientPipeline.

(Inherited from ClientPipelineOptions)
AssertNotFrozen()

Assert that Freeze() has not been called on this ClientPipelineOptions instance.

(Inherited from ClientPipelineOptions)
Freeze()

Freeze this instance of ClientPipelineOptions. After this method has been called, any attempt to set properties on the instance or call methods that would change its state will throw InvalidOperationException.

(Inherited from ClientPipelineOptions)

Applies to