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. v1beta3
Package
@google-cloud/documentai!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of DocumentProcessorServiceClient.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
documentProcessorServiceStub
documentProcessorServiceStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
operationsClient
operationsClient: gax.OperationsClient;
Property Value
Type | Description |
gax.OperationsClient | |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Property Value
Type | Description |
{
[name: string]: gax.PathTemplate;
} | |
port
static get port(): number;
The port for this API service.
Property Value
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
(code: string, message: string, warnType?: string) => void | |
Methods
batchProcessDocuments(request, options)
batchProcessDocuments(request?: protos.google.cloud.documentai.v1beta3.IBatchProcessRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IBatchProcessRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
batchProcessDocuments(request, options, callback)
batchProcessDocuments(request: protos.google.cloud.documentai.v1beta3.IBatchProcessRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IBatchProcessRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
batchProcessDocuments(request, callback)
batchProcessDocuments(request: protos.google.cloud.documentai.v1beta3.IBatchProcessRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IBatchProcessRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1beta3.IBatchProcessResponse, protos.google.cloud.documentai.v1beta3.IBatchProcessMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
checkBatchProcessDocumentsProgress(name)
checkBatchProcessDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1beta3.BatchProcessResponse, protos.google.cloud.documentai.v1beta3.BatchProcessMetadata>>;
Check the status of the long running operation returned by batchProcessDocuments()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1beta3.BatchProcessResponse, protos.google.cloud.documentai.v1beta3.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.
|
checkDeleteProcessorProgress(name)
checkDeleteProcessorProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.documentai.v1beta3.DeleteProcessorMetadata>>;
Check the status of the long running operation returned by deleteProcessor()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.documentai.v1beta3.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.
|
checkDisableProcessorProgress(name)
checkDisableProcessorProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1beta3.DisableProcessorResponse, protos.google.cloud.documentai.v1beta3.DisableProcessorMetadata>>;
Check the status of the long running operation returned by disableProcessor()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1beta3.DisableProcessorResponse, protos.google.cloud.documentai.v1beta3.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.
|
checkEnableProcessorProgress(name)
checkEnableProcessorProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1beta3.EnableProcessorResponse, protos.google.cloud.documentai.v1beta3.EnableProcessorMetadata>>;
Check the status of the long running operation returned by enableProcessor()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1beta3.EnableProcessorResponse, protos.google.cloud.documentai.v1beta3.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.
|
checkReviewDocumentProgress(name)
checkReviewDocumentProgress(name: string): Promise<LROperation<protos.google.cloud.documentai.v1beta3.ReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.ReviewDocumentOperationMetadata>>;
Check the status of the long running operation returned by reviewDocument()
.
Parameter
Name | Description |
name |
string
The operation name that will be passed.
|
Returns
Type | Description |
Promise<LROperation<protos.google.cloud.documentai.v1beta3.ReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.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.
|
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed.
|
createProcessor(request, options)
createProcessor(request?: protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest, options?: CallOptions): Promise<[protos.google.cloud.documentai.v1beta3.IProcessor, (protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.documentai.v1beta3.IProcessor, (protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest | undefined), {} | undefined]> | |
createProcessor(request, options, callback)
createProcessor(request: protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1beta3.IProcessor, protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.documentai.v1beta3.IProcessor, protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest | null | undefined, {} | null | undefined>
|
Returns
createProcessor(request, callback)
createProcessor(request: protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest, callback: Callback<protos.google.cloud.documentai.v1beta3.IProcessor, protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest
|
callback |
Callback<protos.google.cloud.documentai.v1beta3.IProcessor, protos.google.cloud.documentai.v1beta3.ICreateProcessorRequest | null | undefined, {} | null | undefined>
|
Returns
deleteProcessor(request, options)
deleteProcessor(request?: protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
deleteProcessor(request, options, callback)
deleteProcessor(request: protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
deleteProcessor(request, callback)
deleteProcessor(request: protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IDeleteProcessorRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.documentai.v1beta3.IDeleteProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
disableProcessor(request, options)
disableProcessor(request?: protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
disableProcessor(request, options, callback)
disableProcessor(request: protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
disableProcessor(request, callback)
disableProcessor(request: protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IDisableProcessorRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1beta3.IDisableProcessorResponse, protos.google.cloud.documentai.v1beta3.IDisableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
enableProcessor(request, options)
enableProcessor(request?: protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
enableProcessor(request, options, callback)
enableProcessor(request: protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
enableProcessor(request, callback)
enableProcessor(request: protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IEnableProcessorRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1beta3.IEnableProcessorResponse, protos.google.cloud.documentai.v1beta3.IEnableProcessorMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
fetchProcessorTypes(request, options)
fetchProcessorTypes(request?: protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest, options?: CallOptions): Promise<[protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, (protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest | undefined), {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, (protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest | undefined), {} | undefined]> | |
fetchProcessorTypes(request, options, callback)
fetchProcessorTypes(request: protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest | null | undefined, {} | null | undefined>
|
Returns
fetchProcessorTypes(request, callback)
fetchProcessorTypes(request: protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest, callback: Callback<protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest
|
callback |
Callback<protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesResponse, protos.google.cloud.documentai.v1beta3.IFetchProcessorTypesRequest | null | undefined, {} | null | undefined>
|
Returns
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
humanReviewConfigPath(project, location, processor)
humanReviewConfigPath(project: string, location: string, processor: string): string;
Return a fully-qualified humanReviewConfig resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
processor |
string
|
Returns
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.
Returns
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
listProcessors(request, options)
listProcessors(request?: protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, options?: CallOptions): Promise<[protos.google.cloud.documentai.v1beta3.IProcessor[], protos.google.cloud.documentai.v1beta3.IListProcessorsRequest | null, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse]>;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IListProcessorsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.documentai.v1beta3.IProcessor[], protos.google.cloud.documentai.v1beta3.IListProcessorsRequest | null, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse]> | |
listProcessors(request, options, callback)
listProcessors(request: protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse | null | undefined, protos.google.cloud.documentai.v1beta3.IProcessor>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IListProcessorsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse | null | undefined, protos.google.cloud.documentai.v1beta3.IProcessor>
|
Returns
listProcessors(request, callback)
listProcessors(request: protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, callback: PaginationCallback<protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse | null | undefined, protos.google.cloud.documentai.v1beta3.IProcessor>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IListProcessorsRequest
|
callback |
PaginationCallback<protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, protos.google.cloud.documentai.v1beta3.IListProcessorsResponse | null | undefined, protos.google.cloud.documentai.v1beta3.IProcessor>
|
Returns
listProcessorsAsync(request, options)
listProcessorsAsync(request?: protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.documentai.v1beta3.IProcessor>;
Equivalent to listProcessors
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IListProcessorsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
AsyncIterable<protos.google.cloud.documentai.v1beta3.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.
|
listProcessorsStream(request?: protos.google.cloud.documentai.v1beta3.IListProcessorsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IListProcessorsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
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 listProcessorsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
|
locationPath(project, location)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
matchLocationFromHumanReviewConfigName(humanReviewConfigName)
matchLocationFromHumanReviewConfigName(humanReviewConfigName: string): string | number;
Parse the location from HumanReviewConfig resource.
Parameter
Name | Description |
humanReviewConfigName |
string
A fully-qualified path representing HumanReviewConfig resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromProcessorName(processorName)
matchLocationFromProcessorName(processorName: string): string | number;
Parse the location from Processor resource.
Parameter
Name | Description |
processorName |
string
A fully-qualified path representing Processor resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchLocationFromProcessorTypeName(processorTypeName)
matchLocationFromProcessorTypeName(processorTypeName: string): string | number;
Parse the location from ProcessorType resource.
Parameter
Name | Description |
processorTypeName |
string
A fully-qualified path representing ProcessorType resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchProcessorFromHumanReviewConfigName(humanReviewConfigName)
matchProcessorFromHumanReviewConfigName(humanReviewConfigName: string): string | number;
Parse the processor from HumanReviewConfig resource.
Parameter
Name | Description |
humanReviewConfigName |
string
A fully-qualified path representing HumanReviewConfig resource.
|
Returns
Type | Description |
string | number | {string} A string representing the processor.
|
matchProcessorFromProcessorName(processorName)
matchProcessorFromProcessorName(processorName: string): string | number;
Parse the processor from Processor resource.
Parameter
Name | Description |
processorName |
string
A fully-qualified path representing Processor resource.
|
Returns
Type | Description |
string | number | {string} A string representing the processor.
|
matchProcessorTypeFromProcessorTypeName(processorTypeName)
matchProcessorTypeFromProcessorTypeName(processorTypeName: string): string | number;
Parse the processor_type from ProcessorType resource.
Parameter
Name | Description |
processorTypeName |
string
A fully-qualified path representing ProcessorType resource.
|
Returns
Type | Description |
string | number | {string} A string representing the processor_type.
|
matchProjectFromHumanReviewConfigName(humanReviewConfigName)
matchProjectFromHumanReviewConfigName(humanReviewConfigName: string): string | number;
Parse the project from HumanReviewConfig resource.
Parameter
Name | Description |
humanReviewConfigName |
string
A fully-qualified path representing HumanReviewConfig resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Parameter
Name | Description |
locationName |
string
A fully-qualified path representing Location resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromProcessorName(processorName)
matchProjectFromProcessorName(processorName: string): string | number;
Parse the project from Processor resource.
Parameter
Name | Description |
processorName |
string
A fully-qualified path representing Processor resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromProcessorTypeName(processorTypeName)
matchProjectFromProcessorTypeName(processorTypeName: string): string | number;
Parse the project from ProcessorType resource.
Parameter
Name | Description |
processorTypeName |
string
A fully-qualified path representing ProcessorType resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Parameter
Name | Description |
projectName |
string
A fully-qualified path representing Project resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
processDocument(request, options)
processDocument(request?: protos.google.cloud.documentai.v1beta3.IProcessRequest, options?: CallOptions): Promise<[protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IProcessRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest | undefined, {} | undefined]> | |
processDocument(request, options, callback)
processDocument(request: protos.google.cloud.documentai.v1beta3.IProcessRequest, options: CallOptions, callback: Callback<protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IProcessRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest | null | undefined, {} | null | undefined>
|
Returns
processDocument(request, callback)
processDocument(request: protos.google.cloud.documentai.v1beta3.IProcessRequest, callback: Callback<protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IProcessRequest
|
callback |
Callback<protos.google.cloud.documentai.v1beta3.IProcessResponse, protos.google.cloud.documentai.v1beta3.IProcessRequest | null | undefined, {} | null | undefined>
|
Returns
processorPath(project, location, processor)
processorPath(project: string, location: string, processor: string): string;
Return a fully-qualified processor resource name string.
Parameters
Name | Description |
project |
string
|
location |
string
|
processor |
string
|
Returns
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.
Parameters
Name | Description |
project |
string
|
location |
string
|
processorType |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
projectPath(project)
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Parameter
Name | Description |
project |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
reviewDocument(request, options)
reviewDocument(request?: protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | |
reviewDocument(request, options, callback)
reviewDocument(request: protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns
reviewDocument(request, callback)
reviewDocument(request: protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest, callback: Callback<LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.documentai.v1beta3.IReviewDocumentRequest
|
callback |
Callback<LROperation<protos.google.cloud.documentai.v1beta3.IReviewDocumentResponse, protos.google.cloud.documentai.v1beta3.IReviewDocumentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns