google-cloud-document_ai-v1beta3 0.1.0 → 0.5.0

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # 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
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

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

@@ -509,7 +509,7 @@ module Google
           #     page where it was found.
           # @!attribute [rw] id
           #   @return [::String]
-          #     Canonical id. This will be a unique value in the entity list
+          #     Optional. Canonical id. This will be a unique value in the entity list
           #     for this document.
           # @!attribute [rw] normalized_value
           #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Entity::NormalizedValue]
@@ -556,6 +556,10 @@ module Google
             #
             #     https:
             #     github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
+            # @!attribute [rw] boolean_value
+            #   @return [::Boolean]
+            #     Boolean value. Can be used for entities with binary values, or for
+            #     checkboxes.
             # @!attribute [rw] text
             #   @return [::String]
             #     Required. Normalized entity value stored as a string. This field is populated for
@@ -651,7 +655,8 @@ module Google
             # Represents a weak reference to a page element within a document.
             # @!attribute [rw] page
             #   @return [::Integer]
-            #     Required. Index into the {::Google::Cloud::DocumentAI::V1beta3::Document#pages Document.pages} element
+            #     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.
             # @!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.

data/proto_docs/google/cloud/documentai/v1beta3/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 V1beta3
+        # 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::V1beta3::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::V1beta3::GcsPrefix]
+        #     The set of documents that match the specified Cloud Storage [gcs_prefix].
+        # @!attribute [rw] gcs_documents
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::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::V1beta3::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/v1beta3/document_processor_service.rb

@@ -22,6 +22,12 @@ module Google
     module DocumentAI
       module V1beta3
         # Request message for the process document method.
+        # @!attribute [rw] inline_document
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
+        #     An inline document proto.
+        # @!attribute [rw] raw_document
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::RawDocument]
+        #     A raw document content (bytes).
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The processor resource name.
@@ -37,6 +43,45 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The status of human review on a processed document.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::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::V1beta3::Document]
@@ -48,6 +93,9 @@ module Google
         #     review process is not triggered, this field will be empty. It has the same
         #     response type and metadata as the long running operation returned by
         #     ReviewDocument method.
+        # @!attribute [rw] human_review_status
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
+        #     The status of human review on the processed document.
         class ProcessResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -63,6 +111,16 @@ module Google
         # @!attribute [rw] output_config
         #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchProcessRequest::BatchOutputConfig]
         #     The overall output config for batch process.
+        # @!attribute [rw] input_documents
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::BatchDocumentsInputConfig]
+        #     The input documents for batch process.
+        # @!attribute [rw] document_output_config
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::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
@@ -138,6 +196,9 @@ module Google
           #     human review process is not triggered, this field will be empty. It has
           #     the same response type and metadata as the long running operation
           #     returned by ReviewDocument method.
+          # @!attribute [rw] human_review_status
+          #   @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
+          #     The status of human review on the processed document.
           class IndividualProcessStatus
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -169,6 +230,9 @@ module Google
         end
 
         # Request message for review document method.
+        # @!attribute [rw] inline_document
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::Document]
+        #     An inline document proto.
         # @!attribute [rw] human_review_config
         #   @return [::String]
         #     Required. The resource name of the HumanReviewConfig that the document will be
@@ -204,6 +268,9 @@ module Google
         # @!attribute [rw] update_time
         #   @return [::Google::Protobuf::Timestamp]
         #     The last update time of the operation.
+        # @!attribute [rw] common_metadata
+        #   @return [::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata]
+        #     The basic metadata of the long running operation.
         class ReviewDocumentOperationMetadata
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -229,6 +296,45 @@ 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/longrunning/operations.rb

@@ -25,7 +25,7 @@ module Google
     #   @return [::String]
     #     The server-assigned name, which is only unique within the same service that
     #     originally returns it. If you use the default HTTP mapping, the
-    #     `name` should have the format of `operations/some/unique/name`.
+    #     `name` should be a resource name ending with `operations/{unique_id}`.
     # @!attribute [rw] metadata
     #   @return [::Google::Protobuf::Any]
     #     Service-specific metadata associated with the operation.  It typically
@@ -35,7 +35,7 @@ module Google
     # @!attribute [rw] done
     #   @return [::Boolean]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [::Google::Rpc::Status]
@@ -67,7 +67,7 @@ module Google
     # The request message for Operations.ListOperations.
     # @!attribute [rw] name
     #   @return [::String]
-    #     The name of the operation collection.
+    #     The name of the operation's parent resource.
     # @!attribute [rw] filter
     #   @return [::String]
     #     The standard list filter.
@@ -112,6 +112,20 @@ module Google
       extend ::Google::Protobuf::MessageExts::ClassMethods
     end
 
+    # The request message for Operations.WaitOperation.
+    # @!attribute [rw] name
+    #   @return [::String]
+    #     The name of the operation resource to wait on.
+    # @!attribute [rw] timeout
+    #   @return [::Google::Protobuf::Duration]
+    #     The maximum duration to wait before timing out. If left blank, the wait
+    #     will be at most the time permitted by the underlying HTTP/RPC protocol.
+    #     If RPC context deadline is also specified, the shorter one will be used.
+    class WaitOperationRequest
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
     # A message representing the message types used by a long-running operation.
     #
     # Example:

data/proto_docs/google/protobuf/any.rb

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #

data/proto_docs/google/protobuf/timestamp.rb

@@ -70,7 +70,16 @@ module Google
     #         .setNanos((int) ((millis % 1000) * 1000000)).build();
     #
     #
-    # Example 5: Compute Timestamp from current time in Python.
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    #
+    # Example 6: Compute Timestamp from current time in Python.
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1beta3
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2021-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +152,9 @@ dependencies:
         version: '0.9'
 description: Document AI uses machine learning on a single cloud-based platform to
   automatically classify, extract, and enrich data within your documents to unlock
-  insights.
+  insights. Note that google-cloud-document_ai-v1beta3 is a version-specific client
+  library. For most uses, we recommend installing the main client library google-cloud-document_ai
+  instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -170,6 +172,7 @@ files:
 - lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb
 - lib/google/cloud/document_ai/v1beta3/document_processor_service/paths.rb
 - lib/google/cloud/document_ai/v1beta3/version.rb
+- lib/google/cloud/documentai/v1beta3/document_io_pb.rb
 - lib/google/cloud/documentai/v1beta3/document_pb.rb
 - lib/google/cloud/documentai/v1beta3/document_processor_service_pb.rb
 - lib/google/cloud/documentai/v1beta3/document_processor_service_services_pb.rb
@@ -178,6 +181,7 @@ files:
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
 - proto_docs/google/cloud/documentai/v1beta3/document.rb
+- proto_docs/google/cloud/documentai/v1beta3/document_io.rb
 - proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb
 - proto_docs/google/cloud/documentai/v1beta3/geometry.rb
 - proto_docs/google/longrunning/operations.rb
@@ -205,14 +209,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
 summary: API Client library for the Document AI V1beta3 API