Constructor Detail

Method Detail

• baseUrl

   final OpenAIOkHttpClient.Builder baseUrl(String baseUrl)

• checkJacksonVersionCompatibility

   final OpenAIOkHttpClient.Builder checkJacksonVersionCompatibility(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 OpenAIOkHttpClient.Builder jsonMapper(JsonMapper jsonMapper)

• streamHandlerExecutor

   final OpenAIOkHttpClient.Builder streamHandlerExecutor(Executor streamHandlerExecutor)

• clock

   final OpenAIOkHttpClient.Builder clock(Clock clock)

• headers

   final OpenAIOkHttpClient.Builder headers(Headers headers)

• headers

   final OpenAIOkHttpClient.Builder headers(Map<String, Iterable<String>> headers)

• putHeader

   final OpenAIOkHttpClient.Builder putHeader(String name, String value)

• putHeaders

   final OpenAIOkHttpClient.Builder putHeaders(String name, Iterable<String> values)

• putAllHeaders

   final OpenAIOkHttpClient.Builder putAllHeaders(Headers headers)

• putAllHeaders

   final OpenAIOkHttpClient.Builder putAllHeaders(Map<String, Iterable<String>> headers)

• replaceHeaders

   final OpenAIOkHttpClient.Builder replaceHeaders(String name, String value)

• replaceHeaders

   final OpenAIOkHttpClient.Builder replaceHeaders(String name, Iterable<String> values)

• replaceAllHeaders

   final OpenAIOkHttpClient.Builder replaceAllHeaders(Headers headers)

• replaceAllHeaders

   final OpenAIOkHttpClient.Builder replaceAllHeaders(Map<String, Iterable<String>> headers)

• removeHeaders

   final OpenAIOkHttpClient.Builder removeHeaders(String name)

• removeAllHeaders

   final OpenAIOkHttpClient.Builder removeAllHeaders(Set<String> names)

• queryParams

   final OpenAIOkHttpClient.Builder queryParams(QueryParams queryParams)

• queryParams

   final OpenAIOkHttpClient.Builder queryParams(Map<String, Iterable<String>> queryParams)

• putQueryParam

   final OpenAIOkHttpClient.Builder putQueryParam(String key, String value)

• putQueryParams

   final OpenAIOkHttpClient.Builder putQueryParams(String key, Iterable<String> values)

• putAllQueryParams

   final OpenAIOkHttpClient.Builder putAllQueryParams(QueryParams queryParams)

• putAllQueryParams

   final OpenAIOkHttpClient.Builder putAllQueryParams(Map<String, Iterable<String>> queryParams)

• replaceQueryParams

   final OpenAIOkHttpClient.Builder replaceQueryParams(String key, String value)

• replaceQueryParams

   final OpenAIOkHttpClient.Builder replaceQueryParams(String key, Iterable<String> values)

• replaceAllQueryParams

   final OpenAIOkHttpClient.Builder replaceAllQueryParams(QueryParams queryParams)

• replaceAllQueryParams

   final OpenAIOkHttpClient.Builder replaceAllQueryParams(Map<String, Iterable<String>> queryParams)

• removeQueryParams

   final OpenAIOkHttpClient.Builder removeQueryParams(String key)

• removeAllQueryParams

   final OpenAIOkHttpClient.Builder removeAllQueryParams(Set<String> keys)

• timeout

   final OpenAIOkHttpClient.Builder timeout(Timeout timeout)

• timeout

   final OpenAIOkHttpClient.Builder timeout(Duration timeout)

  Sets the maximum time allowed for a complete HTTP call, not including retries.

  See Timeout.request for more details.

  For fine-grained control, pass a Timeout object.

• maxRetries

   final OpenAIOkHttpClient.Builder maxRetries(Integer maxRetries)

• proxy

   final OpenAIOkHttpClient.Builder proxy(Proxy proxy)

• responseValidation

   final OpenAIOkHttpClient.Builder responseValidation(Boolean responseValidation)

• apiKey

   final OpenAIOkHttpClient.Builder apiKey(String apiKey)

• credential

   final OpenAIOkHttpClient.Builder credential(Credential credential)

• azureServiceVersion

   final OpenAIOkHttpClient.Builder azureServiceVersion(AzureOpenAIServiceVersion azureServiceVersion)

• organization

   final OpenAIOkHttpClient.Builder organization(String organization)

• organization

   final OpenAIOkHttpClient.Builder organization(Optional<String> organization)

  Alias for calling Builder.organization with organization.orElse(null).

• project

   final OpenAIOkHttpClient.Builder project(String project)

• project

   final OpenAIOkHttpClient.Builder project(Optional<String> project)

  Alias for calling Builder.project with project.orElse(null).

• fromEnv

   final OpenAIOkHttpClient.Builder fromEnv()

• build

   final OpenAIClient build()

  Returns an immutable instance of OpenAIClient.

  Further updates to this Builder will not mutate the returned instance.