happygapi.documentai.projects — happygapi 0.4.8

Cloud Document AI API: projects. Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML. See: https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects

locations-fetchProcessorTypes$ clj

(locations-fetchProcessorTypes$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/fetchProcessorTypes

Required parameters: parent

Optional parameters: none

Fetches processor types.

locations-get$ clj

(locations-get$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.

locations-list$ clj

(locations-list$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/list

Required parameters: name

Optional parameters: filter, pageSize, pageToken

Lists information about the supported locations for this service.

locations-operations-cancel$ clj

(locations-operations-cancel$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/operations/cancel

Required parameters: name

Optional parameters: none

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.

locations-operations-get$ clj

(locations-operations-get$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/operations/get

Required parameters: name

Optional parameters: none

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

locations-operations-list$ clj

(locations-operations-list$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/operations/list

Required parameters: name

Optional parameters: pageSize, pageToken, filter

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

locations-processors-batchProcess$ clj

(locations-processors-batchProcess$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/batchProcess

Required parameters: name

Optional parameters: none

Body:

{:inputDocuments {:gcsDocuments GoogleCloudDocumentaiV1GcsDocuments, :gcsPrefix GoogleCloudDocumentaiV1GcsPrefix}, :skipHumanReview boolean, :documentOutputConfig {:gcsOutputConfig GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig}}

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

locations-processors-create$ clj

(locations-processors-create$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/create

Required parameters: parent

Optional parameters: none

Body:

{:type string, :name string, :processEndpoint string, :state string, :displayName string, :kmsKeyName string, :createTime string, :defaultProcessorVersion string}

Creates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.

locations-processors-delete$ clj

(locations-processors-delete$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/delete

Required parameters: name

Optional parameters: none

Deletes the processor, unloads all deployed model artifacts if it was enabled and then deletes all artifacts associated with this processor.

locations-processors-disable$ clj

(locations-processors-disable$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/disable

Required parameters: name

Optional parameters: none

Body:

{}

Disables a processor

locations-processors-enable$ clj

(locations-processors-enable$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/enable

Required parameters: name

Optional parameters: none

Body:

{}

Enables a processor

locations-processors-get$ clj

(locations-processors-get$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/get

Required parameters: name

Optional parameters: none

Gets a processor detail.

locations-processors-humanReviewConfig-reviewDocument$ clj

(locations-processors-humanReviewConfig-reviewDocument$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/humanReviewConfig/reviewDocument

Required parameters: humanReviewConfig

Optional parameters: none

Body:

{:priority string, :inlineDocument {:textChanges [GoogleCloudDocumentaiV1DocumentTextChange], :content string, :textStyles [GoogleCloudDocumentaiV1DocumentStyle], :shardInfo GoogleCloudDocumentaiV1DocumentShardInfo, :entities [GoogleCloudDocumentaiV1DocumentEntity], :entityRelations [GoogleCloudDocumentaiV1DocumentEntityRelation], :pages [GoogleCloudDocumentaiV1DocumentPage], :mimeType string, :revisions [GoogleCloudDocumentaiV1DocumentRevision], :error GoogleRpcStatus, :uri string, :text string}, :enableSchemaValidation boolean}

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

locations-processors-list$ clj

(locations-processors-list$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/list

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists all processors which belong to this project.

locations-processors-process$ clj

(locations-processors-process$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/process

Required parameters: name

Optional parameters: none

Body:

{:inlineDocument {:textChanges [GoogleCloudDocumentaiV1DocumentTextChange], :content string, :textStyles [GoogleCloudDocumentaiV1DocumentStyle], :shardInfo GoogleCloudDocumentaiV1DocumentShardInfo, :entities [GoogleCloudDocumentaiV1DocumentEntity], :entityRelations [GoogleCloudDocumentaiV1DocumentEntityRelation], :pages [GoogleCloudDocumentaiV1DocumentPage], :mimeType string, :revisions [GoogleCloudDocumentaiV1DocumentRevision], :error GoogleRpcStatus, :uri string, :text string}, :skipHumanReview boolean, :rawDocument {:mimeType string, :content string}}

Processes a single document.

locations-processors-processorVersions-batchProcess$ clj

(locations-processors-processorVersions-batchProcess$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/processorVersions/batchProcess

Required parameters: name

Optional parameters: none

Body:

{:inputDocuments {:gcsDocuments GoogleCloudDocumentaiV1GcsDocuments, :gcsPrefix GoogleCloudDocumentaiV1GcsPrefix}, :skipHumanReview boolean, :documentOutputConfig {:gcsOutputConfig GoogleCloudDocumentaiV1DocumentOutputConfigGcsOutputConfig}}

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

locations-processors-processorVersions-delete$ clj

(locations-processors-processorVersions-delete$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/processorVersions/delete

Required parameters: name

Optional parameters: none

Deletes the processor version, all artifacts under the processor version will be deleted.

locations-processors-processorVersions-deploy$ clj

(locations-processors-processorVersions-deploy$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/processorVersions/deploy

Required parameters: name

Optional parameters: none

Body:

{}

Deploys the processor version.

locations-processors-processorVersions-get$ clj

(locations-processors-processorVersions-get$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/processorVersions/get

Required parameters: name

Optional parameters: none

Gets a processor version detail.

locations-processors-processorVersions-list$ clj

(locations-processors-processorVersions-list$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/processorVersions/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists all versions of a processor.

locations-processors-processorVersions-process$ clj

(locations-processors-processorVersions-process$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/processorVersions/process

Required parameters: name

Optional parameters: none

Body:

{:inlineDocument {:textChanges [GoogleCloudDocumentaiV1DocumentTextChange], :content string, :textStyles [GoogleCloudDocumentaiV1DocumentStyle], :shardInfo GoogleCloudDocumentaiV1DocumentShardInfo, :entities [GoogleCloudDocumentaiV1DocumentEntity], :entityRelations [GoogleCloudDocumentaiV1DocumentEntityRelation], :pages [GoogleCloudDocumentaiV1DocumentPage], :mimeType string, :revisions [GoogleCloudDocumentaiV1DocumentRevision], :error GoogleRpcStatus, :uri string, :text string}, :skipHumanReview boolean, :rawDocument {:mimeType string, :content string}}

Processes a single document.

locations-processors-processorVersions-undeploy$ clj

(locations-processors-processorVersions-undeploy$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/processorVersions/undeploy

Required parameters: name

Optional parameters: none

Body:

{}

Undeploys the processor version.

locations-processors-setDefaultProcessorVersion$ clj

(locations-processors-setDefaultProcessorVersion$ auth parameters body)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/locations/processors/setDefaultProcessorVersion

Required parameters: processor

Optional parameters: none

Body:

{:defaultProcessorVersion string}

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

operations-get$ clj

(operations-get$ auth parameters)

https://cloud.google.com/document-ai/docs/api/reference/rest/v1/projects/operations/get

Required parameters: name

Optional parameters: none

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.