DocumentProcessorService

google.cloud.documentai.v1. DocumentProcessorService

Represents a DocumentProcessorService

Constructor

new DocumentProcessorService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new DocumentProcessorService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {DocumentProcessorService}

Creates new DocumentProcessorService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
DocumentProcessorService

RPC service. Useful where requests and/or responses are streamed.

batchProcessDocuments(request, callback) → {undefined}

Calls BatchProcessDocuments.

Parameters:
Name Type Description
request google.cloud.documentai.v1.IBatchProcessRequest

BatchProcessRequest message or plain object

callback google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocumentsCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

batchProcessDocuments(request) → {Promise.<google.longrunning.Operation>}

Calls BatchProcessDocuments.

Parameters:
Name Type Description
request google.cloud.documentai.v1.IBatchProcessRequest

BatchProcessRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

processDocument(request, callback) → {undefined}

Calls ProcessDocument.

Parameters:
Name Type Description
request google.cloud.documentai.v1.IProcessRequest

ProcessRequest message or plain object

callback google.cloud.documentai.v1.DocumentProcessorService.ProcessDocumentCallback

Node-style callback called with the error, if any, and ProcessResponse

Returns:
Type Description
undefined

processDocument(request) → {Promise.<google.cloud.documentai.v1.ProcessResponse>}

Calls ProcessDocument.

Parameters:
Name Type Description
request google.cloud.documentai.v1.IProcessRequest

ProcessRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.documentai.v1.ProcessResponse>

Promise

reviewDocument(request, callback) → {undefined}

Calls ReviewDocument.

Parameters:
Name Type Description
request google.cloud.documentai.v1.IReviewDocumentRequest

ReviewDocumentRequest message or plain object

callback google.cloud.documentai.v1.DocumentProcessorService.ReviewDocumentCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

reviewDocument(request) → {Promise.<google.longrunning.Operation>}

Calls ReviewDocument.

Parameters:
Name Type Description
request google.cloud.documentai.v1.IReviewDocumentRequest

ReviewDocumentRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

Type Definitions

BatchProcessDocumentsCallback(error, responseopt)

Callback as used by google.cloud.documentai.v1.DocumentProcessorService#batchProcessDocuments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

ProcessDocumentCallback(error, responseopt)

Callback as used by google.cloud.documentai.v1.DocumentProcessorService#processDocument.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.documentai.v1.ProcessResponse <optional>

ProcessResponse

ReviewDocumentCallback(error, responseopt)

Callback as used by google.cloud.documentai.v1.DocumentProcessorService#reviewDocument.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation