All Implemented Interfaces:


public final class ClientOptions

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ClientOptions.Builder`	A builder for ClientOptions.

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`PRODUCTION_URL`
`private final HttpClient`	`httpClient`
`private final Boolean`	`checkJacksonVersionCompatibility`
`private final JsonMapper`	`jsonMapper`
`private final Executor`	`streamHandlerExecutor`
`private final Clock`	`clock`
`private final Headers`	`headers`
`private final QueryParams`	`queryParams`
`private final Boolean`	`responseValidation`
`private final Timeout`	`timeout`
`private final Integer`	`maxRetries`
`private final Credential`	`credential`
`private final AzureOpenAIServiceVersion`	`azureServiceVersion`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final HttpClient`	`httpClient()`
`final Boolean`	`checkJacksonVersionCompatibility()`	Whether to throw an exception if any of the Jackson versions detected at runtime are incompatible with the SDK's minimum supported Jackson version (2.13.4).
`final JsonMapper`	`jsonMapper()`
`final Executor`	`streamHandlerExecutor()`
`final Clock`	`clock()`
`final Headers`	`headers()`
`final QueryParams`	`queryParams()`
`final Boolean`	`responseValidation()`
`final Timeout`	`timeout()`
`final Integer`	`maxRetries()`
`final Credential`	`credential()`
`final AzureOpenAIServiceVersion`	`azureServiceVersion()`
`final String`	`baseUrl()`
`final Optional<String>`	`organization()`
`final Optional<String>`	`project()`
`final Optional<String>`	`webhookSecret()`
`final ClientOptions.Builder`	`toBuilder()`
`final static ClientOptions.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ClientOptions.
`final static ClientOptions`	`fromEnv()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Method Detail

httpClient
```
 final HttpClient httpClient()
```

checkJacksonVersionCompatibility
```
 final Boolean checkJacksonVersionCompatibility()
```
Whether to throw an exception if any of the Jackson versions detected at runtime are incompatible with the SDK's minimum supported Jackson version (2.13.4).
Defaults to true. Use extreme caution when disabling this option. There is no guarantee that the SDK will work correctly when using an incompatible Jackson version.

jsonMapper
```
 final JsonMapper jsonMapper()
```

streamHandlerExecutor
```
 final Executor streamHandlerExecutor()
```

clock
```
 final Clock clock()
```

headers
```
 final Headers headers()
```

queryParams
```
 final QueryParams queryParams()
```

responseValidation
```
 final Boolean responseValidation()
```

timeout
```
 final Timeout timeout()
```

maxRetries
```
 final Integer maxRetries()
```

credential
```
 final Credential credential()
```

azureServiceVersion

 final AzureOpenAIServiceVersion azureServiceVersion()

baseUrl
```
 final String baseUrl()
```

organization
```
 final Optional<String> organization()
```

project
```
 final Optional<String> project()
```

webhookSecret
```
 final Optional<String> webhookSecret()
```

toBuilder

 final ClientOptions.Builder toBuilder()

builder
```
 final static ClientOptions.Builder builder()
```
Returns a mutable builder for constructing an instance of ClientOptions.
The following fields are required:
```
.httpClient()
.apiKey()
```

fromEnv
```
 final static ClientOptions fromEnv()
```

Class ClientOptions

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

httpClient

checkJacksonVersionCompatibility

jsonMapper

streamHandlerExecutor

clock

headers

queryParams

responseValidation

timeout

maxRetries

credential

azureServiceVersion

baseUrl

organization

project

webhookSecret

toBuilder

builder

fromEnv