Class protos.google.cloud.documentai.v1.DocumentProcessorService (8.8.0)

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
Name Description
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
Name Description
request IBatchProcessRequest

BatchProcessRequest message or plain object
callback BatchProcessDocumentsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

batchProcessDocuments(request)

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

Calls BatchProcessDocuments.

Parameter
Name Description
request IBatchProcessRequest

BatchProcessRequest message or plain object
Returns
Type Description
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
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
DocumentProcessorService

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

createProcessor(request, callback)

public createProcessor(request: google.cloud.documentai.v1.ICreateProcessorRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.CreateProcessorCallback): void;

Calls CreateProcessor.

Parameters
Name Description
request ICreateProcessorRequest

CreateProcessorRequest message or plain object
callback CreateProcessorCallback

Node-style callback called with the error, if any, and Processor
Returns
Type Description
void

createProcessor(request)

public createProcessor(request: google.cloud.documentai.v1.ICreateProcessorRequest): Promise<google.cloud.documentai.v1.Processor>;

Calls CreateProcessor.

Parameter
Name Description
request ICreateProcessorRequest

CreateProcessorRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.Processor>

Promise

deleteProcessor(request, callback)

public deleteProcessor(request: google.cloud.documentai.v1.IDeleteProcessorRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorCallback): void;

Calls DeleteProcessor.

Parameters
Name Description
request IDeleteProcessorRequest

DeleteProcessorRequest message or plain object
callback DeleteProcessorCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteProcessor(request)

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

Calls DeleteProcessor.

Parameter
Name Description
request IDeleteProcessorRequest

DeleteProcessorRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteProcessorVersion(request, callback)

public deleteProcessorVersion(request: google.cloud.documentai.v1.IDeleteProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorVersionCallback): void;

Calls DeleteProcessorVersion.

Parameters
Name Description
request IDeleteProcessorVersionRequest

DeleteProcessorVersionRequest message or plain object
callback DeleteProcessorVersionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteProcessorVersion(request)

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

Calls DeleteProcessorVersion.

Parameter
Name Description
request IDeleteProcessorVersionRequest

DeleteProcessorVersionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deployProcessorVersion(request, callback)

public deployProcessorVersion(request: google.cloud.documentai.v1.IDeployProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.DeployProcessorVersionCallback): void;

Calls DeployProcessorVersion.

Parameters
Name Description
request IDeployProcessorVersionRequest

DeployProcessorVersionRequest message or plain object
callback DeployProcessorVersionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deployProcessorVersion(request)

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

Calls DeployProcessorVersion.

Parameter
Name Description
request IDeployProcessorVersionRequest

DeployProcessorVersionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

disableProcessor(request, callback)

public disableProcessor(request: google.cloud.documentai.v1.IDisableProcessorRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.DisableProcessorCallback): void;

Calls DisableProcessor.

Parameters
Name Description
request IDisableProcessorRequest

DisableProcessorRequest message or plain object
callback DisableProcessorCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

disableProcessor(request)

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

Calls DisableProcessor.

Parameter
Name Description
request IDisableProcessorRequest

DisableProcessorRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

enableProcessor(request, callback)

public enableProcessor(request: google.cloud.documentai.v1.IEnableProcessorRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.EnableProcessorCallback): void;

Calls EnableProcessor.

Parameters
Name Description
request IEnableProcessorRequest

EnableProcessorRequest message or plain object
callback EnableProcessorCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

enableProcessor(request)

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

Calls EnableProcessor.

Parameter
Name Description
request IEnableProcessorRequest

EnableProcessorRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

evaluateProcessorVersion(request, callback)

public evaluateProcessorVersion(request: google.cloud.documentai.v1.IEvaluateProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.EvaluateProcessorVersionCallback): void;

Calls EvaluateProcessorVersion.

Parameters
Name Description
request IEvaluateProcessorVersionRequest

EvaluateProcessorVersionRequest message or plain object
callback EvaluateProcessorVersionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

evaluateProcessorVersion(request)

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

Calls EvaluateProcessorVersion.

Parameter
Name Description
request IEvaluateProcessorVersionRequest

EvaluateProcessorVersionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

fetchProcessorTypes(request, callback)

public fetchProcessorTypes(request: google.cloud.documentai.v1.IFetchProcessorTypesRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypesCallback): void;

Calls FetchProcessorTypes.

Parameters
Name Description
request IFetchProcessorTypesRequest

FetchProcessorTypesRequest message or plain object
callback FetchProcessorTypesCallback

Node-style callback called with the error, if any, and FetchProcessorTypesResponse
Returns
Type Description
void

fetchProcessorTypes(request)

public fetchProcessorTypes(request: google.cloud.documentai.v1.IFetchProcessorTypesRequest): Promise<google.cloud.documentai.v1.FetchProcessorTypesResponse>;

Calls FetchProcessorTypes.

Parameter
Name Description
request IFetchProcessorTypesRequest

FetchProcessorTypesRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.FetchProcessorTypesResponse>

Promise

getEvaluation(request, callback)

public getEvaluation(request: google.cloud.documentai.v1.IGetEvaluationRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.GetEvaluationCallback): void;

Calls GetEvaluation.

Parameters
Name Description
request IGetEvaluationRequest

GetEvaluationRequest message or plain object
callback GetEvaluationCallback

Node-style callback called with the error, if any, and Evaluation
Returns
Type Description
void

getEvaluation(request)

public getEvaluation(request: google.cloud.documentai.v1.IGetEvaluationRequest): Promise<google.cloud.documentai.v1.Evaluation>;

Calls GetEvaluation.

Parameter
Name Description
request IGetEvaluationRequest

GetEvaluationRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.Evaluation>

Promise

getProcessor(request, callback)

public getProcessor(request: google.cloud.documentai.v1.IGetProcessorRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.GetProcessorCallback): void;

Calls GetProcessor.

Parameters
Name Description
request IGetProcessorRequest

GetProcessorRequest message or plain object
callback GetProcessorCallback

Node-style callback called with the error, if any, and Processor
Returns
Type Description
void

getProcessor(request)

public getProcessor(request: google.cloud.documentai.v1.IGetProcessorRequest): Promise<google.cloud.documentai.v1.Processor>;

Calls GetProcessor.

Parameter
Name Description
request IGetProcessorRequest

GetProcessorRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.Processor>

Promise

getProcessorType(request, callback)

public getProcessorType(request: google.cloud.documentai.v1.IGetProcessorTypeRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.GetProcessorTypeCallback): void;

Calls GetProcessorType.

Parameters
Name Description
request IGetProcessorTypeRequest

GetProcessorTypeRequest message or plain object
callback GetProcessorTypeCallback

Node-style callback called with the error, if any, and ProcessorType
Returns
Type Description
void

getProcessorType(request)

public getProcessorType(request: google.cloud.documentai.v1.IGetProcessorTypeRequest): Promise<google.cloud.documentai.v1.ProcessorType>;

Calls GetProcessorType.

Parameter
Name Description
request IGetProcessorTypeRequest

GetProcessorTypeRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.ProcessorType>

Promise

getProcessorVersion(request, callback)

public getProcessorVersion(request: google.cloud.documentai.v1.IGetProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.GetProcessorVersionCallback): void;

Calls GetProcessorVersion.

Parameters
Name Description
request IGetProcessorVersionRequest

GetProcessorVersionRequest message or plain object
callback GetProcessorVersionCallback

Node-style callback called with the error, if any, and ProcessorVersion
Returns
Type Description
void

getProcessorVersion(request)

public getProcessorVersion(request: google.cloud.documentai.v1.IGetProcessorVersionRequest): Promise<google.cloud.documentai.v1.ProcessorVersion>;

Calls GetProcessorVersion.

Parameter
Name Description
request IGetProcessorVersionRequest

GetProcessorVersionRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.ProcessorVersion>

Promise

listEvaluations(request, callback)

public listEvaluations(request: google.cloud.documentai.v1.IListEvaluationsRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ListEvaluationsCallback): void;

Calls ListEvaluations.

Parameters
Name Description
request IListEvaluationsRequest

ListEvaluationsRequest message or plain object
callback ListEvaluationsCallback

Node-style callback called with the error, if any, and ListEvaluationsResponse
Returns
Type Description
void

listEvaluations(request)

public listEvaluations(request: google.cloud.documentai.v1.IListEvaluationsRequest): Promise<google.cloud.documentai.v1.ListEvaluationsResponse>;

Calls ListEvaluations.

Parameter
Name Description
request IListEvaluationsRequest

ListEvaluationsRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.ListEvaluationsResponse>

Promise

listProcessors(request, callback)

public listProcessors(request: google.cloud.documentai.v1.IListProcessorsRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ListProcessorsCallback): void;

Calls ListProcessors.

Parameters
Name Description
request IListProcessorsRequest

ListProcessorsRequest message or plain object
callback ListProcessorsCallback

