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

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

createProcessor(request, callback) → {undefined}

Calls CreateProcessor.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.ICreateProcessorRequest	CreateProcessorRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.CreateProcessorCallback	Node-style callback called with the error, if any, and Processor

Returns:

Type	Description
undefined

createProcessor(request) → {Promise.<google.cloud.documentai.v1.Processor>}

Calls CreateProcessor.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.ICreateProcessorRequest	CreateProcessorRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.documentai.v1.Processor>	Promise

deleteProcessor(request, callback) → {undefined}

Calls DeleteProcessor.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IDeleteProcessorRequest	DeleteProcessorRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls DeleteProcessor.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IDeleteProcessorRequest	DeleteProcessorRequest message or plain object

Returns:

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

deleteProcessorVersion(request, callback) → {undefined}

Calls DeleteProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IDeleteProcessorVersionRequest	DeleteProcessorVersionRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.DeleteProcessorVersionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls DeleteProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IDeleteProcessorVersionRequest	DeleteProcessorVersionRequest message or plain object

Returns:

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

deployProcessorVersion(request, callback) → {undefined}

Calls DeployProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IDeployProcessorVersionRequest	DeployProcessorVersionRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.DeployProcessorVersionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls DeployProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IDeployProcessorVersionRequest	DeployProcessorVersionRequest message or plain object

Returns:

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

disableProcessor(request, callback) → {undefined}

Calls DisableProcessor.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IDisableProcessorRequest	DisableProcessorRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.DisableProcessorCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls DisableProcessor.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IDisableProcessorRequest	DisableProcessorRequest message or plain object

Returns:

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

enableProcessor(request, callback) → {undefined}

Calls EnableProcessor.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IEnableProcessorRequest	EnableProcessorRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.EnableProcessorCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls EnableProcessor.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IEnableProcessorRequest	EnableProcessorRequest message or plain object

Returns:

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

evaluateProcessorVersion(request, callback) → {undefined}

Calls EvaluateProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IEvaluateProcessorVersionRequest	EvaluateProcessorVersionRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.EvaluateProcessorVersionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls EvaluateProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IEvaluateProcessorVersionRequest	EvaluateProcessorVersionRequest message or plain object

Returns:

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

fetchProcessorTypes(request, callback) → {undefined}

Calls FetchProcessorTypes.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IFetchProcessorTypesRequest	FetchProcessorTypesRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypesCallback	Node-style callback called with the error, if any, and FetchProcessorTypesResponse

Returns:

Type	Description
undefined

fetchProcessorTypes(request) → {Promise.<google.cloud.documentai.v1.FetchProcessorTypesResponse>}

Calls FetchProcessorTypes.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IFetchProcessorTypesRequest	FetchProcessorTypesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.documentai.v1.FetchProcessorTypesResponse>	Promise

getEvaluation(request, callback) → {undefined}

Calls GetEvaluation.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IGetEvaluationRequest	GetEvaluationRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.GetEvaluationCallback	Node-style callback called with the error, if any, and Evaluation

Returns:

Type	Description
undefined

getEvaluation(request) → {Promise.<google.cloud.documentai.v1.Evaluation>}

Calls GetEvaluation.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IGetEvaluationRequest	GetEvaluationRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.documentai.v1.Evaluation>	Promise

getProcessor(request, callback) → {undefined}

Calls GetProcessor.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IGetProcessorRequest	GetProcessorRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.GetProcessorCallback	Node-style callback called with the error, if any, and Processor

Returns:

Type	Description
undefined

getProcessor(request) → {Promise.<google.cloud.documentai.v1.Processor>}

Calls GetProcessor.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IGetProcessorRequest	GetProcessorRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.documentai.v1.Processor>	Promise

getProcessorType(request, callback) → {undefined}

Calls GetProcessorType.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IGetProcessorTypeRequest	GetProcessorTypeRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.GetProcessorTypeCallback	Node-style callback called with the error, if any, and ProcessorType

Returns:

Type	Description
undefined

getProcessorType(request) → {Promise.<google.cloud.documentai.v1.ProcessorType>}

Calls GetProcessorType.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IGetProcessorTypeRequest	GetProcessorTypeRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.documentai.v1.ProcessorType>	Promise

getProcessorVersion(request, callback) → {undefined}

Calls GetProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IGetProcessorVersionRequest	GetProcessorVersionRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.GetProcessorVersionCallback	Node-style callback called with the error, if any, and ProcessorVersion

Returns:

Type	Description
undefined

getProcessorVersion(request) → {Promise.<google.cloud.documentai.v1.ProcessorVersion>}

Calls GetProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IGetProcessorVersionRequest	GetProcessorVersionRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.documentai.v1.ProcessorVersion>	Promise

listEvaluations(request, callback) → {undefined}

Calls ListEvaluations.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IListEvaluationsRequest	ListEvaluationsRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.ListEvaluationsCallback	Node-style callback called with the error, if any, and ListEvaluationsResponse

Returns:

Type	Description
undefined

listEvaluations(request) → {Promise.<google.cloud.documentai.v1.ListEvaluationsResponse>}

Calls ListEvaluations.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IListEvaluationsRequest	ListEvaluationsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.documentai.v1.ListEvaluationsResponse>	Promise

listProcessorTypes(request, callback) → {undefined}

Calls ListProcessorTypes.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IListProcessorTypesRequest	ListProcessorTypesRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.ListProcessorTypesCallback	Node-style callback called with the error, if any, and ListProcessorTypesResponse

Returns:

Type	Description
undefined

listProcessorTypes(request) → {Promise.<google.cloud.documentai.v1.ListProcessorTypesResponse>}

Calls ListProcessorTypes.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IListProcessorTypesRequest	ListProcessorTypesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.documentai.v1.ListProcessorTypesResponse>	Promise

listProcessorVersions(request, callback) → {undefined}

Calls ListProcessorVersions.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IListProcessorVersionsRequest	ListProcessorVersionsRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.ListProcessorVersionsCallback	Node-style callback called with the error, if any, and ListProcessorVersionsResponse

Returns:

Type	Description
undefined

listProcessorVersions(request) → {Promise.<google.cloud.documentai.v1.ListProcessorVersionsResponse>}

Calls ListProcessorVersions.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IListProcessorVersionsRequest	ListProcessorVersionsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.documentai.v1.ListProcessorVersionsResponse>	Promise

listProcessors(request, callback) → {undefined}

Calls ListProcessors.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IListProcessorsRequest	ListProcessorsRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.ListProcessorsCallback	Node-style callback called with the error, if any, and ListProcessorsResponse

Returns:

Type	Description
undefined

listProcessors(request) → {Promise.<google.cloud.documentai.v1.ListProcessorsResponse>}

Calls ListProcessors.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IListProcessorsRequest	ListProcessorsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.documentai.v1.ListProcessorsResponse>	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

setDefaultProcessorVersion(request, callback) → {undefined}

Calls SetDefaultProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest	SetDefaultProcessorVersionRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.SetDefaultProcessorVersionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls SetDefaultProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.ISetDefaultProcessorVersionRequest	SetDefaultProcessorVersionRequest message or plain object

Returns:

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

trainProcessorVersion(request, callback) → {undefined}

Calls TrainProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.ITrainProcessorVersionRequest	TrainProcessorVersionRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.TrainProcessorVersionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls TrainProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.ITrainProcessorVersionRequest	TrainProcessorVersionRequest message or plain object

Returns:

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

undeployProcessorVersion(request, callback) → {undefined}

Calls UndeployProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IUndeployProcessorVersionRequest	UndeployProcessorVersionRequest message or plain object
`callback`	google.cloud.documentai.v1.DocumentProcessorService.UndeployProcessorVersionCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls UndeployProcessorVersion.

Parameters:

Name	Type	Description
`request`	google.cloud.documentai.v1.IUndeployProcessorVersionRequest	UndeployProcessorVersionRequest message or plain object

Returns:

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

(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.

Type Definitions

BatchProcessDocumentsCallback(error, responseopt)

Callback as used by batchProcessDocuments.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateProcessorCallback(error, responseopt)

Callback as used by createProcessor.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.documentai.v1.Processor	<optional>	Processor

DeleteProcessorCallback(error, responseopt)

Callback as used by deleteProcessor.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteProcessorVersionCallback(error, responseopt)

Callback as used by deleteProcessorVersion.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeployProcessorVersionCallback(error, responseopt)

Callback as used by deployProcessorVersion.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DisableProcessorCallback(error, responseopt)

Callback as used by disableProcessor.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

EnableProcessorCallback(error, responseopt)

Callback as used by enableProcessor.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

EvaluateProcessorVersionCallback(error, responseopt)

Callback as used by evaluateProcessorVersion.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

FetchProcessorTypesCallback(error, responseopt)

Callback as used by fetchProcessorTypes.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.documentai.v1.FetchProcessorTypesResponse	<optional>	FetchProcessorTypesResponse

GetEvaluationCallback(error, responseopt)

Callback as used by getEvaluation.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.documentai.v1.Evaluation	<optional>	Evaluation

GetProcessorCallback(error, responseopt)

Callback as used by getProcessor.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.documentai.v1.Processor	<optional>	Processor

GetProcessorTypeCallback(error, responseopt)

Callback as used by getProcessorType.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.documentai.v1.ProcessorType	<optional>	ProcessorType

GetProcessorVersionCallback(error, responseopt)

Callback as used by getProcessorVersion.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.documentai.v1.ProcessorVersion	<optional>	ProcessorVersion

ListEvaluationsCallback(error, responseopt)

Callback as used by listEvaluations.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.documentai.v1.ListEvaluationsResponse	<optional>	ListEvaluationsResponse

ListProcessorTypesCallback(error, responseopt)

Callback as used by listProcessorTypes.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.documentai.v1.ListProcessorTypesResponse	<optional>	ListProcessorTypesResponse

ListProcessorVersionsCallback(error, responseopt)

Callback as used by listProcessorVersions.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.documentai.v1.ListProcessorVersionsResponse	<optional>	ListProcessorVersionsResponse

ListProcessorsCallback(error, responseopt)

Callback as used by listProcessors.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.documentai.v1.ListProcessorsResponse	<optional>	ListProcessorsResponse

ProcessDocumentCallback(error, responseopt)

Callback as used by 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 reviewDocument.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

SetDefaultProcessorVersionCallback(error, responseopt)

Callback as used by setDefaultProcessorVersion.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

TrainProcessorVersionCallback(error, responseopt)

Callback as used by trainProcessorVersion.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UndeployProcessorVersionCallback(error, responseopt)

Callback as used by undeployProcessorVersion.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation