FormRecognizerClientBuilder Class

Package:

com.azure.ai.formrecognizer

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.13

• java.lang.Object
• • com.azure.ai.formrecognizer.FormRecognizerClientBuilder

Implements

AzureKeyCredentialTrait<FormRecognizerClientBuilder> ConfigurationTrait<FormRecognizerClientBuilder> EndpointTrait<FormRecognizerClientBuilder> HttpTrait<FormRecognizerClientBuilder> TokenCredentialTrait<FormRecognizerClientBuilder>

public final class FormRecognizerClientBuilder
implements AzureKeyCredentialTrait<FormRecognizerClientBuilder>, ConfigurationTrait<FormRecognizerClientBuilder>, EndpointTrait<FormRecognizerClientBuilder>, HttpTrait<FormRecognizerClientBuilder>, TokenCredentialTrait<FormRecognizerClientBuilder>

This class provides a fluent builder API to help instantiation of FormRecognizerClient and FormRecognizerAsyncClient, 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 azureKeyCredential) or credential(TokenCredential 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 pipeline(HttpPipeline httpPipeline) and set the service endpoint with endpoint(String endpoint). 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();

Constructor Summary

Constructor	Description
FormRecognizerClientBuilder()	Constructs a FormRecognizerClientBuilder object.

Method Summary

Modifier and Type	Method and Description
FormRecognizerClientBuilder	addPolicy(HttpPipelinePolicy policy) Adds a HttpPipelinePolicy to apply on each request sent.
FormRecognizerClientBuilder	audience(FormRecognizerAudience audience) Sets the audience for the Azure Form Recognizer service.
FormRecognizerAsyncClient	buildAsyncClient() Creates a FormRecognizerAsyncClient based on options set in the builder.
FormRecognizerClient	buildClient() Creates a FormRecognizerClient based on options set in the builder.
FormRecognizerClientBuilder	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
FormRecognizerClientBuilder	configuration(Configuration configuration) Sets the configuration store that is used during construction of the service client.
FormRecognizerClientBuilder	credential(AzureKeyCredential azureKeyCredential) Sets the AzureKeyCredential to use when authenticating HTTP requests for this FormRecognizerClientBuilder.
FormRecognizerClientBuilder	credential(TokenCredential tokenCredential) Sets the TokenCredential used to authorize requests sent to the service.
FormRecognizerClientBuilder	endpoint(String endpoint) Sets the service endpoint for the Azure Form Recognizer instance.
static HttpLogOptions	getDefaultLogOptions() Gets the default Azure Form Recognizer client headers and query parameters that are logged by default if HTTP logging is enabled.
FormRecognizerClientBuilder	httpClient(HttpClient client) Sets the HttpClient to use for sending and receiving requests to and from the service.
FormRecognizerClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
FormRecognizerClientBuilder	pipeline(HttpPipeline httpPipeline) Sets the HttpPipeline to use for the service client.
FormRecognizerClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the client.
FormRecognizerClientBuilder	retryPolicy(RetryPolicy retryPolicy) Sets the RetryPolicy#RetryPolicy() that is used when each request is sent.
FormRecognizerClientBuilder	serviceVersion(FormRecognizerServiceVersion version) Sets the FormRecognizerServiceVersion that is used when making API requests.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FormRecognizerClientBuilder

public FormRecognizerClientBuilder()

Constructs a FormRecognizerClientBuilder object.

Method Details

addPolicy

public FormRecognizerClientBuilder addPolicy(HttpPipelinePolicy policy)

Adds a HttpPipelinePolicy 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.

Parameters:

policy - A HttpPipelinePolicy.

Returns:

The updated FormRecognizerClientBuilder object.

audience

public FormRecognizerClientBuilder audience(FormRecognizerAudience audience)

Sets the audience for the Azure Form Recognizer service. The default audience is AZURE_PUBLIC_CLOUD when unset.

Parameters:

audience - ARM management audience associated with the given form recognizer resource.

Returns:

The updated FormRecognizerClientBuilder object.

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(HttpPipeline httpPipeline) is set, then the pipeline and endpoint(String endpoint) are used to create the FormRecognizerClient. All other builder settings are ignored.

Returns:

A FormRecognizerAsyncClient with the options set from the builder.

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(HttpPipeline httpPipeline) is set, then the pipeline and endpoint(String endpoint) are used to create the FormRecognizerClient. All other builder settings are ignored.

Returns:

A FormRecognizerClient with the options set from the builder.

clientOptions

public FormRecognizerClientBuilder clientOptions(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.

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

The updated FormRecognizerClientBuilder object. HttpClientOptions

configuration

public FormRecognizerClientBuilder configuration(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 NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store used to.

Returns:

The updated FormRecognizerClientBuilder object.

credential

public FormRecognizerClientBuilder credential(AzureKeyCredential azureKeyCredential)

Sets the AzureKeyCredential to use when authenticating HTTP requests for this FormRecognizerClientBuilder.

Parameters:

azureKeyCredential - AzureKeyCredential API key credential

Returns:

The updated FormRecognizerClientBuilder object.

credential

public FormRecognizerClientBuilder 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.

Parameters:

tokenCredential - TokenCredential used to authorize requests sent to the service.

Returns:

The updated FormRecognizerClientBuilder object.

endpoint

public FormRecognizerClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure Form Recognizer instance.

Parameters:

endpoint - The URL of the Azure Form Recognizer instance service requests to and receive responses from.

Returns:

The updated FormRecognizerClientBuilder object.

getDefaultLogOptions

public static 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.

httpClient

public FormRecognizerClientBuilder httpClient(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.

Parameters:

client - The HttpClient to use for requests.

Returns:

The updated FormRecognizerClientBuilder object.

httpLogOptions

public FormRecognizerClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions 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.

Parameters:

logOptions - The HttpLogOptions to use when sending and receiving requests to and from the service.

Returns:

The updated FormRecognizerClientBuilder object.

pipeline

public FormRecognizerClientBuilder pipeline(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(String endpoint) to build FormRecognizerAsyncClient or FormRecognizerClient.

Parameters:

httpPipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

The updated FormRecognizerClientBuilder object.

retryOptions

public FormRecognizerClientBuilder retryOptions(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 retryPolicy).

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

The updated DocumentModelAdministrationClientBuilder object.

retryPolicy

public FormRecognizerClientBuilder retryPolicy(RetryPolicy retryPolicy)

Sets the RetryPolicy#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 retryOptions).

Parameters:

retryPolicy - user's retry policy applied to each request.

Returns:

The updated FormRecognizerClientBuilder 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.