google-cloud-document_ai-v1 0.4.0 → 0.6.0

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

@@ -30,11 +30,21 @@ module Google
         #     A raw document content (bytes).
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The processor resource name.
+        #     Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} or
+        #     {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}
+        #     to use for processing. If a {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server will use
+        #     its {::Google::Cloud::DocumentAI::V1::Processor#default_processor_version default version}. Format:
+        #     `projects/{project}/locations/{location}/processors/{processor}`, or
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
         # @!attribute [rw] skip_human_review
         #   @return [::Boolean]
         #     Whether Human Review feature should be skipped for this request. Default to
         #     false.
+        # @!attribute [rw] field_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Specifies which fields to include in ProcessResponse's document.
+        #     Only supports top level document and pages field so it must be in the form
+        #     of `{document_field_name}` or `pages.{page_field_name}`.
         class ProcessRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -95,7 +105,11 @@ module Google
         # Request message for batch process document method.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The processor resource name.
+        #     Required. The resource name of {::Google::Cloud::DocumentAI::V1::Processor Processor} or
+        #     {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion}.
+        #     Format: `projects/{project}/locations/{location}/processors/{processor}`,
+        #     or
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
         # @!attribute [rw] input_documents
         #   @return [::Google::Cloud::DocumentAI::V1::BatchDocumentsInputConfig]
         #     The input documents for batch process.
@@ -147,10 +161,10 @@ module Google
           #     document during the process.
           # @!attribute [rw] status
           #   @return [::Google::Rpc::Status]
-          #     The status of the processing of the document.
+          #     The status processing the document.
           # @!attribute [rw] output_gcs_destination
           #   @return [::String]
-          #     The output_gcs_destination (in the request as 'output_gcs_destination')
+          #     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]
@@ -185,6 +199,318 @@ module Google
           end
         end
 
+        # Request message for fetch processor types.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The project of processor type to list.
+        #     The available processor types may depend on the allow-listing on projects.
+        #     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::V1::ProcessorType>]
+        #     The list of processor types.
+        class FetchProcessorTypesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for list processor types.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The location of processor type to list.
+        #     The available processor types may depend on the allow-listing on projects.
+        #     Format: `projects/{project}/locations/{location}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     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.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Used to retrieve the next page of results, empty if at the end of the list.
+        class ListProcessorTypesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for list processor types.
+        # @!attribute [rw] processor_types
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1::ProcessorType>]
+        #     The processor types.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Points to the next page, otherwise empty.
+        class ListProcessorTypesResponse
+          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::V1::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 get processor.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor resource name.
+        class GetProcessorRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for get processor version.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor resource name.
+        class GetProcessorVersionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for list all processor versions belongs to a processor.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent (project, location and processor) to list all versions.
+        #     Format: `projects/{project}/locations/{location}/processors/{processor}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     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.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     We will return the processor versions sorted by creation time. The page
+        #     token will point to the next processor version.
+        class ListProcessorVersionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for list processors.
+        # @!attribute [rw] processor_versions
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1::ProcessorVersion>]
+        #     The list of processors.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Points to the next processor, otherwise empty.
+        class ListProcessorVersionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the delete processor version method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor version resource name to be deleted.
+        class DeleteProcessorVersionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for delete processor version method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class DeleteProcessorVersionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the deploy processor version method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor version resource name to be deployed.
+        class DeployProcessorVersionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the deploy processor version method.
+        class DeployProcessorVersionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for deploy processor version method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class DeployProcessorVersionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the undeploy processor version method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor version resource name to be undeployed.
+        class UndeployProcessorVersionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for the undeploy processor version method.
+        class UndeployProcessorVersionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for the undeploy processor version
+        # method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class UndeployProcessorVersionMetadata
+          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::V1::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::V1::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.
+        # Intentionally empty proto for adding fields in future.
+        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::V1::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.
+        # Intentionally empty proto for adding fields in future.
+        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::V1::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class DisableProcessorMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for the set default processor version method.
+        # @!attribute [rw] processor
+        #   @return [::String]
+        #     Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default version.
+        # @!attribute [rw] default_processor_version
+        #   @return [::String]
+        #     Required. The resource name of child {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as default.
+        #     Format:
+        #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{version}`
+        class SetDefaultProcessorVersionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for set default processor version method.
+        class SetDefaultProcessorVersionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The long running operation metadata for set default processor version
+        # method.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
+        class SetDefaultProcessorVersionMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for review document method.
         # @!attribute [rw] inline_document
         #   @return [::Google::Cloud::DocumentAI::V1::Document]
@@ -199,6 +525,9 @@ module Google
         # @!attribute [rw] priority
         #   @return [::Google::Cloud::DocumentAI::V1::ReviewDocumentRequest::Priority]
         #     The priority of the human review task.
+        # @!attribute [rw] document_schema
+        #   @return [::Google::Cloud::DocumentAI::V1::DocumentSchema]
+        #     The document schema of the human review task.
         class ReviewDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -217,10 +546,29 @@ module Google
         # Response message for review document method.
         # @!attribute [rw] gcs_destination
         #   @return [::String]
-        #     The Cloud Storage uri for the human reviewed document.
+        #     The Cloud Storage uri for the human reviewed document if the review is
+        #     succeeded.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DocumentAI::V1::ReviewDocumentResponse::State]
+        #     The state of the review operation.
+        # @!attribute [rw] rejection_reason
+        #   @return [::String]
+        #     The reason why the review is rejected by reviewer.
         class ReviewDocumentResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Possible states of the review operation.
+          module State
+            # The default value. This value is used if the state is omitted.
+            STATE_UNSPECIFIED = 0
+
+            # The review operation is rejected by the reviewer.
+            REJECTED = 1
+
+            # The review operation is succeeded.
+            SUCCEEDED = 2
+          end
         end
 
         # The long running operation metadata for review document method.
@@ -229,7 +577,7 @@ module Google
         #     The basic metadata of the long running operation.
         # @!attribute [rw] question_id
         #   @return [::String]
-        #     The question ID.
+        #     The Crowd Compute question ID.
         class ReviewDocumentOperationMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 schema defines the output of the processed document by a processor.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Display name to show to users.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Description of the schema.
+        # @!attribute [rw] entity_types
+        #   @return [::Array<::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType>]
+        #     Entity types of the schema.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Cloud::DocumentAI::V1::DocumentSchema::Metadata]
+        #     Metadata of the schema.
+        class DocumentSchema
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # EntityType is the wrapper of a label of the corresponding model with
+          # detailed attributes and limitations for entity-based processors. Multiple
+          # types can also compose a dependency tree to represent nested types.
+          # @!attribute [rw] enum_values
+          #   @return [::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::EnumValues]
+          #     If specified, lists all the possible values for this entity.  This
+          #     should not be more than a handful of values.  If the number of values
+          #     is >10 or could change frequently use the `EntityType.value_ontology`
+          #     field and specify a list of all possible values in a value ontology
+          #     file.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     User defined name for the type.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Name of the type. It must be unique within the schema file and
+          #     cannot be a 'Common Type'.  Besides that we use the following naming
+          #     conventions:
+          #
+          #     - *use `snake_casing`*
+          #     - name matching is case-insensitive
+          #     - Maximum 64 characters.
+          #     - Must start with a letter.
+          #     - Allowed characters: ASCII letters `[a-z0-9_-]`.  (For backward
+          #       compatibility internal infrastructure and tooling can handle any ascii
+          #       character)
+          #     - The `/` is sometimes used to denote a property of a type.  For example
+          #       `line_item/amount`.  This convention is deprecated, but will still be
+          #       honored for backward compatibility.
+          # @!attribute [rw] base_types
+          #   @return [::Array<::String>]
+          #     The entity type that this type is derived from.  For now, one and only
+          #     one should be set.
+          # @!attribute [rw] properties
+          #   @return [::Array<::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::Property>]
+          #     Describing the nested structure, or composition of an entity.
+          class EntityType
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Defines the a list of enum values.
+            # @!attribute [rw] values
+            #   @return [::Array<::String>]
+            #     The individual values that this enum values type can include.
+            class EnumValues
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Defines properties that can be part of the entity type.
+            # @!attribute [rw] name
+            #   @return [::String]
+            #     The name of the property.  Follows the same guidelines as the
+            #     EntityType name.
+            # @!attribute [rw] value_type
+            #   @return [::String]
+            #     A reference to the value type of the property.  This type is subject
+            #     to the same conventions as the `Entity.base_types` field.
+            # @!attribute [rw] occurrence_type
+            #   @return [::Google::Cloud::DocumentAI::V1::DocumentSchema::EntityType::Property::OccurrenceType]
+            #     Occurrence type limits the number of instances an entity type appears
+            #     in the document.
+            class Property
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Types of occurrences of the entity type in the document.  Note: this
+              # represents the number of instances of an entity types, not number of
+              # mentions of a given entity instance.
+              module OccurrenceType
+                # Unspecified occurrence type.
+                OCCURRENCE_TYPE_UNSPECIFIED = 0
+
+                # There will be zero or one instance of this entity type.
+                OPTIONAL_ONCE = 1
+
+                # The entity type will appear zero or multiple times.
+                OPTIONAL_MULTIPLE = 2
+
+                # The entity type will only appear exactly once.
+                REQUIRED_ONCE = 3
+
+                # The entity type will appear once or more times.
+                REQUIRED_MULTIPLE = 4
+              end
+            end
+          end
+
+          # Metadata for global schema behavior.
+          # @!attribute [rw] document_splitter
+          #   @return [::Boolean]
+          #     If true, a `document` entity type can be applied to subdocument (
+          #     splitting). Otherwise, it can only be applied to the entire document
+          #     (classification).
+          # @!attribute [rw] document_allow_multiple_labels
+          #   @return [::Boolean]
+          #     If true, on a given page, there can be multiple `document` annotations
+          #     covering it.
+          # @!attribute [rw] prefixed_naming_on_properties
+          #   @return [::Boolean]
+          #     If set, all the nested entities must be prefixed with the parents.
+          # @!attribute [rw] skip_naming_validation
+          #   @return [::Boolean]
+          #     If set, we will skip the naming format validation in the schema. So the
+          #     string values in `DocumentSchema.EntityType.name` and
+          #     `DocumentSchema.EntityType.Property.name` will not be checked.
+          class Metadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -28,6 +28,9 @@ module Google
         # @!attribute [rw] state_message
         #   @return [::String]
         #     A message providing more details about the current state of processing.
+        # @!attribute [rw] resource
+        #   @return [::String]
+        #     A related resource to this operation.
         # @!attribute [rw] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     The creation time of the operation.