google-cloud-document_ai-v1beta3 0.6.0 → 0.9.1

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

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

@@ -0,0 +1,59 @@
+# 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
+        # A processor type is responsible for performing a certain document
+        # understanding task on a certain type of document.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The resource name of the processor type.
+        # @!attribute [rw] type
+        #   @return [::String]
+        #     The type of the processor.
+        # @!attribute [rw] category
+        #   @return [::String]
+        #     The processor category.
+        # @!attribute [rw] available_locations
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::ProcessorType::LocationInfo>]
+        #     The locations in which this processor is available.
+        # @!attribute [rw] allow_creation
+        #   @return [::Boolean]
+        #     Whether the processor type allows creation. If yes, user can create a
+        #     processor of this processor type. Otherwise, user needs to require for
+        #     whitelisting.
+        class ProcessorType
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The location information about where the processor is available.
+          # @!attribute [rw] location_id
+          #   @return [::String]
+          #     The location id.
+          class LocationInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/type/color.rb

@@ -21,17 +21,22 @@ module Google
   module Type
     # Represents a color in the RGBA color space. This representation is designed
     # for simplicity of conversion to/from color representations in various
-    # languages over compactness; for example, the fields of this representation
-    # can be trivially provided to the constructor of "java.awt.Color" in Java; it
-    # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha"
+    # languages over compactness. For example, the fields of this representation
+    # can be trivially provided to the constructor of `java.awt.Color` in Java; it
+    # can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha`
     # method in iOS; and, with just a little work, it can be easily formatted into
-    # a CSS "rgba()" string in JavaScript, as well.
+    # a CSS `rgba()` string in JavaScript.
     #
-    # Note: this proto does not carry information about the absolute color space
+    # This reference page doesn't carry information about the absolute color
+    # space
     # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB,
-    # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color
+    # DCI-P3, BT.2020, etc.). By default, applications should assume the sRGB color
     # space.
     #
+    # When color equality needs to be decided, implementations, unless
+    # documented otherwise, treat two colors as equal if all their red,
+    # green, blue, and alpha values each differ by at most 1e-5.
+    #
     # Example (Java):
     #
     #      import com.google.type.Color;
@@ -117,7 +122,7 @@ module Google
     #        var blue = Math.floor(blueFrac * 255);
     #
     #        if (!('alpha' in rgb_color)) {
-    #           return rgbToCssColor_(red, green, blue);
+    #           return rgbToCssColor(red, green, blue);
     #        }
     #
     #        var alphaFrac = rgb_color.alpha.value || 0.0;
@@ -125,7 +130,7 @@ module Google
     #        return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
     #     };
     #
-    #     var rgbToCssColor_ = function(red, green, blue) {
+    #     var rgbToCssColor = function(red, green, blue) {
     #       var rgbNumber = new Number((red << 16) | (green << 8) | blue);
     #       var hexString = rgbNumber.toString(16);
     #       var missingZeros = 6 - hexString.length;
@@ -152,14 +157,14 @@ module Google
     #     The fraction of this color that should be applied to the pixel. That is,
     #     the final pixel color is defined by the equation:
     #
-    #       pixel color = alpha * (this color) + (1.0 - alpha) * (background color)
+    #       `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)`
     #
     #     This means that a value of 1.0 corresponds to a solid color, whereas
     #     a value of 0.0 corresponds to a completely transparent color. This
     #     uses a wrapper message rather than a simple float scalar so that it is
     #     possible to distinguish between a default value and the value being unset.
-    #     If omitted, this color object is to be rendered as a solid color
-    #     (as if the alpha value had been explicitly given with a value of 1.0).
+    #     If omitted, this color object is rendered as a solid color
+    #     (as if the alpha value had been explicitly given a value of 1.0).
     class Color
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods