Package com.azure.ai.openai

Class OpenAIClientBuilder

java.lang.Object
com.azure.ai.openai.OpenAIClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<OpenAIClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<OpenAIClientBuilder>, com.azure.core.client.traits.EndpointTrait<OpenAIClientBuilder>, com.azure.core.client.traits.HttpTrait<OpenAIClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<OpenAIClientBuilder>
public final class OpenAIClientBuilder extends Object implements com.azure.core.client.traits.HttpTrait<OpenAIClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<OpenAIClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<OpenAIClientBuilder>, com.azure.core.client.traits.AzureKeyCredentialTrait<OpenAIClientBuilder>, com.azure.core.client.traits.EndpointTrait<OpenAIClientBuilder>
A builder for creating a new instance of the OpenAIClient type.

  • Constructor Details

    • OpenAIClientBuilder

      public OpenAIClientBuilder()
      Create an instance of the OpenAIClientBuilder.

  • Method Details

    • pipeline

      public OpenAIClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)
      .
      Specified by:
      pipeline in interface com.azure.core.client.traits.HttpTrait<OpenAIClientBuilder>

    • httpClient

      public OpenAIClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
      .
      Specified by:
      httpClient in interface com.azure.core.client.traits.HttpTrait<OpenAIClientBuilder>

    • httpLogOptions

      public OpenAIClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions httpLogOptions)
      .
      Specified by:
      httpLogOptions in interface com.azure.core.client.traits.HttpTrait<OpenAIClientBuilder>

    • clientOptions

      public OpenAIClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
      .
      Specified by:
      clientOptions in interface com.azure.core.client.traits.HttpTrait<OpenAIClientBuilder>

    • retryOptions

      public OpenAIClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
      .
      Specified by:
      retryOptions in interface com.azure.core.client.traits.HttpTrait<OpenAIClientBuilder>

    • addPolicy

      public OpenAIClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy customPolicy)
      .
      Specified by:
      addPolicy in interface com.azure.core.client.traits.HttpTrait<OpenAIClientBuilder>

    • configuration

      public OpenAIClientBuilder configuration(com.azure.core.util.Configuration configuration)
      .
      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<OpenAIClientBuilder>

    • credential

      public OpenAIClientBuilder credential(com.azure.core.credential.TokenCredential tokenCredential)
      .
      Specified by:
      credential in interface com.azure.core.client.traits.TokenCredentialTrait<OpenAIClientBuilder>

    • credential

      public OpenAIClientBuilder credential(com.azure.core.credential.AzureKeyCredential azureKeyCredential)
      .
      Specified by:
      credential in interface com.azure.core.client.traits.AzureKeyCredentialTrait<OpenAIClientBuilder>

    • credential

      public OpenAIClientBuilder credential(NonAzureOpenAIKeyCredential nonAzureOpenAIKeyCredential)
      The NonAzureOpenAiKeyCredential used for public OpenAi authentication.
      Parameters:
      nonAzureOpenAIKeyCredential - The credential for non-azure public OpenAI authenticaton.
      Returns:
      the object itself.

    • endpoint

      public OpenAIClientBuilder endpoint(String endpoint)
      .
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<OpenAIClientBuilder>

    • serviceVersion

      public OpenAIClientBuilder serviceVersion(OpenAIServiceVersion serviceVersion)
      Sets Service version.
      Parameters:
      serviceVersion - the serviceVersion value.
      Returns:
      the OpenAIClientBuilder.

    • retryPolicy

      public OpenAIClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
      Sets The retry policy that will attempt to retry failed requests, if applicable.
      Parameters:
      retryPolicy - the retryPolicy value.
      Returns:
      the OpenAIClientBuilder.

    • buildAsyncClient

      public OpenAIAsyncClient buildAsyncClient()
      Builds an instance of OpenAIAsyncClient class.
      Returns:
      an instance of OpenAIAsyncClient.

    • buildClient

      public OpenAIClient buildClient()
      Builds an instance of OpenAIClient class.
      Returns:
      an instance of OpenAIClient.