Class DocumentUnderstandingServiceClient (2.6.0)

Version 2.6.0

• 2.58.0 (latest)
• 2.57.0
• 2.56.0
• 2.55.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public class DocumentUnderstandingServiceClient implements BackgroundResource

Service Description: Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, and translation.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create()) {
   ProcessDocumentRequest request =
       ProcessDocumentRequest.newBuilder()
           .setParent("parent-995424086")
           .setInputConfig(InputConfig.newBuilder().build())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setDocumentType("documentType-1473196299")
           .setTableExtractionParams(TableExtractionParams.newBuilder().build())
           .setFormExtractionParams(FormExtractionParams.newBuilder().build())
           .setEntityExtractionParams(EntityExtractionParams.newBuilder().build())
           .setOcrParams(OcrParams.newBuilder().build())
           .setAutomlParams(AutoMlParams.newBuilder().build())
           .build();
   Document response = documentUnderstandingServiceClient.processDocument(request);
 }
 

Note: close() needs to be called on the DocumentUnderstandingServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DocumentUnderstandingServiceSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 DocumentUnderstandingServiceSettings documentUnderstandingServiceSettings =
     DocumentUnderstandingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create(documentUnderstandingServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 DocumentUnderstandingServiceSettings documentUnderstandingServiceSettings =
     DocumentUnderstandingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create(documentUnderstandingServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > DocumentUnderstandingServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final DocumentUnderstandingServiceClient create()

Constructs an instance of DocumentUnderstandingServiceClient with default settings.

Returns

Type	Description
DocumentUnderstandingServiceClient

Exceptions

Type	Description
IOException

create(DocumentUnderstandingServiceSettings settings)

public static final DocumentUnderstandingServiceClient create(DocumentUnderstandingServiceSettings settings)

Constructs an instance of DocumentUnderstandingServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	DocumentUnderstandingServiceSettings

Returns

Type	Description
DocumentUnderstandingServiceClient

Exceptions

Type	Description
IOException

create(DocumentUnderstandingServiceStub stub)

public static final DocumentUnderstandingServiceClient create(DocumentUnderstandingServiceStub stub)

Constructs an instance of DocumentUnderstandingServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DocumentUnderstandingServiceSettings).

Parameter

Name	Description
stub	DocumentUnderstandingServiceStub

Returns

Type	Description
DocumentUnderstandingServiceClient

Constructors

DocumentUnderstandingServiceClient(DocumentUnderstandingServiceSettings settings)

protected DocumentUnderstandingServiceClient(DocumentUnderstandingServiceSettings settings)

Constructs an instance of DocumentUnderstandingServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	DocumentUnderstandingServiceSettings

DocumentUnderstandingServiceClient(DocumentUnderstandingServiceStub stub)

protected DocumentUnderstandingServiceClient(DocumentUnderstandingServiceStub stub)

Parameter

Name	Description
stub	DocumentUnderstandingServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

batchProcessDocumentsAsync(BatchProcessDocumentsRequest request)

public final OperationFuture<BatchProcessDocumentsResponse,OperationMetadata> batchProcessDocumentsAsync(BatchProcessDocumentsRequest request)

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create()) {
   BatchProcessDocumentsRequest request =
       BatchProcessDocumentsRequest.newBuilder()
           .addAllRequests(new ArrayList<ProcessDocumentRequest>())
           .setParent("parent-995424086")
           .build();
   BatchProcessDocumentsResponse response =
       documentUnderstandingServiceClient.batchProcessDocumentsAsync(request).get();
 }
 

Parameter

Name	Description
request	BatchProcessDocumentsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<BatchProcessDocumentsResponse,OperationMetadata>

batchProcessDocumentsAsync(List<ProcessDocumentRequest> requests)

public final OperationFuture<BatchProcessDocumentsResponse,OperationMetadata> batchProcessDocumentsAsync(List<ProcessDocumentRequest> requests)

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create()) {
   List<ProcessDocumentRequest> requests = new ArrayList<>();
   BatchProcessDocumentsResponse response =
       documentUnderstandingServiceClient.batchProcessDocumentsAsync(requests).get();
 }
 

