Package com.azure.ai.formrecognizer

Class FormRecognizerClientBuilder

java.lang.Object
com.azure.ai.formrecognizer.FormRecognizerClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<FormRecognizerClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<FormRecognizerClientBuilder>, com.azure.core.client.traits.EndpointTrait<FormRecognizerClientBuilder>, com.azure.core.client.traits.HttpTrait<FormRecognizerClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<FormRecognizerClientBuilder>
public final class FormRecognizerClientBuilder extends Object implements com.azure.core.client.traits.AzureKeyCredentialTrait<FormRecognizerClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<FormRecognizerClientBuilder>, com.azure.core.client.traits.EndpointTrait<FormRecognizerClientBuilder>, com.azure.core.client.traits.HttpTrait<FormRecognizerClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<FormRecognizerClientBuilder>
This class provides a fluent builder API to help instantiation of FormRecognizerClients and FormRecognizerAsyncClients, call buildClient() buildClient} and buildAsyncClient respectively to construct an instance of the desired client.

The client needs the service endpoint of the Azure Form Recognizer to access the resource service. credential(AzureKeyCredential) or credential(TokenCredential) gives the builder access credential.

Instantiating an asynchronous Form Recognizer Client

 FormRecognizerAsyncClient formRecognizerAsyncClient = new FormRecognizerClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .buildAsyncClient();

Instantiating a synchronous Form Recognizer Client

 FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .buildClient();

Another way to construct the client is using a HttpPipeline. The pipeline gives the client an authenticated way to communicate with the service. Set the pipeline with this and set the service endpoint with this. Using a pipeline requires additional setup but allows for finer control on how the FormRecognizerClient and FormRecognizerAsyncClient is built. 

 HttpPipeline pipeline = new HttpPipelineBuilder()
     .policies(/* add policies */)
     .build();

 FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .pipeline(pipeline)
     .buildClient();
See Also:

  • Constructor Details

    • FormRecognizerClientBuilder

      public FormRecognizerClientBuilder()

  • Method Details

    • buildClient

      public FormRecognizerClient buildClient()
      Creates a FormRecognizerClient based on options set in the builder. Every time buildClient() is called a new instance of FormRecognizerClient is created.

      If pipeline is set, then the pipeline and endpoint are used to create the client. All other builder settings are ignored.

      Returns:
      A FormRecognizerClient with the options set from the builder.
      Throws:
      NullPointerException - if endpoint or credential(AzureKeyCredential) has not been set or If audience has not been set. You can set it by calling audience(FormRecognizerAudience).
      IllegalArgumentException - if endpoint cannot be parsed into a valid URL.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • buildAsyncClient

      public FormRecognizerAsyncClient buildAsyncClient()
      Creates a FormRecognizerAsyncClient based on options set in the builder. Every time buildAsyncClient() is called a new instance of FormRecognizerAsyncClient is created.

      If pipeline is set, then the pipeline and endpoint are used to create the client. All other builder settings are ignored.

      Returns:
      A FormRecognizerAsyncClient with the options set from the builder.
      Throws:
      NullPointerException - if endpoint or credential(AzureKeyCredential) has not been set or audience is null when using credential(TokenCredential). You can set the values by calling endpoint(String) and audience(FormRecognizerAudience) respectively.
      IllegalArgumentException - if endpoint cannot be parsed into a valid URL.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • endpoint

      public FormRecognizerClientBuilder endpoint(String endpoint)
      Sets the service endpoint for the Azure Form Recognizer instance.
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<FormRecognizerClientBuilder>
      Parameters:
      endpoint - The URL of the Azure Form Recognizer instance service requests to and receive responses from.
      Returns:
      The updated FormRecognizerClientBuilder object.
      Throws:
      NullPointerException - if endpoint is null
      IllegalArgumentException - if endpoint cannot be parsed into a valid URL.

    • credential

      public FormRecognizerClientBuilder credential(com.azure.core.credential.AzureKeyCredential azureKeyCredential)
      Sets the AzureKeyCredential to use when authenticating HTTP requests for this FormRecognizerClientBuilder.
      Specified by:
      credential in interface com.azure.core.client.traits.AzureKeyCredentialTrait<FormRecognizerClientBuilder>
      Parameters:
      azureKeyCredential - AzureKeyCredential API key credential
      Returns:
      The updated FormRecognizerClientBuilder object.
      Throws:
      NullPointerException - If azureKeyCredential is null.

    • credential

      public FormRecognizerClientBuilder credential(com.azure.core.credential.TokenCredential tokenCredential)
      Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.
      Specified by:
      credential in interface com.azure.core.client.traits.TokenCredentialTrait<FormRecognizerClientBuilder>
      Parameters:
      tokenCredential - TokenCredential used to authorize requests sent to the service.
      Returns:
      The updated FormRecognizerClientBuilder object.
      Throws:
      NullPointerException - If tokenCredential is null.

    • httpLogOptions

      public FormRecognizerClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
      Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      httpLogOptions in interface com.azure.core.client.traits.HttpTrait<FormRecognizerClientBuilder>
      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      The updated FormRecognizerClientBuilder object.

    • getDefaultLogOptions

      public static com.azure.core.http.policy.HttpLogOptions getDefaultLogOptions()
      Gets the default Azure Form Recognizer client headers and query parameters that are logged by default if HTTP logging is enabled.
      Returns:
      The default HttpLogOptions allow list.

    • clientOptions

      public FormRecognizerClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
      Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      clientOptions in interface com.azure.core.client.traits.HttpTrait<FormRecognizerClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated FormRecognizerClientBuilder object.
      See Also:
      • HttpClientOptions

    • addPolicy

      public FormRecognizerClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
      Adds a pipeline policy to apply on each request sent.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      addPolicy in interface com.azure.core.client.traits.HttpTrait<FormRecognizerClientBuilder>
      Parameters:
      policy - A pipeline policy.
      Returns:
      The updated FormRecognizerClientBuilder object.
      Throws:
      NullPointerException - If policy is null.

    • httpClient

      public FormRecognizerClientBuilder httpClient(com.azure.core.http.HttpClient client)
      Sets the HttpClient to use for sending and receiving requests to and from the service.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      httpClient in interface com.azure.core.client.traits.HttpTrait<FormRecognizerClientBuilder>
      Parameters:
      client - The HttpClient to use for requests.
      Returns:
      The updated FormRecognizerClientBuilder object.

    • pipeline

      public FormRecognizerClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
      Sets the HttpPipeline to use for the service client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      If pipeline is set, all other settings are ignored, aside from endpoint to build FormRecognizerAsyncClient or FormRecognizerClient.

      Specified by:
      pipeline in interface com.azure.core.client.traits.HttpTrait<FormRecognizerClientBuilder>
      Parameters:
      httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      The updated FormRecognizerClientBuilder object.

    • configuration

      public FormRecognizerClientBuilder configuration(com.azure.core.util.Configuration configuration)
      Sets the configuration store that is used during construction of the service client.

      The default configuration store is a clone of the global configuration store, use Configuration.NONE to bypass using configuration settings during construction.

      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<FormRecognizerClientBuilder>
      Parameters:
      configuration - The configuration store used to.
      Returns:
      The updated FormRecognizerClientBuilder object.

    • retryPolicy

      public FormRecognizerClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
      Sets the RetryPolicy() that is used when each request is sent.

      The default retry policy will be used if not provided buildAsyncClient() to build FormRecognizerAsyncClient or FormRecognizerClient.

      Setting this is mutually exclusive with using retryOptions(RetryOptions).

      Parameters:
      retryPolicy - user's retry policy applied to each request.
      Returns:
      The updated FormRecognizerClientBuilder object.

    • retryOptions

      public FormRecognizerClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
      Sets the RetryOptions for all the requests made through the client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Setting this is mutually exclusive with using retryPolicy(RetryPolicy).

      Specified by:
      retryOptions in interface com.azure.core.client.traits.HttpTrait<FormRecognizerClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      The updated DocumentModelAdministrationClientBuilder object.

    • serviceVersion

      public FormRecognizerClientBuilder serviceVersion(FormRecognizerServiceVersion version)
      Sets the FormRecognizerServiceVersion that is used when making API requests.

      If a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version the client library will have the result of potentially moving to a newer service version.

      Parameters:
      version - FormRecognizerServiceVersion of the service to be used when making requests.
      Returns:
      The updated FormRecognizerClientBuilder object.

    • audience

      public FormRecognizerClientBuilder audience(FormRecognizerAudience audience)
      Sets the audience for the Azure Form Recognizer service. The default audience is FormRecognizerAudience.AZURE_PUBLIC_CLOUD when unset.
      Parameters:
      audience - ARM management audience associated with the given form recognizer resource.
      Returns:
      The updated FormRecognizerClientBuilder object.
      Throws:
      NullPointerException - If audience is null.