Class protos.google.cloud.documentai.v1.DocumentProcessorService

Represents a DocumentProcessorService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.documentai.v1.DocumentProcessorService

Package

@google-cloud/documentai

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new DocumentProcessorService service.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

batchProcessDocuments(request, callback)

public batchProcessDocuments(request: google.cloud.documentai.v1.IBatchProcessRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocumentsCallback): void;

Calls BatchProcessDocuments.

Parameters
NameDescription
request 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
TypeDescription
void

batchProcessDocuments(request)

public batchProcessDocuments(request: google.cloud.documentai.v1.IBatchProcessRequest): Promise<google.longrunning.Operation>;

Calls BatchProcessDocuments.

Parameter
NameDescription
request IBatchProcessRequest

BatchProcessRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DocumentProcessorService;

Creates new DocumentProcessorService service using the specified rpc implementation.

Parameters
NameDescription
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
TypeDescription
DocumentProcessorService

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

processDocument(request, callback)

public processDocument(request: google.cloud.documentai.v1.IProcessRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ProcessDocumentCallback): void;

Calls ProcessDocument.

Parameters
NameDescription
request 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
TypeDescription
void

processDocument(request)

public processDocument(request: google.cloud.documentai.v1.IProcessRequest): Promise<google.cloud.documentai.v1.ProcessResponse>;

Calls ProcessDocument.

Parameter
NameDescription
request IProcessRequest

ProcessRequest message or plain object

Returns
TypeDescription
Promise<google.cloud.documentai.v1.ProcessResponse>

Promise

reviewDocument(request, callback)

public reviewDocument(request: google.cloud.documentai.v1.IReviewDocumentRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ReviewDocumentCallback): void;

Calls ReviewDocument.

Parameters
NameDescription
request 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
TypeDescription
void

reviewDocument(request)

public reviewDocument(request: google.cloud.documentai.v1.IReviewDocumentRequest): Promise<google.longrunning.Operation>;

Calls ReviewDocument.

Parameter
NameDescription
request IReviewDocumentRequest

ReviewDocumentRequest message or plain object

Returns
TypeDescription
Promise<google.longrunning.Operation>

Promise