google-cloud-document_ai-v1 0.1.0

data/proto_docs/google/cloud/documentai/v1/document_io.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DocumentAI
+      module V1
+        # Payload message of raw document content (bytes).
+        # @!attribute [rw] content
+        #   @return [::String]
+        #     Inline document content.
+        # @!attribute [rw] mime_type
+        #   @return [::String]
+        #     An IANA MIME type (RFC6838) indicating the nature and format of the
+        #     [content].
+        class RawDocument
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Specifies a document stored on Cloud Storage.
+        # @!attribute [rw] gcs_uri
+        #   @return [::String]
+        #     The Cloud Storage object uri.
+        # @!attribute [rw] mime_type
+        #   @return [::String]
+        #     An IANA MIME type (RFC6838) of the content.
+        class GcsDocument
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Specifies a set of documents on Cloud Storage.
+        # @!attribute [rw] documents
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1::GcsDocument>]
+        #     The list of documents.
+        class GcsDocuments
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Specifies all documents on Cloud Storage with a common prefix.
+        # @!attribute [rw] gcs_uri_prefix
+        #   @return [::String]
+        #     The URI prefix.
+        class GcsPrefix
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The common config to specify a set of documents used as input.
+        # @!attribute [rw] gcs_prefix
+        #   @return [::Google::Cloud::DocumentAI::V1::GcsPrefix]
+        #     The set of documents that match the specified Cloud Storage [gcs_prefix].
+        # @!attribute [rw] gcs_documents
+        #   @return [::Google::Cloud::DocumentAI::V1::GcsDocuments]
+        #     The set of documents individually specified on Cloud Storage.
+        class BatchDocumentsInputConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Config that controls the output of documents. All documents will be written
+        # as a JSON file.
+        # @!attribute [rw] gcs_output_config
+        #   @return [::Google::Cloud::DocumentAI::V1::DocumentOutputConfig::GcsOutputConfig]
+        #     Output config to write the results to Cloud Storage.
+        class DocumentOutputConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The configuration used when outputting documents.
+          # @!attribute [rw] gcs_uri
+          #   @return [::String]
+          #     The Cloud Storage uri (a directory) of the output.
+          class GcsOutputConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/documentai/v1/document_processor_service.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DocumentAI
+      module V1
+        # Request message for the process document method.
+        # @!attribute [rw] inline_document
+        #   @return [::Google::Cloud::DocumentAI::V1::Document]
+        #     An inline document proto.
+        # @!attribute [rw] raw_document
+        #   @return [::Google::Cloud::DocumentAI::V1::RawDocument]
+        #     A raw document content (bytes).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor resource name.
+        # @!attribute [rw] skip_human_review
+        #   @return [::Boolean]
+        #     Whether Human Review feature should be skipped for this request. Default to
+        #     false.
+        class ProcessRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The status of human review on a processed document.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DocumentAI::V1::HumanReviewStatus::State]
+        #     The state of human review on the processing request.
+        # @!attribute [rw] state_message
+        #   @return [::String]
+        #     A message providing more details about the human review state.
+        # @!attribute [rw] human_review_operation
+        #   @return [::String]
+        #     The name of the operation triggered by the processed document. This field
+        #     is populated only when the [state] is [HUMAN_REVIEW_IN_PROGRESS]. It has
+        #     the same response type and metadata as the long running operation returned
+        #     by [ReviewDocument] method.
+        class HumanReviewStatus
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The final state of human review on a processed document.
+          module State
+            # Human review state is unspecified. Most likely due to an internal error.
+            STATE_UNSPECIFIED = 0
+
+            # Human review is skipped for the document. This can happen because human
+            # review is not enabled on the processor or the processing request has
+            # been set to skip this document.
+            SKIPPED = 1
+
+            # Human review validation is triggered and passed, so no review is needed.
+            VALIDATION_PASSED = 2
+
+            # Human review validation is triggered and the document is under review.
+            IN_PROGRESS = 3
+
+            # Some error happened during triggering human review, see the
+            # [state_message] for details.
+            ERROR = 4
+          end
+        end
+
+        # Response message for the process document method.
+        # @!attribute [rw] document
+        #   @return [::Google::Cloud::DocumentAI::V1::Document]
+        #     The document payload, will populate fields based on the processor's
+        #     behavior.
+        # @!attribute [rw] human_review_status
+        #   @return [::Google::Cloud::DocumentAI::V1::HumanReviewStatus]
+        #     The status of human review on the processed document.
+        class ProcessResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for batch process document method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor resource name.
+        # @!attribute [rw] input_documents
+        #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
+        #     The input documents for batch process.
+        # @!attribute [rw] document_output_config
+        #   @return [::Google::Cloud::DocumentAI::V1::DocumentOutputConfig]
+        #     The overall output config for batch process.
+        # @!attribute [rw] skip_human_review
+        #   @return [::Boolean]
+        #     Whether Human Review feature should be skipped for this request. Default to
+        #     false.
+        class BatchProcessRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for batch process document method.
+        class BatchProcessResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for batch process method.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DocumentAI::V1::BatchProcessMetadata::State]
+        #     The state of the current batch processing.
+        # @!attribute [rw] state_message
+        #   @return [::String]
+        #     A message providing more details about the current state of processing.
+        #     For example, the error message if the operation is failed.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The creation time of the operation.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The last update time of the operation.
+        # @!attribute [rw] individual_process_statuses
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1::BatchProcessMetadata::IndividualProcessStatus>]
+        #     The list of response details of each document.
+        class BatchProcessMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The status of a each individual document in the batch process.
+          # @!attribute [rw] input_gcs_source
+          #   @return [::String]
+          #     The source of the document, same as the [input_gcs_source] field in the
+          #     request when the batch process started. The batch process is started by
+          #     take snapshot of that document, since a user can move or change that
+          #     document during the process.
+          # @!attribute [rw] status
+          #   @return [::Google::Rpc::Status]
+          #     The status of the processing of the document.
+          # @!attribute [rw] output_gcs_destination
+          #   @return [::String]
+          #     The output_gcs_destination (in the request as 'output_gcs_destination')
+          #     of the processed document if it was successful, otherwise empty.
+          # @!attribute [rw] human_review_status
+          #   @return [::Google::Cloud::DocumentAI::V1::HumanReviewStatus]
+          #     The status of human review on the processed document.
+          class IndividualProcessStatus
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Possible states of the batch processing operation.
+          module State
+            # The default value. This value is used if the state is omitted.
+            STATE_UNSPECIFIED = 0
+
+            # Request operation is waiting for scheduling.
+            WAITING = 1
+
+            # Request is being processed.
+            RUNNING = 2
+
+            # The batch processing completed successfully.
+            SUCCEEDED = 3
+
+            # The batch processing was being cancelled.
+            CANCELLING = 4
+
+            # The batch processing was cancelled.
+            CANCELLED = 5
+
+            # The batch processing has failed.
+            FAILED = 6
+          end
+        end
+
+        # Request message for review document method.
+        # @!attribute [rw] inline_document
+        #   @return [::Google::Cloud::DocumentAI::V1::Document]
+        #     An inline document proto.
+        # @!attribute [rw] human_review_config
+        #   @return [::String]
+        #     Required. The resource name of the HumanReviewConfig that the document will be
+        #     reviewed with.
+        class ReviewDocumentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for review document method.
+        # @!attribute [rw] gcs_destination
+        #   @return [::String]
+        #     The Cloud Storage uri for the human reviewed document.
+        class ReviewDocumentResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for review document method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class ReviewDocumentOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/documentai/v1/geometry.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DocumentAI
+      module V1
+        # A vertex represents a 2D point in the image.
+        # NOTE: the vertex coordinates are in the same scale as the original image.
+        # @!attribute [rw] x
+        #   @return [::Integer]
+        #     X coordinate.
+        # @!attribute [rw] y
+        #   @return [::Integer]
+        #     Y coordinate (starts from the top of the image).
+        class Vertex
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A vertex represents a 2D point in the image.
+        # NOTE: the normalized vertex coordinates are relative to the original image
+        # and range from 0 to 1.
+        # @!attribute [rw] x
+        #   @return [::Float]
+        #     X coordinate.
+        # @!attribute [rw] y
+        #   @return [::Float]
+        #     Y coordinate (starts from the top of the image).
+        class NormalizedVertex
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A bounding polygon for the detected image annotation.
+        # @!attribute [rw] vertices
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1::Vertex>]
+        #     The bounding polygon vertices.
+        # @!attribute [rw] normalized_vertices
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1::NormalizedVertex>]
+        #     The bounding polygon normalized vertices.
+        class BoundingPoly
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/documentai/v1/operation_metadata.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DocumentAI
+      module V1
+        # The common metadata for long running operations.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata::State]
+        #     The state of the operation.
+        # @!attribute [rw] state_message
+        #   @return [::String]
+        #     A message providing more details about the current state of processing.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The creation time of the operation.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The last update time of the operation.
+        class CommonOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # State of the longrunning operation.
+          module State
+            # Unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # Operation is still running.
+            RUNNING = 1
+
+            # Operation is being cancelled.
+            CANCELLING = 2
+
+            # Operation succeeded.
+            SUCCEEDED = 3
+
+            # Operation failed.
+            FAILED = 4
+
+            # Operation is cancelled.
+            CANCELLED = 5
+          end
+        end
+      end
+    end
+  end
+end