google-cloud-document_ai-v1beta3 0.7.0 → 0.9.2

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

data/proto_docs/google/cloud/documentai/v1beta3/document.rb

@@ -190,6 +190,9 @@ module Google
           # @!attribute [rw] form_fields
           #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField>]
           #     A list of visually detected form fields on the page.
+          # @!attribute [rw] provenance
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
+          #     The history of this page.
           class Page
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -461,6 +464,9 @@ module Google
             #     - blank (this indicates the field_value is normal text)
             #     - "unfilled_checkbox"
             #     - "filled_checkbox"
+            # @!attribute [rw] provenance
+            #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Provenance]
+            #     The history of this annotation.
             class FormField
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -621,6 +627,8 @@ module Google
             #   @return [::Integer]
             #     Required. Index into the {::Google::Cloud::DocumentAI::V1beta3::Document#pages Document.pages} element, for example using
             #     [Document.pages][page_refs.page] to locate the related page element.
+            #     This field is skipped when its value is the default 0. See
+            #     https://developers.google.com/protocol-buffers/docs/proto3#json.
             # @!attribute [rw] layout_type
             #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::PageAnchor::PageRef::LayoutType]
             #     Optional. The type of the layout element that is being referenced if any.
@@ -630,6 +638,9 @@ module Google
             # @!attribute [rw] bounding_poly
             #   @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
             #     Optional. Identifies the bounding polygon of a layout element on the page.
+            # @!attribute [rw] confidence
+            #   @return [::Float]
+            #     Optional. Confidence of detected page element, if applicable. Range [0, 1].
             class PageRef
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -688,6 +699,10 @@ module Google
             # @!attribute [rw] revision
             #   @return [::Integer]
             #     The index of the [Document.revisions] identifying the parent revision.
+            # @!attribute [rw] index
+            #   @return [::Integer]
+            #     The index of the parent revisions corresponding collection of items
+            #     (eg. list of entities, properties within entities, etc.)
             # @!attribute [rw] id
             #   @return [::Integer]
             #     The id of the parent provenance.

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

@@ -229,7 +229,140 @@ module Google
           end
         end
 
+        # Request message for fetch processor types.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The project of processor type to list.
+        #     Format: projects/\\{project}/locations/\\{location}
+        class FetchProcessorTypesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for fetch processor types.
+        # @!attribute [rw] processor_types
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType>]
+        #     The list of processor types.
+        class FetchProcessorTypesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for list all processors belongs to a project.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent (project and location) which owns this collection of Processors.
+        #     Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     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.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     We will return the processors sorted by creation time. The page token
+        #     will point to the next processor.
+        class ListProcessorsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for list processors.
+        # @!attribute [rw] processors
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Processor>]
+        #     The list of processors.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Points to the next processor, otherwise empty.
+        class ListProcessorsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for create a processor. Notice this request is sent to
+        # a regionalized backend service, and if the processor type is not available
+        # on that region, the creation will fail.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent (project and location) under which to create the processor.
+        #     Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] processor
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::Processor]
+        #     Required. The processor to be created, requires [processor_type] and [display_name]
+        #     to be set. Also, the processor is under CMEK if CMEK fields are set.
+        class CreateProcessorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the delete processor method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor resource name to be deleted.
+        class DeleteProcessorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for delete processor method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class DeleteProcessorMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the enable processor method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor resource name to be enabled.
+        class EnableProcessorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the enable processor method.
+        class EnableProcessorResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for enable processor method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class EnableProcessorMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the disable processor method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor resource name to be disabled.
+        class DisableProcessorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the disable processor method.
+        class DisableProcessorResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for disable processor method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class DisableProcessorMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for review document method.
+        # Next Id: 6.
         # @!attribute [rw] inline_document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
         #     An inline document proto.
@@ -240,9 +373,25 @@ module Google
         # @!attribute [rw] document
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
         #     The document that needs human review.
+        # @!attribute [rw] enable_schema_validation
+        #   @return [::Boolean]
+        #     Whether the validation should be performed on the ad-hoc review request.
+        # @!attribute [rw] priority
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentRequest::Priority]
+        #     The priority of the human review task.
         class ReviewDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The priority level of the human review task.
+          module Priority
+            # The default priority level.
+            DEFAULT = 0
+
+            # The urgent priority level. The labeling manager should allocate labeler
+            # resource to the urgent task queue to respect this priority level.
+            URGENT = 1
+          end
         end
 
         # Response message for review document method.
@@ -296,45 +445,6 @@ module Google
             CANCELLED = 5
           end
         end
-
-        # The common metadata for long running operations.
-        # @!attribute [rw] state
-        #   @return [::Google::Cloud::DocumentAI::V1beta3::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

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

@@ -28,7 +28,7 @@ module Google
         #     X coordinate.
         # @!attribute [rw] y
         #   @return [::Integer]
-        #     Y coordinate.
+        #     Y coordinate (starts from the top of the image).
         class Vertex
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -42,7 +42,7 @@ module Google
         #     X coordinate.
         # @!attribute [rw] y
         #   @return [::Float]
-        #     Y coordinate.
+        #     Y coordinate (starts from the top of the image).
         class NormalizedVertex
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/documentai/v1beta3/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 V1beta3
+        # The common metadata for long running operations.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::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

data/proto_docs/google/cloud/documentai/v1beta3/processor.rb

@@ -0,0 +1,86 @@
+# 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 V1beta3
+        # The first-class citizen for DocumentAI. Each processor defines how to extract
+        # structural information from a document.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Immutable. The resource name of the processor.
+        #     Format: projects/\\{project}/locations/\\{location}/processors/\\{processor}
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     The processor type.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The display name of the processor.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::Processor::State]
+        #     Output only. The state of the processor.
+        # @!attribute [rw] default_processor_version
+        #   @return [::String]
+        #     The default processor version.
+        # @!attribute [r] process_endpoint
+        #   @return [::String]
+        #     Output only. Immutable. The http endpoint that can be called to invoke processing.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time the processor was created.
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     The KMS key used for encryption/decryption in CMEK scenarios.
+        #     See https://cloud.google.com/security-key-management.
+        class Processor
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The possible states of the processor.
+          module State
+            # The processor is in an unspecified state.
+            STATE_UNSPECIFIED = 0
+
+            # The processor is enabled.
+            ENABLED = 1
+
+            # The processor is disabled.
+            DISABLED = 2
+
+            # The processor is being enabled, will become ENABLED if successful.
+            ENABLING = 3
+
+            # The processor is being disabled, will become DISABLED if successful.
+            DISABLING = 4
+
+            # The processor is being created.
+            CREATING = 5
+
+            # The processor failed during creation.
+            FAILED = 6
+
+            # The processor is being deleted, will be removed if successful.
+            DELETING = 7
+          end
+        end
+      end
+    end
+  end
+end