Constructor
new DocumentUnderstandingServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of DocumentUnderstandingServiceClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service.
apiEndpoint
The DNS address for this API service - same as servicePath.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
(async) checkBatchProcessDocumentsProgress(name) → {Promise}
Check the status of the long running operation returned by batchProcessDocuments()
.
Parameters:
Name | Type | Description |
---|---|---|
name |
String |
The operation name that will be passed. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Individual requests for each document.
*/
// const requests = [1,2,3,4]
/**
* Target project and location to make a call.
* Format: `projects/{project-id}/locations/{location-id}`.
* If no location is specified, a region will be chosen automatically.
*/
// const parent = 'abc123'
// Imports the Documentai library
const {DocumentUnderstandingServiceClient} = require('@google-cloud/documentai').v1beta1;
// Instantiates a client
const documentaiClient = new DocumentUnderstandingServiceClient();
async function callBatchProcessDocuments() {
// Construct request
const request = {
requests,
};
// Run request
const [operation] = await documentaiClient.batchProcessDocuments(request);
const [response] = await operation.promise();
console.log(response);
}
callBatchProcessDocuments();
close() → {Promise}
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves when the client is closed. |
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to an authenticated service stub. |