Parameter

Name	Description
requests	List<ProcessDocumentRequest> Required. Individual requests for each document.

Returns

Type	Description
OperationFuture<BatchProcessDocumentsResponse,OperationMetadata>

batchProcessDocumentsCallable()

public final UnaryCallable<BatchProcessDocumentsRequest,Operation> batchProcessDocumentsCallable()

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create()) {
   BatchProcessDocumentsRequest request =
       BatchProcessDocumentsRequest.newBuilder()
           .addAllRequests(new ArrayList<ProcessDocumentRequest>())
           .setParent("parent-995424086")
           .build();
   ApiFuture<Operation> future =
       documentUnderstandingServiceClient.batchProcessDocumentsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<BatchProcessDocumentsRequest,Operation>

batchProcessDocumentsOperationCallable()

public final OperationCallable<BatchProcessDocumentsRequest,BatchProcessDocumentsResponse,OperationMetadata> batchProcessDocumentsOperationCallable()

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create()) {
   BatchProcessDocumentsRequest request =
       BatchProcessDocumentsRequest.newBuilder()
           .addAllRequests(new ArrayList<ProcessDocumentRequest>())
           .setParent("parent-995424086")
           .build();
   OperationFuture<BatchProcessDocumentsResponse, OperationMetadata> future =
       documentUnderstandingServiceClient
           .batchProcessDocumentsOperationCallable()
           .futureCall(request);
   // Do something.
   BatchProcessDocumentsResponse response = future.get();
 }
 

Returns

Type	Description
OperationCallable<BatchProcessDocumentsRequest,BatchProcessDocumentsResponse,OperationMetadata>

close()

public final void close()

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final DocumentUnderstandingServiceSettings getSettings()

Returns

Type	Description
DocumentUnderstandingServiceSettings

getStub()

public DocumentUnderstandingServiceStub getStub()

Returns

Type	Description
DocumentUnderstandingServiceStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

processDocument(ProcessDocumentRequest request)

public final Document processDocument(ProcessDocumentRequest request)

Processes a single document.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create()) {
   ProcessDocumentRequest request =
       ProcessDocumentRequest.newBuilder()
           .setParent("parent-995424086")
           .setInputConfig(InputConfig.newBuilder().build())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setDocumentType("documentType-1473196299")
           .setTableExtractionParams(TableExtractionParams.newBuilder().build())
           .setFormExtractionParams(FormExtractionParams.newBuilder().build())
           .setEntityExtractionParams(EntityExtractionParams.newBuilder().build())
           .setOcrParams(OcrParams.newBuilder().build())
           .setAutomlParams(AutoMlParams.newBuilder().build())
           .build();
   Document response = documentUnderstandingServiceClient.processDocument(request);
 }
 

Parameter

Name	Description
request	ProcessDocumentRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Document

processDocumentCallable()

public final UnaryCallable<ProcessDocumentRequest,Document> processDocumentCallable()

Processes a single document.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (DocumentUnderstandingServiceClient documentUnderstandingServiceClient =
     DocumentUnderstandingServiceClient.create()) {
   ProcessDocumentRequest request =
       ProcessDocumentRequest.newBuilder()
           .setParent("parent-995424086")
           .setInputConfig(InputConfig.newBuilder().build())
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setDocumentType("documentType-1473196299")
           .setTableExtractionParams(TableExtractionParams.newBuilder().build())
           .setFormExtractionParams(FormExtractionParams.newBuilder().build())
           .setEntityExtractionParams(EntityExtractionParams.newBuilder().build())
           .setOcrParams(OcrParams.newBuilder().build())
           .setAutomlParams(AutoMlParams.newBuilder().build())
           .build();
   ApiFuture<Document> future =
       documentUnderstandingServiceClient.processDocumentCallable().futureCall(request);
   // Do something.
   Document response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ProcessDocumentRequest,Document>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()