DocumentUnderstandingServiceClient

DocumentUnderstandingServiceClient

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.

Constructor

new DocumentUnderstandingServiceClient(optionsopt)

Construct an instance of DocumentUnderstandingServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

(static) port

The port for this API service.

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

(static) servicePath

The DNS address for this API service.

Methods

batchProcessDocuments(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
requests Array.<number>

Required. Individual requests for each document.
parent string

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.
options object <optional>

Call options. See CallOptions for more details.

close()

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current 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.

processDocument(request, optionsopt) → {Promise}

Processes a single document.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

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. This field is only populated when used in ProcessDocument method.
inputConfig google.cloud.documentai.v1beta2.InputConfig

Required. Information about the input file.
outputConfig google.cloud.documentai.v1beta2.OutputConfig <optional>

Optional. The desired output location. This field is only needed in BatchProcessDocumentsRequest.
documentType string

Specifies a known document type for deeper structure detection. Valid values are currently "general" and "invoice". If not provided, "general"
is used as default. If any other value is given, the request is rejected.
tableExtractionParams google.cloud.documentai.v1beta2.TableExtractionParams

Controls table extraction behavior. If not specified, the system will decide reasonable defaults.
formExtractionParams google.cloud.documentai.v1beta2.FormExtractionParams

Controls form extraction behavior. If not specified, the system will decide reasonable defaults.
entityExtractionParams google.cloud.documentai.v1beta2.EntityExtractionParams

Controls entity extraction behavior. If not specified, the system will decide reasonable defaults.
ocrParams google.cloud.documentai.v1beta2.OcrParams

Controls OCR behavior. If not specified, the system will decide reasonable defaults.
automlParams google.cloud.documentai.v1beta2.AutoMlParams

Controls AutoML model prediction behavior. AutoMlParams cannot be used together with other Params.
options object <optional>

Call options. See CallOptions for more details.