Package com.azure.ai.formrecognizer

Class DocumentAnalysisClientBuilder

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

The client needs the service endpoint of the Azure Document Analysis to access the resource service and the audience for the service region that you want to target. credential(AzureKeyCredential) or credential(TokenCredential) gives the builder access credential.

Instantiating an asynchronous Document Analysis Client

 DocumentAnalysisAsyncClient documentAnalysisAsyncClient = new DocumentAnalysisClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .buildAsyncClient();

Instantiating a synchronous Document Analysis Client

 DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()
     .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 DocumentAnalysisClient and DocumentAnalysisAsyncClient is built. 

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

 DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .pipeline(pipeline)
     .buildClient();
See Also: