Googledocumentaiconnector v1

/v1/{parent}/evaluations

Retrieves a set of evaluations for a given processor version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Parent`	Required. The resource name of the ProcessorVersion to list evaluations for. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
`Pagesize`	The standard list page size. If unspecified, at most 5 evaluations are returned. The maximum value is 100. Values above 100 are coerced to 100.
`Pagetoken`	A page token, received from a previous ListEvaluations call. Provide this to retrieve the subsequent page.
`Response Type`	N/A

/v1/{humanReviewConfig}:reviewDocument

Send a document for Human Review. The input document should be processed by the specified processor.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Humanreviewconfig`	Required. The resource name of the HumanReviewConfig that the document will be reviewed with.
`Response Type`	N/A

Options (2)

Option Name	Description
`Priority`	The priority of the human review task.
`Enableschemavalidation`	Whether the validation should be performed on the ad-hoc review request.

/v1/{parent}:fetchProcessorTypes

Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Parent`	Required. The location of processor types to list. Format: projects/{project}/locations/{location}.
`Response Type`	N/A

/v1/{name}/locations

Lists information about the supported locations for this service.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Name`	The resource that owns the locations collection, if applicable.
`Filter`	A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
`Extralocationtypes`	Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
`Pagetoken`	A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
`Pagesize`	The maximum number of results to return. If not set, the service selects a default.
`Response Type`	N/A

/v1/{name}:cancel

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Name`	The name of the operation resource to be cancelled.
`Response Type`	N/A

/v1/{name}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Name`	The name of the operation resource to be deleted.
`Response Type`	N/A

/v1/{name}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Pagetoken`	The standard list page token.
`Name`	The name of the operation's parent resource.
`Filter`	The standard list filter.
`Pagesize`	The standard list page size.
`Response Type`	N/A

/v1/{parent}/processorTypes

Lists the processor types that exist.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Parent`	Required. The location of processor types to list. Format: projects/{project}/locations/{location}.
`Pagetoken`	Used to retrieve the next page of results, empty if at the end of the list.
`Pagesize`	The maximum number of processor types to return. If unspecified, at most 100 processor types will be returned. The maximum value is 500. Values above 500 will be coerced to 500.
`Response Type`	N/A

/v1/{name}:batchProcess

LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Name`	Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
`Response Type`	N/A

Options (1)

Option Name	Description
`Skiphumanreview`	Whether human review should be skipped for this request. Default to false.

/v1/{name}:deploy

Deploys the processor version.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Name`	Required. The processor version resource name to be deployed.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/v1/{processorVersion}:evaluateProcessorVersion

Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Processorversion`	Required. The resource name of the ProcessorVersion to evaluate. projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
`Response Type`	N/A

/v1/{parent}/processorVersions

Lists all versions of a processor.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Parent`	Required. The parent (project, location and processor) to list all versions. Format: projects/{project}/locations/{location}/processors/{processor}
`Pagetoken`	We will return the processor versions sorted by creation time. The page token will point to the next processor version.
`Pagesize`	The maximum number of processor versions to return. If unspecified, at most 10 processor versions will be returned. The maximum value is 20. Values above 20 will be coerced to 20.
`Response Type`	N/A

/v1/{name}:process

Processes a single document.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Name`	Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use its default version. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}
`Response Type`	N/A

Options (3)

Option Name	Description
`Skiphumanreview`	Whether human review should be skipped for this request. Default to false.
`Fieldmask`	Specifies which fields to include in the ProcessResponse.document output. Only supports top-level document and pages field, so it must be in the form of {document_field_name} or pages.{page_field_name}.
`Imagelessmode`	Optional. Option to remove images from the document.

/v1/{parent}/processorVersions:train

Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Parent`	Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.
`Response Type`	N/A

Options (1)

Option Name	Description
`Baseprocessorversion`	Optional. The processor version to use as a base for training. This processor version must be a child of parent. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}.

/v1/{name}:undeploy

Undeploys the processor version.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Name`	Required. The processor version resource name to be undeployed.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/v1/{parent}/processors

Creates a processor from the ProcessorType provided. The processor will be at ENABLED state by default after its creation. Note that this method requires the documentai.processors.create permission on the project, which is highly privileged. A user or service account with this permission can create new processors that can interact with any gcs bucket in your project.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Parent`	Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}
`Response Type`	N/A

Options (11)

Option Name	Description
`Name`	Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}
`State`	Output only. The state of the processor.
`Type`	The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.
`Processorversionaliases`	Output only. The processor version aliases.
`Displayname`	The display name of the processor.
`Satisfiespzi`	Output only. Reserved for future use.
`Defaultprocessorversion`	The default processor version.
`Createtime`	The time the processor was created.
`Processendpoint`	Output only. Immutable. The http endpoint that can be called to invoke processing.
`Satisfiespzs`	Output only. Reserved for future use.
`Kmskeyname`	The KMS key used for encryption and decryption in CMEK scenarios.

/v1/{name}:disable

Disables a processor

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Name`	Required. The processor resource name to be disabled.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/v1/{name}:enable

Enables a processor

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Name`	Required. The processor resource name to be enabled.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

/v1/{parent}/processors

Lists all processors which belong to this project.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Pagesize`	The maximum number of processors to return. If unspecified, at most 50 processors will be returned. The maximum value is 100. Values above 100 will be coerced to 100.
`Pagetoken`	We will return the processors sorted by creation time. The page token will point to the next processor.
`Parent`	Required. The parent (project and location) which owns this collection of Processors. Format: projects/{project}/locations/{location}
`Response Type`	N/A

/v1/{processor}:setDefaultProcessorVersion

Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Protocol`	Upload protocol for media (e.g. "raw", "multipart").
`Uploadtype`	Legacy upload protocol for media (e.g. "media", "multipart").
`Prettyprint`	Returns response with indentations and line breaks.
`Key`	API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
`Oauth Token`	OAuth 2.0 token for the current user.
`Quotauser`	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
`Access Token`	OAuth access token.
`Callback`	JSONP
`Fields`	Selector specifying which fields to include in a partial response.
`$.xgafv`	V1 error format. (Acceptable values are: "1", "2")
`Alt`	Data format for response. (Acceptable values are: "json", "media", "proto")
`Processor`	Required. The resource name of the Processor to change default version.
`Response Type`	N/A

Options (1)

Option Name	Description
`Defaultprocessorversion`	Required. The resource name of child ProcessorVersion to use as default. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}

Evaluations

HumanReviewConfig

Locations (2)

Operations (3)

ProcessorTypes

ProcessorVersions (7)

Processors (5)