OpenAIClientOptions interface

Package:

@azure/openai

Extends

ClientOptions

Inherited Properties

additionalPolicies	Additional policies to include in the HTTP pipeline.
allowInsecureConnection	Option to allow calling http (insecure) endpoints
apiVersion	Options for setting a custom apiVersion.
baseUrl	Base url for the client
credentials	Credentials information
endpoint	Endpoint for the client
httpClient	Specify a custom HttpClient when making requests.
loggingOptions	Options to configure request/response logging.
proxyOptions	Options to configure a proxy for outgoing requests.
redirectOptions	Options for how redirect responses are handled.
retryOptions	Options that control how to retry failed requests.
telemetryOptions	Options for setting common telemetry and tracing info to outgoing requests.
tlsOptions	Options for configuring TLS authentication
userAgentOptions	Options for adding user agent details to outgoing requests.

Inherited Property Details

additionalPolicies

Additional policies to include in the HTTP pipeline.

additionalPolicies?: AdditionalPolicyConfig[]

Property Value

AdditionalPolicyConfig[]

Inherited From ClientOptions.additionalPolicies

allowInsecureConnection

Option to allow calling http (insecure) endpoints

allowInsecureConnection?: boolean

Property Value

boolean

Inherited From ClientOptions.allowInsecureConnection

apiVersion

Options for setting a custom apiVersion.

apiVersion?: string

Property Value

string

Inherited From ClientOptions.apiVersion

baseUrl

Warning

This API is now deprecated.

This property is deprecated and will be removed soon, please use endpoint instead

Base url for the client

baseUrl?: string

Property Value

string

Inherited From ClientOptions.baseUrl

credentials

Credentials information

credentials?: { apiKeyHeaderName?: string, scopes?: string[] }

Property Value

{ apiKeyHeaderName?: string, scopes?: string[] }

Inherited From ClientOptions.credentials

endpoint

Endpoint for the client

endpoint?: string

Property Value

string

Inherited From ClientOptions.endpoint

httpClient

Specify a custom HttpClient when making requests.

httpClient?: HttpClient

Property Value

HttpClient

Inherited From ClientOptions.httpClient

loggingOptions

Options to configure request/response logging.

loggingOptions?: LogPolicyOptions

Property Value

LogPolicyOptions

Inherited From ClientOptions.loggingOptions

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

ProxySettings

Inherited From ClientOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

RedirectPolicyOptions

Inherited From ClientOptions.redirectOptions

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

PipelineRetryOptions

Inherited From ClientOptions.retryOptions

telemetryOptions

Options for setting common telemetry and tracing info to outgoing requests.

telemetryOptions?: TelemetryOptions

Property Value

TelemetryOptions

Inherited From ClientOptions.telemetryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

TlsSettings

Inherited From ClientOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions

Inherited From ClientOptions.userAgentOptions