Node-style callback called with the error, if any, and ListProcessorsResponse
Returns
Type Description
void

listProcessors(request)

public listProcessors(request: google.cloud.documentai.v1.IListProcessorsRequest): Promise<google.cloud.documentai.v1.ListProcessorsResponse>;

Calls ListProcessors.

Parameter
Name Description
request IListProcessorsRequest

ListProcessorsRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.ListProcessorsResponse>

Promise

listProcessorTypes(request, callback)

public listProcessorTypes(request: google.cloud.documentai.v1.IListProcessorTypesRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypesCallback): void;

Calls ListProcessorTypes.

Parameters
Name Description
request IListProcessorTypesRequest

ListProcessorTypesRequest message or plain object
callback ListProcessorTypesCallback

Node-style callback called with the error, if any, and ListProcessorTypesResponse
Returns
Type Description
void

listProcessorTypes(request)

public listProcessorTypes(request: google.cloud.documentai.v1.IListProcessorTypesRequest): Promise<google.cloud.documentai.v1.ListProcessorTypesResponse>;

Calls ListProcessorTypes.

Parameter
Name Description
request IListProcessorTypesRequest

ListProcessorTypesRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.ListProcessorTypesResponse>

Promise

listProcessorVersions(request, callback)

public listProcessorVersions(request: google.cloud.documentai.v1.IListProcessorVersionsRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.ListProcessorVersionsCallback): void;

Calls ListProcessorVersions.

Parameters
Name Description
request IListProcessorVersionsRequest

ListProcessorVersionsRequest message or plain object
callback ListProcessorVersionsCallback

Node-style callback called with the error, if any, and ListProcessorVersionsResponse
Returns
Type Description
void

listProcessorVersions(request)

public listProcessorVersions(request: google.cloud.documentai.v1.IListProcessorVersionsRequest): Promise<google.cloud.documentai.v1.ListProcessorVersionsResponse>;

Calls ListProcessorVersions.

Parameter
Name Description
request IListProcessorVersionsRequest

ListProcessorVersionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.documentai.v1.ListProcessorVersionsResponse>

Promise

processDocument(request, callback)

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

Calls ProcessDocument.

Parameters
Name Description
request IProcessRequest

ProcessRequest message or plain object
callback ProcessDocumentCallback

Node-style callback called with the error, if any, and ProcessResponse
Returns
Type Description
void

processDocument(request)

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

Calls ProcessDocument.

Parameter
Name Description
request IProcessRequest

ProcessRequest message or plain object
Returns
Type Description
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
Name Description
request IReviewDocumentRequest

ReviewDocumentRequest message or plain object
callback ReviewDocumentCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

reviewDocument(request)

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

Calls ReviewDocument.

Parameter
Name Description
request IReviewDocumentRequest

ReviewDocumentRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

setDefaultProcessorVersion(request, callback)

public setDefaultProcessorVersion(request: google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.SetDefaultProcessorVersionCallback): void;

Calls SetDefaultProcessorVersion.

Parameters
Name Description
request ISetDefaultProcessorVersionRequest

SetDefaultProcessorVersionRequest message or plain object
callback SetDefaultProcessorVersionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setDefaultProcessorVersion(request)

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

Calls SetDefaultProcessorVersion.

Parameter
Name Description
request ISetDefaultProcessorVersionRequest

SetDefaultProcessorVersionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

trainProcessorVersion(request, callback)

public trainProcessorVersion(request: google.cloud.documentai.v1.ITrainProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.TrainProcessorVersionCallback): void;

Calls TrainProcessorVersion.

Parameters
Name Description
request ITrainProcessorVersionRequest

TrainProcessorVersionRequest message or plain object
callback TrainProcessorVersionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

trainProcessorVersion(request)

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

Calls TrainProcessorVersion.

Parameter
Name Description
request ITrainProcessorVersionRequest

TrainProcessorVersionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

undeployProcessorVersion(request, callback)

public undeployProcessorVersion(request: google.cloud.documentai.v1.IUndeployProcessorVersionRequest, callback: google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersionCallback): void;

Calls UndeployProcessorVersion.

Parameters
Name Description
request IUndeployProcessorVersionRequest

UndeployProcessorVersionRequest message or plain object
callback UndeployProcessorVersionCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

undeployProcessorVersion(request)

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

Calls UndeployProcessorVersion.

Parameter
Name Description
request IUndeployProcessorVersionRequest

UndeployProcessorVersionRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise