Constructor
new DocumentProcessorServiceClient(optionsopt, gaxInstanceopt)
Construct an instance of DocumentProcessorServiceClient.
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
cancelOperation(request, optionsopt, callbackopt) → {Promise}
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of
1, corresponding to Code.CANCELLED
.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```
(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. The resource name of
* Processor google.cloud.documentai.v1.Processor or
* ProcessorVersion google.cloud.documentai.v1.ProcessorVersion.
* Format: `projects/{project}/locations/{location}/processors/{processor}`,
* or
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
*/
// const name = 'abc123'
/**
* The input documents for the
* BatchProcessDocuments google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments
* method.
*/
// const inputDocuments = {}
/**
* The output configuration for the
* BatchProcessDocuments google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments
* method.
*/
// const documentOutputConfig = {}
/**
* Whether human review should be skipped for this request. Default to
* `false`.
*/
// const skipHumanReview = true
/**
* Inference-time options for the process API
*/
// const processOptions = {}
/**
* Optional. The labels with user-defined metadata for the request.
* Label keys and values can be no longer than 63 characters
* (Unicode codepoints) and can only contain lowercase letters, numeric
* characters, underscores, and dashes. International characters are allowed.
* Label values are optional. Label keys must start with a letter.
*/
// const labels = [1,2,3,4]
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callBatchProcessDocuments() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await documentaiClient.batchProcessDocuments(request);
const [response] = await operation.promise();
console.log(response);
}
callBatchProcessDocuments();
(async) checkDeleteProcessorProgress(name) → {Promise}
Check the status of the long running operation returned by deleteProcessor()
.
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. The processor resource name to be deleted.
*/
// const name = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callDeleteProcessor() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await documentaiClient.deleteProcessor(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteProcessor();
(async) checkDeleteProcessorVersionProgress(name) → {Promise}
Check the status of the long running operation returned by deleteProcessorVersion()
.
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. The processor version resource name to be deleted.
*/
// const name = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callDeleteProcessorVersion() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await documentaiClient.deleteProcessorVersion(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteProcessorVersion();
(async) checkDeployProcessorVersionProgress(name) → {Promise}
Check the status of the long running operation returned by deployProcessorVersion()
.
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. The processor version resource name to be deployed.
*/
// const name = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callDeployProcessorVersion() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await documentaiClient.deployProcessorVersion(request);
const [response] = await operation.promise();
console.log(response);
}
callDeployProcessorVersion();
(async) checkDisableProcessorProgress(name) → {Promise}
Check the status of the long running operation returned by disableProcessor()
.
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. The processor resource name to be disabled.
*/
// const name = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callDisableProcessor() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await documentaiClient.disableProcessor(request);
const [response] = await operation.promise();
console.log(response);
}
callDisableProcessor();
(async) checkEnableProcessorProgress(name) → {Promise}
Check the status of the long running operation returned by enableProcessor()
.
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. The processor resource name to be enabled.
*/
// const name = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callEnableProcessor() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await documentaiClient.enableProcessor(request);
const [response] = await operation.promise();
console.log(response);
}
callEnableProcessor();
(async) checkEvaluateProcessorVersionProgress(name) → {Promise}
Check the status of the long running operation returned by evaluateProcessorVersion()
.
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. The resource name of the
* ProcessorVersion google.cloud.documentai.v1.ProcessorVersion to
* evaluate.
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
*/
// const processorVersion = 'abc123'
/**
* Optional. The documents used in the evaluation. If unspecified, use the
* processor's dataset as evaluation input.
*/
// const evaluationDocuments = {}
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callEvaluateProcessorVersion() {
// Construct request
const request = {
processorVersion,
};
// Run request
const [operation] = await documentaiClient.evaluateProcessorVersion(request);
const [response] = await operation.promise();
console.log(response);
}
callEvaluateProcessorVersion();
(async) checkReviewDocumentProgress(name) → {Promise}
Check the status of the long running operation returned by reviewDocument()
.
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.
*/
/**
* An inline document proto.
*/
// const inlineDocument = {}
/**
* Required. The resource name of the
* HumanReviewConfig google.cloud.documentai.v1.HumanReviewConfig that the
* document will be reviewed with.
*/
// const humanReviewConfig = 'abc123'
/**
* Whether the validation should be performed on the ad-hoc review request.
*/
// const enableSchemaValidation = true
/**
* The priority of the human review task.
*/
// const priority = {}
/**
* The document schema of the human review task.
*/
// const documentSchema = {}
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callReviewDocument() {
// Construct request
const request = {
humanReviewConfig,
};
// Run request
const [operation] = await documentaiClient.reviewDocument(request);
const [response] = await operation.promise();
console.log(response);
}
callReviewDocument();
(async) checkSetDefaultProcessorVersionProgress(name) → {Promise}
Check the status of the long running operation returned by setDefaultProcessorVersion()
.
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. The resource name of the
* Processor google.cloud.documentai.v1.Processor to change default
* version.
*/
// const processor = 'abc123'
/**
* Required. The resource name of child
* ProcessorVersion google.cloud.documentai.v1.ProcessorVersion to use as
* default. Format:
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`
*/
// const defaultProcessorVersion = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callSetDefaultProcessorVersion() {
// Construct request
const request = {
processor,
defaultProcessorVersion,
};
// Run request
const [operation] = await documentaiClient.setDefaultProcessorVersion(request);
const [response] = await operation.promise();
console.log(response);
}
callSetDefaultProcessorVersion();
(async) checkTrainProcessorVersionProgress(name) → {Promise}
Check the status of the long running operation returned by trainProcessorVersion()
.
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.
*/
/**
* Options to control Custom Document Extraction (CDE) Processor.
*/
// const customDocumentExtractionOptions = {}
/**
* Options to control foundation model tuning of a processor.
*/
// const foundationModelTuningOptions = {}
/**
* Required. The parent (project, location and processor) to create the new
* version for. Format:
* `projects/{project}/locations/{location}/processors/{processor}`.
*/
// const parent = 'abc123'
/**
* Required. The processor version to be created.
*/
// const processorVersion = {}
/**
* Optional. The schema the processor version will be trained with.
*/
// const documentSchema = {}
/**
* Optional. The input data used to train the
* ProcessorVersion google.cloud.documentai.v1.ProcessorVersion.
*/
// const inputData = {}
/**
* Optional. The processor version to use as a base for training. This
* processor version must be a child of `parent`. Format:
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
*/
// const baseProcessorVersion = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callTrainProcessorVersion() {
// Construct request
const request = {
parent,
processorVersion,
};
// Run request
const [operation] = await documentaiClient.trainProcessorVersion(request);
const [response] = await operation.promise();
console.log(response);
}
callTrainProcessorVersion();
(async) checkUndeployProcessorVersionProgress(name) → {Promise}
Check the status of the long running operation returned by undeployProcessorVersion()
.
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. The processor version resource name to be undeployed.
*/
// const name = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callUndeployProcessorVersion() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await documentaiClient.undeployProcessorVersion(request);
const [response] = await operation.promise();
console.log(response);
}
callUndeployProcessorVersion();
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. |
deleteOperation(request, optionsopt, callbackopt) → {Promise}
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```
evaluationPath(project, location, processor, processor_version, evaluation) → {string}
Return a fully-qualified evaluation resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
processor |
string | |
processor_version |
string | |
evaluation |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
getLocation(request, optionsopt) → {Promise}
Gets information about a location.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Promise |
|
getOperation(request, optionsopt, callbackopt) → {Promise}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing google.longrunning.Operation. |
Returns:
Type | Description |
---|---|
Promise |
|
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
humanReviewConfigPath(project, location, processor) → {string}
Return a fully-qualified humanReviewConfig resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
processor |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
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. |
listEvaluationsAsync(request, optionsopt) → {Object}
Equivalent to listEvaluations
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Evaluation. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
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. The resource name of the
* ProcessorVersion google.cloud.documentai.v1.ProcessorVersion to list
* evaluations for.
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
*/
// const parent = 'abc123'
/**
* The standard list page size.
* If unspecified, at most `5` evaluations are returned.
* The maximum value is `100`. Values above `100` are coerced to `100`.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListEvaluations` call.
* Provide this to retrieve the subsequent page.
*/
// const pageToken = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callListEvaluations() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = documentaiClient.listEvaluationsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListEvaluations();
listEvaluationsStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing Evaluation on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listLocationsAsync(request, optionsopt) → {Object}
Lists information about the supported locations for this service. Returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
```
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
```
listOperationsAsync(request, optionsopt) → {Object}
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that conforms to iteration protocols. |
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```
listProcessorTypesAsync(request, optionsopt) → {Object}
Equivalent to listProcessorTypes
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ProcessorType. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
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. The location of processor types to list.
* Format: `projects/{project}/locations/{location}`.
*/
// const parent = 'abc123'
/**
* The maximum number of processor types to return.
* If unspecified, at most `100` processor types will be returned.
* The maximum value is `500`. Values above `500` will be coerced to `500`.
*/
// const pageSize = 1234
/**
* Used to retrieve the next page of results, empty if at the end of the list.
*/
// const pageToken = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callListProcessorTypes() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = documentaiClient.listProcessorTypesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProcessorTypes();
listProcessorTypesStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing ProcessorType on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listProcessorVersionsAsync(request, optionsopt) → {Object}
Equivalent to listProcessorVersions
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ProcessorVersion. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
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. The parent (project, location and processor) to list all
* versions. Format:
* `projects/{project}/locations/{location}/processors/{processor}`
*/
// const parent = 'abc123'
/**
* The maximum number of processor versions to return.
* If unspecified, at most `10` processor versions will be returned.
* The maximum value is `20`. Values above `20` will be coerced to `20`.
*/
// const pageSize = 1234
/**
* We will return the processor versions sorted by creation time. The page
* token will point to the next processor version.
*/
// const pageToken = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callListProcessorVersions() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = documentaiClient.listProcessorVersionsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProcessorVersions();
listProcessorVersionsStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing ProcessorVersion on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listProcessorsAsync(request, optionsopt) → {Object}
Equivalent to listProcessors
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Processor. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
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. The parent (project and location) which owns this collection of
* Processors. Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* The maximum number of processors to return.
* If unspecified, at most `50` processors will be returned.
* The maximum value is `100`. Values above `100` will be coerced to `100`.
*/
// const pageSize = 1234
/**
* We will return the processors sorted by creation time. The page token
* will point to the next processor.
*/
// const pageToken = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callListProcessors() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = documentaiClient.listProcessorsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProcessors();
listProcessorsStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing Processor on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
locationPath(project, location) → {string}
Return a fully-qualified location resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
matchEvaluationFromEvaluationName(evaluationName) → {string}
Parse the evaluation from Evaluation resource.
Parameters:
Name | Type | Description |
---|---|---|
evaluationName |
string |
A fully-qualified path representing Evaluation resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the evaluation. |
matchLocationFromEvaluationName(evaluationName) → {string}
Parse the location from Evaluation resource.
Parameters:
Name | Type | Description |
---|---|---|
evaluationName |
string |
A fully-qualified path representing Evaluation resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromHumanReviewConfigName(humanReviewConfigName) → {string}
Parse the location from HumanReviewConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
humanReviewConfigName |
string |
A fully-qualified path representing HumanReviewConfig resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromLocationName(locationName) → {string}
Parse the location from Location resource.
Parameters:
Name | Type | Description |
---|---|---|
locationName |
string |
A fully-qualified path representing Location resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromProcessorName(processorName) → {string}
Parse the location from Processor resource.
Parameters:
Name | Type | Description |
---|---|---|
processorName |
string |
A fully-qualified path representing Processor resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromProcessorTypeName(processorTypeName) → {string}
Parse the location from ProcessorType resource.
Parameters:
Name | Type | Description |
---|---|---|
processorTypeName |
string |
A fully-qualified path representing ProcessorType resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchLocationFromProcessorVersionName(processorVersionName) → {string}
Parse the location from ProcessorVersion resource.
Parameters:
Name | Type | Description |
---|---|---|
processorVersionName |
string |
A fully-qualified path representing ProcessorVersion resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchProcessorFromEvaluationName(evaluationName) → {string}
Parse the processor from Evaluation resource.
Parameters:
Name | Type | Description |
---|---|---|
evaluationName |
string |
A fully-qualified path representing Evaluation resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the processor. |
matchProcessorFromHumanReviewConfigName(humanReviewConfigName) → {string}
Parse the processor from HumanReviewConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
humanReviewConfigName |
string |
A fully-qualified path representing HumanReviewConfig resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the processor. |
matchProcessorFromProcessorName(processorName) → {string}
Parse the processor from Processor resource.
Parameters:
Name | Type | Description |
---|---|---|
processorName |
string |
A fully-qualified path representing Processor resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the processor. |
matchProcessorFromProcessorVersionName(processorVersionName) → {string}
Parse the processor from ProcessorVersion resource.
Parameters:
Name | Type | Description |
---|---|---|
processorVersionName |
string |
A fully-qualified path representing ProcessorVersion resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the processor. |
matchProcessorTypeFromProcessorTypeName(processorTypeName) → {string}
Parse the processor_type from ProcessorType resource.
Parameters:
Name | Type | Description |
---|---|---|
processorTypeName |
string |
A fully-qualified path representing ProcessorType resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the processor_type. |
matchProcessorVersionFromEvaluationName(evaluationName) → {string}
Parse the processor_version from Evaluation resource.
Parameters:
Name | Type | Description |
---|---|---|
evaluationName |
string |
A fully-qualified path representing Evaluation resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the processor_version. |
matchProcessorVersionFromProcessorVersionName(processorVersionName) → {string}
Parse the processor_version from ProcessorVersion resource.
Parameters:
Name | Type | Description |
---|---|---|
processorVersionName |
string |
A fully-qualified path representing ProcessorVersion resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the processor_version. |
matchProjectFromEvaluationName(evaluationName) → {string}
Parse the project from Evaluation resource.
Parameters:
Name | Type | Description |
---|---|---|
evaluationName |
string |
A fully-qualified path representing Evaluation resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromHumanReviewConfigName(humanReviewConfigName) → {string}
Parse the project from HumanReviewConfig resource.
Parameters:
Name | Type | Description |
---|---|---|
humanReviewConfigName |
string |
A fully-qualified path representing HumanReviewConfig resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromLocationName(locationName) → {string}
Parse the project from Location resource.
Parameters:
Name | Type | Description |
---|---|---|
locationName |
string |
A fully-qualified path representing Location resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProcessorName(processorName) → {string}
Parse the project from Processor resource.
Parameters:
Name | Type | Description |
---|---|---|
processorName |
string |
A fully-qualified path representing Processor resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProcessorTypeName(processorTypeName) → {string}
Parse the project from ProcessorType resource.
Parameters:
Name | Type | Description |
---|---|---|
processorTypeName |
string |
A fully-qualified path representing ProcessorType resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProcessorVersionName(processorVersionName) → {string}
Parse the project from ProcessorVersion resource.
Parameters:
Name | Type | Description |
---|---|---|
processorVersionName |
string |
A fully-qualified path representing ProcessorVersion resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectName(projectName) → {string}
Parse the project from Project resource.
Parameters:
Name | Type | Description |
---|---|---|
projectName |
string |
A fully-qualified path representing Project resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
processorPath(project, location, processor) → {string}
Return a fully-qualified processor resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
processor |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
processorTypePath(project, location, processor_type) → {string}
Return a fully-qualified processorType resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
processor_type |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
processorVersionPath(project, location, processor, processor_version) → {string}
Return a fully-qualified processorVersion resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
location |
string | |
processor |
string | |
processor_version |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectPath(project) → {string}
Return a fully-qualified project resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |