Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents. v1
Package
@google-cloud/documentaiConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of DocumentProcessorServiceClient.
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof gax.fallback
: loaded instance of |
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
documentProcessorServiceStub
documentProcessorServiceStub?: Promise<{
[name: string]: Function;
}>;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
locationsClient
locationsClient: LocationsClient;
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
batchProcessDocuments(request, options)
batchProcessDocuments(request?: protos.google.cloud.documentai.v1.IBatchProcessRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.documentai.v1.IBatchProcessResponse, protos.google.cloud.documentai.v1.IBatchProcessMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
Name | Description |
request |
protos.google.cloud.documentai.v1.IBatchProcessRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.documentai.v1.IBatchProcessResponse, protos.google.cloud.documentai.v1.IBatchProcessMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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 batch process.
*/
// const inputDocuments = {}
/**
* The overall output config for batch process.
*/
// const documentOutputConfig = {}
/**
* Whether Human Review feature should be skipped for this request. Default to
* false.
*/
// const skipHumanReview = true
// 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();
batchProcessDocuments(request, options, callback)
batchProcessDocuments(request: protos.google.cloud.documentai.v1.IBatchProcessRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IBatchProcessResponse, protos.google.cloud.documentai.v1.IBatchProcessMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IBatchProcessRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IBatchProcessResponse, protos.google.cloud.documentai.v1.IBatchProcessMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
batchProcessDocuments(request, callback)
batchProcessDocuments(request: protos.google.cloud.documentai.v1.IBatchProcessRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IBatchProcessResponse, protos.google.cloud.documentai.v1.IBatchProcessMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IBatchProcessRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IBatchProcessResponse, protos.google.cloud.documentai.v1.IBatchProcessMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
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 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 value with a of 1, corresponding to Code.CANCELLED
.
Name | Description |
request |
protos.google.longrunning.CancelOperationRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details. |
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkBatchProcessDocumentsProgress(name)
checkBatchProcessDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1.BatchProcessResponse, protos.google.cloud.documentai.v1.BatchProcessMetadata>>;
Check the status of the long running operation returned by batchProcessDocuments()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1.BatchProcessResponse, protos.google.cloud.documentai.v1.BatchProcessMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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 batch process.
*/
// const inputDocuments = {}
/**
* The overall output config for batch process.
*/
// const documentOutputConfig = {}
/**
* Whether Human Review feature should be skipped for this request. Default to
* false.
*/
// const skipHumanReview = true
// 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();
checkDeleteProcessorProgress(name)
checkDeleteProcessorProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.documentai.v1.DeleteProcessorMetadata>>;
Check the status of the long running operation returned by deleteProcessor()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.documentai.v1.DeleteProcessorMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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();
checkDeleteProcessorVersionProgress(name)
checkDeleteProcessorVersionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.documentai.v1.DeleteProcessorVersionMetadata>>;
Check the status of the long running operation returned by deleteProcessorVersion()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.documentai.v1.DeleteProcessorVersionMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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();
checkDeployProcessorVersionProgress(name)
checkDeployProcessorVersionProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1.DeployProcessorVersionResponse, protos.google.cloud.documentai.v1.DeployProcessorVersionMetadata>>;
Check the status of the long running operation returned by deployProcessorVersion()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1.DeployProcessorVersionResponse, protos.google.cloud.documentai.v1.DeployProcessorVersionMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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();
checkDisableProcessorProgress(name)
checkDisableProcessorProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1.DisableProcessorResponse, protos.google.cloud.documentai.v1.DisableProcessorMetadata>>;
Check the status of the long running operation returned by disableProcessor()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1.DisableProcessorResponse, protos.google.cloud.documentai.v1.DisableProcessorMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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();
checkEnableProcessorProgress(name)
checkEnableProcessorProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1.EnableProcessorResponse, protos.google.cloud.documentai.v1.EnableProcessorMetadata>>;
Check the status of the long running operation returned by enableProcessor()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1.EnableProcessorResponse, protos.google.cloud.documentai.v1.EnableProcessorMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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();
checkReviewDocumentProgress(name)
checkReviewDocumentProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1.ReviewDocumentResponse, protos.google.cloud.documentai.v1.ReviewDocumentOperationMetadata>>;
Check the status of the long running operation returned by reviewDocument()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1.ReviewDocumentResponse, protos.google.cloud.documentai.v1.ReviewDocumentOperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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 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();
checkSetDefaultProcessorVersionProgress(name)
checkSetDefaultProcessorVersionProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1.SetDefaultProcessorVersionResponse, protos.google.cloud.documentai.v1.SetDefaultProcessorVersionMetadata>>;
Check the status of the long running operation returned by setDefaultProcessorVersion()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1.SetDefaultProcessorVersionResponse, protos.google.cloud.documentai.v1.SetDefaultProcessorVersionMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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();
checkUndeployProcessorVersionProgress(name)
checkUndeployProcessorVersionProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1.UndeployProcessorVersionResponse, protos.google.cloud.documentai.v1.UndeployProcessorVersionMetadata>>;
Check the status of the long running operation returned by undeployProcessorVersion()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1.UndeployProcessorVersionResponse, protos.google.cloud.documentai.v1.UndeployProcessorVersionMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* 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()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createProcessor(request, options)
createProcessor(request?: protos.google.cloud.documentai.v1.ICreateProcessorRequest, options?: CallOptions): Promise<[
protos.google.cloud.documentai.v1.IProcessor,
protos.google.cloud.documentai.v1.ICreateProcessorRequest | undefined,
{} | undefined
]>;
Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
Name | Description |
request |
protos.google.cloud.documentai.v1.ICreateProcessorRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.documentai.v1.IProcessor, protos.google.cloud.documentai.v1.ICreateProcessorRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Processor]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* 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) under which to create the processor.
* Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
/**
* Required. The processor to be created, requires processor_type and display_name
* to be set. Also, the processor is under CMEK if CMEK fields are set.
*/
// const processor = {}
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callCreateProcessor() {
// Construct request
const request = {
parent,
processor,
};
// Run request
const response = await documentaiClient.createProcessor(request);
console.log(response);
}
callCreateProcessor();
createProcessor(request, options, callback)
createProcessor(request: protos.google.cloud.documentai.v1.ICreateProcessorRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1.IProcessor, protos.google.cloud.documentai.v1.ICreateProcessorRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.ICreateProcessorRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.documentai.v1.IProcessor, protos.google.cloud.documentai.v1.ICreateProcessorRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
createProcessor(request, callback)
createProcessor(request: protos.google.cloud.documentai.v1.ICreateProcessorRequest, callback: Callback<protos.google.cloud.documentai.v1.IProcessor, protos.google.cloud.documentai.v1.ICreateProcessorRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.ICreateProcessorRequest
|
callback |
Callback<protos.google.cloud.documentai.v1.IProcessor, protos.google.cloud.documentai.v1.ICreateProcessorRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteOperation(request, options, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
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
.
Name | Description |
request |
protos.google.longrunning.DeleteOperationRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details. |
callback |
Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
deleteProcessor(request, options)
deleteProcessor(request?: protos.google.cloud.documentai.v1.IDeleteProcessorRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.
Name | Description |
request |
protos.google.cloud.documentai.v1.IDeleteProcessorRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
deleteProcessor(request, options, callback)
deleteProcessor(request: protos.google.cloud.documentai.v1.IDeleteProcessorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IDeleteProcessorRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteProcessor(request, callback)
deleteProcessor(request: protos.google.cloud.documentai.v1.IDeleteProcessorRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IDeleteProcessorRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteProcessorVersion(request, options)
deleteProcessorVersion(request?: protos.google.cloud.documentai.v1.IDeleteProcessorVersionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorVersionMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes the processor version, all artifacts under the processor version will be deleted.
Name | Description |
request |
protos.google.cloud.documentai.v1.IDeleteProcessorVersionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorVersionMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
deleteProcessorVersion(request, options, callback)
deleteProcessorVersion(request: protos.google.cloud.documentai.v1.IDeleteProcessorVersionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IDeleteProcessorVersionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteProcessorVersion(request, callback)
deleteProcessorVersion(request: protos.google.cloud.documentai.v1.IDeleteProcessorVersionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IDeleteProcessorVersionRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1.IDeleteProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deployProcessorVersion(request, options)
deployProcessorVersion(request?: protos.google.cloud.documentai.v1.IDeployProcessorVersionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.documentai.v1.IDeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IDeployProcessorVersionMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deploys the processor version.
Name | Description |
request |
protos.google.cloud.documentai.v1.IDeployProcessorVersionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.documentai.v1.IDeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IDeployProcessorVersionMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
deployProcessorVersion(request, options, callback)
deployProcessorVersion(request: protos.google.cloud.documentai.v1.IDeployProcessorVersionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IDeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IDeployProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IDeployProcessorVersionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IDeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IDeployProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deployProcessorVersion(request, callback)
deployProcessorVersion(request: protos.google.cloud.documentai.v1.IDeployProcessorVersionRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IDeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IDeployProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IDeployProcessorVersionRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IDeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IDeployProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
disableProcessor(request, options)
disableProcessor(request?: protos.google.cloud.documentai.v1.IDisableProcessorRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.documentai.v1.IDisableProcessorResponse, protos.google.cloud.documentai.v1.IDisableProcessorMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Disables a processor
Name | Description |
request |
protos.google.cloud.documentai.v1.IDisableProcessorRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.documentai.v1.IDisableProcessorResponse, protos.google.cloud.documentai.v1.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
disableProcessor(request, options, callback)
disableProcessor(request: protos.google.cloud.documentai.v1.IDisableProcessorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IDisableProcessorResponse, protos.google.cloud.documentai.v1.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IDisableProcessorRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IDisableProcessorResponse, protos.google.cloud.documentai.v1.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
disableProcessor(request, callback)
disableProcessor(request: protos.google.cloud.documentai.v1.IDisableProcessorRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IDisableProcessorResponse, protos.google.cloud.documentai.v1.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IDisableProcessorRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IDisableProcessorResponse, protos.google.cloud.documentai.v1.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
enableProcessor(request, options)
enableProcessor(request?: protos.google.cloud.documentai.v1.IEnableProcessorRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.documentai.v1.IEnableProcessorResponse, protos.google.cloud.documentai.v1.IEnableProcessorMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Enables a processor
Name | Description |
request |
protos.google.cloud.documentai.v1.IEnableProcessorRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.documentai.v1.IEnableProcessorResponse, protos.google.cloud.documentai.v1.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
enableProcessor(request, options, callback)
enableProcessor(request: protos.google.cloud.documentai.v1.IEnableProcessorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IEnableProcessorResponse, protos.google.cloud.documentai.v1.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IEnableProcessorRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IEnableProcessorResponse, protos.google.cloud.documentai.v1.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
enableProcessor(request, callback)
enableProcessor(request: protos.google.cloud.documentai.v1.IEnableProcessorRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IEnableProcessorResponse, protos.google.cloud.documentai.v1.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IEnableProcessorRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IEnableProcessorResponse, protos.google.cloud.documentai.v1.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
fetchProcessorTypes(request, options)
fetchProcessorTypes(request?: protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest, options?: CallOptions): Promise<[
protos.google.cloud.documentai.v1.IFetchProcessorTypesResponse,
protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest | undefined,
{} | undefined
]>;
Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.
Name | Description |
request |
protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.documentai.v1.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [FetchProcessorTypesResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* 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 project of processor type to list.
* The available processor types may depend on the allow-listing on projects.
* Format: `projects/{project}/locations/{location}`
*/
// const parent = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callFetchProcessorTypes() {
// Construct request
const request = {
parent,
};
// Run request
const response = await documentaiClient.fetchProcessorTypes(request);
console.log(response);
}
callFetchProcessorTypes();
fetchProcessorTypes(request, options, callback)
fetchProcessorTypes(request: protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.documentai.v1.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
fetchProcessorTypes(request, callback)
fetchProcessorTypes(request: protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest, callback: Callback<protos.google.cloud.documentai.v1.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest
|
callback |
Callback<protos.google.cloud.documentai.v1.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1.IFetchProcessorTypesRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getLocation(request, options, callback)
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
Gets information about a location.
Name | Description |
request |
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions for more details. |
callback |
Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
|
Type | Description |
Promise<LocationProtos.google.cloud.location.ILocation> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Location]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
const [response] = await client.getLocation(request);
getOperation(request, options, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
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.
Name | Description |
request |
protos.google.longrunning.GetOperationRequest
The request object that will be sent. |
options |
gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details. |
callback |
Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
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]. {Promise} - The promise which resolves to an array. The first element of the array is an object representing [google.longrunning.Operation]. The promise has a method named "cancel" which cancels the ongoing API call. |
Type | Description |
Promise<[protos.google.longrunning.Operation]> |
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
getProcessor(request, options)
getProcessor(request?: protos.google.cloud.documentai.v1.IGetProcessorRequest, options?: CallOptions): Promise<[
protos.google.cloud.documentai.v1.IProcessor,
protos.google.cloud.documentai.v1.IGetProcessorRequest | undefined,
{} | undefined
]>;
Gets a processor detail.
Name | Description |
request |
protos.google.cloud.documentai.v1.IGetProcessorRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.documentai.v1.IProcessor, protos.google.cloud.documentai.v1.IGetProcessorRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Processor]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* 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.
*/
// const name = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callGetProcessor() {
// Construct request
const request = {
name,
};
// Run request
const response = await documentaiClient.getProcessor(request);
console.log(response);
}
callGetProcessor();
getProcessor(request, options, callback)
getProcessor(request: protos.google.cloud.documentai.v1.IGetProcessorRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1.IProcessor, protos.google.cloud.documentai.v1.IGetProcessorRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IGetProcessorRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.documentai.v1.IProcessor, protos.google.cloud.documentai.v1.IGetProcessorRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getProcessor(request, callback)
getProcessor(request: protos.google.cloud.documentai.v1.IGetProcessorRequest, callback: Callback<protos.google.cloud.documentai.v1.IProcessor, protos.google.cloud.documentai.v1.IGetProcessorRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IGetProcessorRequest
|
callback |
Callback<protos.google.cloud.documentai.v1.IProcessor, protos.google.cloud.documentai.v1.IGetProcessorRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getProcessorVersion(request, options)
getProcessorVersion(request?: protos.google.cloud.documentai.v1.IGetProcessorVersionRequest, options?: CallOptions): Promise<[
protos.google.cloud.documentai.v1.IProcessorVersion,
protos.google.cloud.documentai.v1.IGetProcessorVersionRequest | undefined,
{} | undefined
]>;
Gets a processor version detail.
Name | Description |
request |
protos.google.cloud.documentai.v1.IGetProcessorVersionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.documentai.v1.IProcessorVersion, protos.google.cloud.documentai.v1.IGetProcessorVersionRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [ProcessorVersion]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* 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.
*/
// const name = 'abc123'
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callGetProcessorVersion() {
// Construct request
const request = {
name,
};
// Run request
const response = await documentaiClient.getProcessorVersion(request);
console.log(response);
}
callGetProcessorVersion();
getProcessorVersion(request, options, callback)
getProcessorVersion(request: protos.google.cloud.documentai.v1.IGetProcessorVersionRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1.IProcessorVersion, protos.google.cloud.documentai.v1.IGetProcessorVersionRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IGetProcessorVersionRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.documentai.v1.IProcessorVersion, protos.google.cloud.documentai.v1.IGetProcessorVersionRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getProcessorVersion(request, callback)
getProcessorVersion(request: protos.google.cloud.documentai.v1.IGetProcessorVersionRequest, callback: Callback<protos.google.cloud.documentai.v1.IProcessorVersion, protos.google.cloud.documentai.v1.IGetProcessorVersionRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IGetProcessorVersionRequest
|
callback |
Callback<protos.google.cloud.documentai.v1.IProcessorVersion, protos.google.cloud.documentai.v1.IGetProcessorVersionRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getProjectId()
getProjectId(): Promise<string>;
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Type | Description |
void |
humanReviewConfigPath(project, location, processor)
humanReviewConfigPath(project: string, location: string, processor: string): string;
Return a fully-qualified humanReviewConfig resource name string.
Name | Description |
project |
string
|
location |
string
|
processor |
string
|
Type | Description |
string | {string} Resource name string. |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
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.
Type | Description |
Promise<{ [name: string]: Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
listLocationsAsync(request, options)
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
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.
Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<LocationProtos.google.cloud.location.ILocation> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
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.
Name | Description |
request |
protos.google.longrunning.ListOperationsRequest
The request object that will be sent. |
options |
gax.CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions]https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details. |
Type | Description |
AsyncIterable<protos.google.longrunning.ListOperationsResponse> | {Object} An iterable Object that conforms to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
listProcessors(request, options)
listProcessors(request?: protos.google.cloud.documentai.v1.IListProcessorsRequest, options?: CallOptions): Promise<[
protos.google.cloud.documentai.v1.IProcessor[],
protos.google.cloud.documentai.v1.IListProcessorsRequest | null,
protos.google.cloud.documentai.v1.IListProcessorsResponse
]>;
Lists all processors which belong to this project.
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.documentai.v1.IProcessor[], protos.google.cloud.documentai.v1.IListProcessorsRequest | null, protos.google.cloud.documentai.v1.IListProcessorsResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Processor]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listProcessors(request, options, callback)
listProcessors(request: protos.google.cloud.documentai.v1.IListProcessorsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorsRequest, protos.google.cloud.documentai.v1.IListProcessorsResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessor>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorsRequest, protos.google.cloud.documentai.v1.IListProcessorsResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessor>
|
Type | Description |
void |
listProcessors(request, callback)
listProcessors(request: protos.google.cloud.documentai.v1.IListProcessorsRequest, callback: PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorsRequest, protos.google.cloud.documentai.v1.IListProcessorsResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessor>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorsRequest
|
callback |
PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorsRequest, protos.google.cloud.documentai.v1.IListProcessorsResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessor>
|
Type | Description |
void |
listProcessorsAsync(request, options)
listProcessorsAsync(request?: protos.google.cloud.documentai.v1.IListProcessorsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.documentai.v1.IProcessor>;
Equivalent to listProcessors
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.documentai.v1.IProcessor> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/**
* 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 = await documentaiClient.listProcessorsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProcessors();
listProcessorsStream(request, options)
listProcessorsStream(request?: protos.google.cloud.documentai.v1.IListProcessorsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Transform | {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 |
listProcessorTypes(request, options)
listProcessorTypes(request?: protos.google.cloud.documentai.v1.IListProcessorTypesRequest, options?: CallOptions): Promise<[
protos.google.cloud.documentai.v1.IProcessorType[],
protos.google.cloud.documentai.v1.IListProcessorTypesRequest | null,
protos.google.cloud.documentai.v1.IListProcessorTypesResponse
]>;
Lists the processor types that exist.
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.documentai.v1.IProcessorType[], protos.google.cloud.documentai.v1.IListProcessorTypesRequest | null, protos.google.cloud.documentai.v1.IListProcessorTypesResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [ProcessorType]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listProcessorTypes(request, options, callback)
listProcessorTypes(request: protos.google.cloud.documentai.v1.IListProcessorTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorTypesRequest, protos.google.cloud.documentai.v1.IListProcessorTypesResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessorType>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorTypesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorTypesRequest, protos.google.cloud.documentai.v1.IListProcessorTypesResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessorType>
|
Type | Description |
void |
listProcessorTypes(request, callback)
listProcessorTypes(request: protos.google.cloud.documentai.v1.IListProcessorTypesRequest, callback: PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorTypesRequest, protos.google.cloud.documentai.v1.IListProcessorTypesResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessorType>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorTypesRequest
|
callback |
PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorTypesRequest, protos.google.cloud.documentai.v1.IListProcessorTypesResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessorType>
|
Type | Description |
void |
listProcessorTypesAsync(request, options)
listProcessorTypesAsync(request?: protos.google.cloud.documentai.v1.IListProcessorTypesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.documentai.v1.IProcessorType>;
Equivalent to listProcessorTypes
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.documentai.v1.IProcessorType> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/**
* 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 type to list.
* The available processor types may depend on the allow-listing on projects.
* 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 = await documentaiClient.listProcessorTypesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProcessorTypes();
listProcessorTypesStream(request, options)
listProcessorTypesStream(request?: protos.google.cloud.documentai.v1.IListProcessorTypesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Transform | {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 |
listProcessorVersions(request, options)
listProcessorVersions(request?: protos.google.cloud.documentai.v1.IListProcessorVersionsRequest, options?: CallOptions): Promise<[
protos.google.cloud.documentai.v1.IProcessorVersion[],
protos.google.cloud.documentai.v1.IListProcessorVersionsRequest | null,
protos.google.cloud.documentai.v1.IListProcessorVersionsResponse
]>;
Lists all versions of a processor.
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorVersionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.documentai.v1.IProcessorVersion[], protos.google.cloud.documentai.v1.IListProcessorVersionsRequest | null, protos.google.cloud.documentai.v1.IListProcessorVersionsResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [ProcessorVersion]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listProcessorVersions(request, options, callback)
listProcessorVersions(request: protos.google.cloud.documentai.v1.IListProcessorVersionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorVersionsRequest, protos.google.cloud.documentai.v1.IListProcessorVersionsResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessorVersion>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorVersionsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorVersionsRequest, protos.google.cloud.documentai.v1.IListProcessorVersionsResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessorVersion>
|
Type | Description |
void |
listProcessorVersions(request, callback)
listProcessorVersions(request: protos.google.cloud.documentai.v1.IListProcessorVersionsRequest, callback: PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorVersionsRequest, protos.google.cloud.documentai.v1.IListProcessorVersionsResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessorVersion>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorVersionsRequest
|
callback |
PaginationCallback<protos.google.cloud.documentai.v1.IListProcessorVersionsRequest, protos.google.cloud.documentai.v1.IListProcessorVersionsResponse | null | undefined, protos.google.cloud.documentai.v1.IProcessorVersion>
|
Type | Description |
void |
listProcessorVersionsAsync(request, options)
listProcessorVersionsAsync(request?: protos.google.cloud.documentai.v1.IListProcessorVersionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.documentai.v1.IProcessorVersion>;
Equivalent to listProcessorVersions
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorVersionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.documentai.v1.IProcessorVersion> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/**
* 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 = await documentaiClient.listProcessorVersionsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListProcessorVersions();
listProcessorVersionsStream(request, options)
listProcessorVersionsStream(request?: protos.google.cloud.documentai.v1.IListProcessorVersionsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.documentai.v1.IListProcessorVersionsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Transform | {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 |
locationPath(project, location)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Name | Description |
project |
string
|
location |
string
|
Type | Description |
string | {string} Resource name string. |
matchLocationFromHumanReviewConfigName(humanReviewConfigName)
matchLocationFromHumanReviewConfigName(humanReviewConfigName: string): string | number;
Parse the location from HumanReviewConfig resource.
Name | Description |
humanReviewConfigName |
string
A fully-qualified path representing HumanReviewConfig resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProcessorName(processorName)
matchLocationFromProcessorName(processorName: string): string | number;
Parse the location from Processor resource.
Name | Description |
processorName |
string
A fully-qualified path representing Processor resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProcessorTypeName(processorTypeName)
matchLocationFromProcessorTypeName(processorTypeName: string): string | number;
Parse the location from ProcessorType resource.
Name | Description |
processorTypeName |
string
A fully-qualified path representing ProcessorType resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProcessorVersionName(processorVersionName)
matchLocationFromProcessorVersionName(processorVersionName: string): string | number;
Parse the location from ProcessorVersion resource.
Name | Description |
processorVersionName |
string
A fully-qualified path representing ProcessorVersion resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchProcessorFromHumanReviewConfigName(humanReviewConfigName)
matchProcessorFromHumanReviewConfigName(humanReviewConfigName: string): string | number;
Parse the processor from HumanReviewConfig resource.
Name | Description |
humanReviewConfigName |
string
A fully-qualified path representing HumanReviewConfig resource. |
Type | Description |
string | number | {string} A string representing the processor. |
matchProcessorFromProcessorName(processorName)
matchProcessorFromProcessorName(processorName: string): string | number;
Parse the processor from Processor resource.
Name | Description |
processorName |
string
A fully-qualified path representing Processor resource. |
Type | Description |
string | number | {string} A string representing the processor. |
matchProcessorFromProcessorVersionName(processorVersionName)
matchProcessorFromProcessorVersionName(processorVersionName: string): string | number;
Parse the processor from ProcessorVersion resource.
Name | Description |
processorVersionName |
string
A fully-qualified path representing ProcessorVersion resource. |
Type | Description |
string | number | {string} A string representing the processor. |
matchProcessorTypeFromProcessorTypeName(processorTypeName)
matchProcessorTypeFromProcessorTypeName(processorTypeName: string): string | number;
Parse the processor_type from ProcessorType resource.
Name | Description |
processorTypeName |
string
A fully-qualified path representing ProcessorType resource. |
Type | Description |
string | number | {string} A string representing the processor_type. |
matchProcessorVersionFromProcessorVersionName(processorVersionName)
matchProcessorVersionFromProcessorVersionName(processorVersionName: string): string | number;
Parse the processor_version from ProcessorVersion resource.
Name | Description |
processorVersionName |
string
A fully-qualified path representing ProcessorVersion resource. |
Type | Description |
string | number | {string} A string representing the processor_version. |
matchProjectFromHumanReviewConfigName(humanReviewConfigName)
matchProjectFromHumanReviewConfigName(humanReviewConfigName: string): string | number;
Parse the project from HumanReviewConfig resource.
Name | Description |
humanReviewConfigName |
string
A fully-qualified path representing HumanReviewConfig resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProcessorName(processorName)
matchProjectFromProcessorName(processorName: string): string | number;
Parse the project from Processor resource.
Name | Description |
processorName |
string
A fully-qualified path representing Processor resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProcessorTypeName(processorTypeName)
matchProjectFromProcessorTypeName(processorTypeName: string): string | number;
Parse the project from ProcessorType resource.
Name | Description |
processorTypeName |
string
A fully-qualified path representing ProcessorType resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProcessorVersionName(processorVersionName)
matchProjectFromProcessorVersionName(processorVersionName: string): string | number;
Parse the project from ProcessorVersion resource.
Name | Description |
processorVersionName |
string
A fully-qualified path representing ProcessorVersion resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Name | Description |
projectName |
string
A fully-qualified path representing Project resource. |
Type | Description |
string | number | {string} A string representing the project. |
processDocument(request, options)
processDocument(request?: protos.google.cloud.documentai.v1.IProcessRequest, options?: CallOptions): Promise<[
protos.google.cloud.documentai.v1.IProcessResponse,
protos.google.cloud.documentai.v1.IProcessRequest | undefined,
{} | undefined
]>;
Processes a single document.
Name | Description |
request |
protos.google.cloud.documentai.v1.IProcessRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.documentai.v1.IProcessResponse, protos.google.cloud.documentai.v1.IProcessRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [ProcessResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* 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 = {}
/**
* A raw document content (bytes).
*/
// const rawDocument = {}
/**
* Required. The resource name of the Processor google.cloud.documentai.v1.Processor or
* ProcessorVersion google.cloud.documentai.v1.ProcessorVersion
* to use for processing. If a Processor google.cloud.documentai.v1.Processor is specified, the server will use
* its default version google.cloud.documentai.v1.Processor.default_processor_version. Format:
* `projects/{project}/locations/{location}/processors/{processor}`, or
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
*/
// const name = 'abc123'
/**
* Whether Human Review feature should be skipped for this request. Default to
* false.
*/
// const skipHumanReview = true
/**
* Specifies which fields to include in ProcessResponse's document.
* Only supports top level document and pages field so it must be in the form
* of `{document_field_name}` or `pages.{page_field_name}`.
*/
// const fieldMask = {}
// Imports the Documentai library
const {DocumentProcessorServiceClient} = require('@google-cloud/documentai').v1;
// Instantiates a client
const documentaiClient = new DocumentProcessorServiceClient();
async function callProcessDocument() {
// Construct request
const request = {
name,
};
// Run request
const response = await documentaiClient.processDocument(request);
console.log(response);
}
callProcessDocument();
processDocument(request, options, callback)
processDocument(request: protos.google.cloud.documentai.v1.IProcessRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1.IProcessResponse, protos.google.cloud.documentai.v1.IProcessRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IProcessRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.documentai.v1.IProcessResponse, protos.google.cloud.documentai.v1.IProcessRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
processDocument(request, callback)
processDocument(request: protos.google.cloud.documentai.v1.IProcessRequest, callback: Callback<protos.google.cloud.documentai.v1.IProcessResponse, protos.google.cloud.documentai.v1.IProcessRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IProcessRequest
|
callback |
Callback<protos.google.cloud.documentai.v1.IProcessResponse, protos.google.cloud.documentai.v1.IProcessRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
processorPath(project, location, processor)
processorPath(project: string, location: string, processor: string): string;
Return a fully-qualified processor resource name string.
Name | Description |
project |
string
|
location |
string
|
processor |
string
|
Type | Description |
string | {string} Resource name string. |
processorTypePath(project, location, processorType)
processorTypePath(project: string, location: string, processorType: string): string;
Return a fully-qualified processorType resource name string.
Name | Description |
project |
string
|
location |
string
|
processorType |
string
|
Type | Description |
string | {string} Resource name string. |
processorVersionPath(project, location, processor, processorVersion)
processorVersionPath(project: string, location: string, processor: string, processorVersion: string): string;
Return a fully-qualified processorVersion resource name string.
Name | Description |
project |
string
|
location |
string
|
processor |
string
|
processorVersion |
string
|
Type | Description |
string | {string} Resource name string. |
projectPath(project)
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Name | Description |
project |
string
|
Type | Description |
string | {string} Resource name string. |
reviewDocument(request, options)
reviewDocument(request?: protos.google.cloud.documentai.v1.IReviewDocumentRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.documentai.v1.IReviewDocumentResponse, protos.google.cloud.documentai.v1.IReviewDocumentOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Send a document for Human Review. The input document should be processed by the specified processor.
Name | Description |
request |
protos.google.cloud.documentai.v1.IReviewDocumentRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.documentai.v1.IReviewDocumentResponse, protos.google.cloud.documentai.v1.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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 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();
reviewDocument(request, options, callback)
reviewDocument(request: protos.google.cloud.documentai.v1.IReviewDocumentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IReviewDocumentResponse, protos.google.cloud.documentai.v1.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IReviewDocumentRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IReviewDocumentResponse, protos.google.cloud.documentai.v1.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
reviewDocument(request, callback)
reviewDocument(request: protos.google.cloud.documentai.v1.IReviewDocumentRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IReviewDocumentResponse, protos.google.cloud.documentai.v1.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IReviewDocumentRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IReviewDocumentResponse, protos.google.cloud.documentai.v1.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
setDefaultProcessorVersion(request, options)
setDefaultProcessorVersion(request?: protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionResponse, protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Set the default (active) version of a that will be used in and .
Name | Description |
request |
protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionResponse, protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
setDefaultProcessorVersion(request, options, callback)
setDefaultProcessorVersion(request: protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionResponse, protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionResponse, protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
setDefaultProcessorVersion(request, callback)
setDefaultProcessorVersion(request: protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionResponse, protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionResponse, protos.google.cloud.documentai.v1.ISetDefaultProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
undeployProcessorVersion(request, options)
undeployProcessorVersion(request?: protos.google.cloud.documentai.v1.IUndeployProcessorVersionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.documentai.v1.IUndeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IUndeployProcessorVersionMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Undeploys the processor version.
Name | Description |
request |
protos.google.cloud.documentai.v1.IUndeployProcessorVersionRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ LROperation<protos.google.cloud.documentai.v1.IUndeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IUndeployProcessorVersionMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* 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();
undeployProcessorVersion(request, options, callback)
undeployProcessorVersion(request: protos.google.cloud.documentai.v1.IUndeployProcessorVersionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IUndeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IUndeployProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IUndeployProcessorVersionRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IUndeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IUndeployProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
undeployProcessorVersion(request, callback)
undeployProcessorVersion(request: protos.google.cloud.documentai.v1.IUndeployProcessorVersionRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1.IUndeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IUndeployProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.documentai.v1.IUndeployProcessorVersionRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1.IUndeployProcessorVersionResponse, protos.google.cloud.documentai.v1.IUndeployProcessorVersionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |