RubyGems - google-cloud-document_ai-v1 - Versions diffs - 0.7.0 → 0.9.0 - Mend

google-cloud-document_ai-v1 0.7.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f05d6623e343422379c6377121682794560789ab36398946866e3bf43138a2c
-  data.tar.gz: d9029af403e535d370733de3c57cdf42b986139dcdfcf0d15f93071ed4cb526c
+  metadata.gz: 23ef9a502430698a1c55dbf3135c46b16db83bcea692d4d59486f2a412d5c8b8
+  data.tar.gz: fedc9cd1b4119b2a40e918c7d856ae6e6e9599d35fc62492a78577c93e05baf5
 SHA512:
-  metadata.gz: 2d9bac78790b5f4a1e55ab4421cb761e5316e016294e515da649615a0dc50f77081305d8b0d54ca87e454c624e91747faa1a43252e916955b5d42e337fcc2448
-  data.tar.gz: 7ea0aeca0945ab92ad417fdd901772b0ca69fc71c586e0b7d8616701b04e7314efbcb8005f9fa0dfa1e815450aa065f41a50af06aaf24ea2b9ba192722be61b2
+  metadata.gz: 3031d11fe9d45645810110bf58e728f7bf75cae916a4708b9d78a03a55df71408e35116934aa417975d5506001d0dff8ead57455636ba270c4922fd3bddae967
+  data.tar.gz: 154267b2196cefe2385f5a8f15ca6be64c721e484fe4d65e8fda516eead880b4bc9ffbf0166e67642dafe3c8f94734b1cb620eab390872e7c580b28f23f47ebb

data/lib/google/cloud/document_ai/v1/document_processor_service/client.rb CHANGED Viewed

@@ -212,11 +212,15 @@ module Google
             #   @param raw_document [::Google::Cloud::DocumentAI::V1::RawDocument, ::Hash]
             #     A raw document content (bytes).
             #   @param name [::String]
-            #     Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} or
+            #     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
+            #     to use for processing. If a
+            #     {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server
+            #     will use its [default
+            #     version][google.cloud.documentai.v1.Processor.default_processor_version].
+            #     Format: `projects/{project}/locations/{location}/processors/{processor}`,
+            #     or
             #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
             #   @param skip_human_review [::Boolean]
             #     Whether Human Review feature should be skipped for this request. Default to
@@ -310,7 +314,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The resource name of {::Google::Cloud::DocumentAI::V1::Processor Processor} or
+            #     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
@@ -583,6 +588,91 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
+            ##
+            # Gets a processor type detail.
+            #
+            # @overload get_processor_type(request, options = nil)
+            #   Pass arguments to `get_processor_type` via a request object, either of type
+            #   {::Google::Cloud::DocumentAI::V1::GetProcessorTypeRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DocumentAI::V1::GetProcessorTypeRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload get_processor_type(name: nil)
+            #   Pass arguments to `get_processor_type` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     Required. The processor type resource name.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::DocumentAI::V1::ProcessorType]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::DocumentAI::V1::ProcessorType]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/document_ai/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DocumentAI::V1::GetProcessorTypeRequest.new
+            #
+            #   # Call the get_processor_type method.
+            #   result = client.get_processor_type request
+            #
+            #   # The returned object is of type Google::Cloud::DocumentAI::V1::ProcessorType.
+            #   p result
+            #
+            def get_processor_type request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DocumentAI::V1::GetProcessorTypeRequest
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+              # Customize the options with defaults
+              metadata = @config.rpcs.get_processor_type.metadata.to_h
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::DocumentAI::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+              options.apply_defaults timeout:      @config.rpcs.get_processor_type.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.get_processor_type.retry_policy
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+              @document_processor_service_stub.call_rpc :get_processor_type, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
             ##
             # Lists all processors which belong to this project.
             #
@@ -602,8 +692,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The parent (project and location) which owns this collection of Processors.
-            #     Format: `projects/{project}/locations/{location}`
+            #     Required. The parent (project and location) which owns this collection of
+            #     Processors. Format: `projects/{project}/locations/{location}`
             #   @param page_size [::Integer]
             #     The maximum number of processors to return.
             #     If unspecified, at most 50 processors will be returned.
@@ -872,8 +962,9 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The parent (project, location and processor) to list all versions.
-            #     Format: `projects/{project}/locations/{location}/processors/{processor}`
+            #     Required. The parent (project, location and processor) to list all
+            #     versions. Format:
+            #     `projects/{project}/locations/{location}/processors/{processor}`
             #   @param page_size [::Integer]
             #     The maximum number of processor versions to return.
             #     If unspecified, at most 10 processor versions will be returned.
@@ -1253,11 +1344,12 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param parent [::String]
-            #     Required. The parent (project and location) under which to create the processor.
-            #     Format: `projects/{project}/locations/{location}`
+            #     Required. The parent (project and location) under which to create the
+            #     processor. Format: `projects/{project}/locations/{location}`
             #   @param processor [::Google::Cloud::DocumentAI::V1::Processor, ::Hash]
-            #     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.
+            #     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.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DocumentAI::V1::Processor]
@@ -1604,8 +1696,10 @@ module Google
             end
             ##
-            # Set the default (active) version of a {::Google::Cloud::DocumentAI::V1::Processor Processor} that will be used in
-            # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument} and
+            # Set the default (active) version of a
+            # {::Google::Cloud::DocumentAI::V1::Processor Processor} that will be used in
+            # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#process_document ProcessDocument}
+            # and
             # {::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client#batch_process_documents BatchProcessDocuments}.
             #
             # @overload set_default_processor_version(request, options = nil)
@@ -1624,10 +1718,13 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param processor [::String]
-            #     Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default version.
+            #     Required. The resource name of the
+            #     {::Google::Cloud::DocumentAI::V1::Processor Processor} to change default
+            #     version.
             #   @param default_processor_version [::String]
-            #     Required. The resource name of child {::Google::Cloud::DocumentAI::V1::ProcessorVersion ProcessorVersion} to use as default.
-            #     Format:
+            #     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}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
@@ -1724,8 +1821,8 @@ module Google
             #   @param inline_document [::Google::Cloud::DocumentAI::V1::Document, ::Hash]
             #     An inline document proto.
             #   @param human_review_config [::String]
-            #     Required. The resource name of the HumanReviewConfig that the document will be
-            #     reviewed with.
+            #     Required. The resource name of the HumanReviewConfig that the document will
+            #     be reviewed with.
             #   @param enable_schema_validation [::Boolean]
             #     Whether the validation should be performed on the ad-hoc review request.
             #   @param priority [::Google::Cloud::DocumentAI::V1::ReviewDocumentRequest::Priority]
@@ -1961,6 +2058,11 @@ module Google
                 #
                 attr_reader :list_processor_types
                 ##
+                # RPC-specific configuration for `get_processor_type`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :get_processor_type
+                ##
                 # RPC-specific configuration for `list_processors`
                 # @return [::Gapic::Config::Method]
                 #
@@ -2036,6 +2138,8 @@ module Google
                   @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
                   list_processor_types_config = parent_rpcs.list_processor_types if parent_rpcs.respond_to? :list_processor_types
                   @list_processor_types = ::Gapic::Config::Method.new list_processor_types_config
+                  get_processor_type_config = parent_rpcs.get_processor_type if parent_rpcs.respond_to? :get_processor_type
+                  @get_processor_type = ::Gapic::Config::Method.new get_processor_type_config
                   list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
                   @list_processors = ::Gapic::Config::Method.new list_processors_config
                   get_processor_config = parent_rpcs.get_processor if parent_rpcs.respond_to? :get_processor

data/lib/google/cloud/document_ai/v1/document_processor_service/paths.rb CHANGED Viewed

@@ -79,6 +79,25 @@ module Google
               "projects/#{project}/locations/#{location}/processors/#{processor}"
             end
+            ##
+            # Create a fully-qualified ProcessorType resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/processorTypes/{processor_type}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param processor_type [String]
+            #
+            # @return [::String]
+            def processor_type_path project:, location:, processor_type:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              "projects/#{project}/locations/#{location}/processorTypes/#{processor_type}"
+            end
             ##
             # Create a fully-qualified ProcessorVersion resource string.
             #

data/lib/google/cloud/document_ai/v1/document_processor_service.rb CHANGED Viewed

@@ -37,7 +37,7 @@ module Google
         # AI such as natural language, computer vision, and translation to extract
         # structured information from unstructured or semi-structured documents.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/document_ai/v1/document_processor_service"
         #     client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

data/lib/google/cloud/document_ai/v1/version.rb CHANGED Viewed

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module DocumentAI
       module V1
-        VERSION = "0.7.0"
+        VERSION = "0.9.0"
       end
     end
   end

data/lib/google/cloud/document_ai/v1.rb CHANGED Viewed

@@ -23,9 +23,9 @@ module Google
   module Cloud
     module DocumentAI
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/document_ai/v1"
       #     client = ::Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client.new

data/lib/google/cloud/documentai/v1/document_processor_service_pb.rb CHANGED Viewed

@@ -99,6 +99,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :processors, :message, 1, "google.cloud.documentai.v1.Processor"
       optional :next_page_token, :string, 2
     end
+    add_message "google.cloud.documentai.v1.GetProcessorTypeRequest" do
+      optional :name, :string, 1
+    end
     add_message "google.cloud.documentai.v1.GetProcessorRequest" do
       optional :name, :string, 1
     end
@@ -220,6 +223,7 @@ module Google
         ListProcessorTypesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ListProcessorTypesResponse").msgclass
         ListProcessorsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ListProcessorsRequest").msgclass
         ListProcessorsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ListProcessorsResponse").msgclass
+        GetProcessorTypeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.GetProcessorTypeRequest").msgclass
         GetProcessorRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.GetProcessorRequest").msgclass
         GetProcessorVersionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.GetProcessorVersionRequest").msgclass
         ListProcessorVersionsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.documentai.v1.ListProcessorVersionsRequest").msgclass

data/lib/google/cloud/documentai/v1/document_processor_service_services_pb.rb CHANGED Viewed

@@ -46,6 +46,8 @@ module Google
             rpc :FetchProcessorTypes, ::Google::Cloud::DocumentAI::V1::FetchProcessorTypesRequest, ::Google::Cloud::DocumentAI::V1::FetchProcessorTypesResponse
             # Lists the processor types that exist.
             rpc :ListProcessorTypes, ::Google::Cloud::DocumentAI::V1::ListProcessorTypesRequest, ::Google::Cloud::DocumentAI::V1::ListProcessorTypesResponse
+            # Gets a processor type detail.
+            rpc :GetProcessorType, ::Google::Cloud::DocumentAI::V1::GetProcessorTypeRequest, ::Google::Cloud::DocumentAI::V1::ProcessorType
             # Lists all processors which belong to this project.
             rpc :ListProcessors, ::Google::Cloud::DocumentAI::V1::ListProcessorsRequest, ::Google::Cloud::DocumentAI::V1::ListProcessorsResponse
             # Gets a processor detail.
@@ -71,8 +73,10 @@ module Google
             rpc :EnableProcessor, ::Google::Cloud::DocumentAI::V1::EnableProcessorRequest, ::Google::Longrunning::Operation
             # Disables a processor
             rpc :DisableProcessor, ::Google::Cloud::DocumentAI::V1::DisableProcessorRequest, ::Google::Longrunning::Operation
-            # Set the default (active) version of a [Processor][google.cloud.documentai.v1.Processor] that will be used in
-            # [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument] and
+            # Set the default (active) version of a
+            # [Processor][google.cloud.documentai.v1.Processor] that will be used in
+            # [ProcessDocument][google.cloud.documentai.v1.DocumentProcessorService.ProcessDocument]
+            # and
             # [BatchProcessDocuments][google.cloud.documentai.v1.DocumentProcessorService.BatchProcessDocuments].
             rpc :SetDefaultProcessorVersion, ::Google::Cloud::DocumentAI::V1::SetDefaultProcessorVersionRequest, ::Google::Longrunning::Operation
             # Send a document for Human Review. The input document should be processed by

data/lib/google/cloud/documentai/v1/processor_type_pb.rb CHANGED Viewed

@@ -15,6 +15,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :available_locations, :message, 4, "google.cloud.documentai.v1.ProcessorType.LocationInfo"
       optional :allow_creation, :bool, 6
       optional :launch_stage, :enum, 8, "google.api.LaunchStage"
+      repeated :sample_document_uris, :string, 9
     end
     add_message "google.cloud.documentai.v1.ProcessorType.LocationInfo" do
       optional :location_id, :string, 1

data/proto_docs/google/cloud/documentai/v1/document.rb CHANGED Viewed

@@ -47,22 +47,25 @@ module Google
         #     Optional. UTF-8 encoded text in reading order from the document.
         # @!attribute [rw] text_styles
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Style>]
-        #     Placeholder.  Styles for the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+        #     Styles for the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
         # @!attribute [rw] pages
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page>]
         #     Visual page layout for the {::Google::Cloud::DocumentAI::V1::Document Document}.
         # @!attribute [rw] entities
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>]
-        #     A list of entities detected on {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. For document shards,
-        #     entities in this list may cross shard boundaries.
+        #     A list of entities detected on
+        #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. For document
+        #     shards, entities in this list may cross shard boundaries.
         # @!attribute [rw] entity_relations
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::EntityRelation>]
-        #     Placeholder.  Relationship among {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}.
+        #     Placeholder.  Relationship among
+        #     {::Google::Cloud::DocumentAI::V1::Document#entities Document.entities}.
         # @!attribute [rw] text_changes
         #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextChange>]
-        #     Placeholder.  A list of text corrections made to {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.  This
-        #     is usually used for annotating corrections to OCR mistakes.  Text changes
-        #     for a given revision may not overlap with each other.
+        #     Placeholder.  A list of text corrections made to
+        #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.  This is usually
+        #     used for annotating corrections to OCR mistakes.  Text changes for a given
+        #     revision may not overlap with each other.
         # @!attribute [rw] shard_info
         #   @return [::Google::Cloud::DocumentAI::V1::Document::ShardInfo]
         #     Information about the sharding if this document is sharded part of a larger
@@ -88,7 +91,8 @@ module Google
           #     Total number of shards.
           # @!attribute [rw] text_offset
           #   @return [::Integer]
-          #     The index of the first character in {::Google::Cloud::DocumentAI::V1::Document#text Document.text} in the overall
+          #     The index of the first character in
+          #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text} in the overall
           #     document global text.
           class ShardInfo
             include ::Google::Protobuf::MessageExts
@@ -99,7 +103,8 @@ module Google
           # conventions as much as possible.
           # @!attribute [rw] text_anchor
           #   @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
-          #     Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+          #     Text anchor indexing into the
+          #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
           # @!attribute [rw] color
           #   @return [::Google::Type::Color]
           #     Text color.
@@ -146,9 +151,11 @@ module Google
           # A page in a {::Google::Cloud::DocumentAI::V1::Document Document}.
           # @!attribute [rw] page_number
           #   @return [::Integer]
-          #     1-based index for current {::Google::Cloud::DocumentAI::V1::Document::Page Page} in a parent {::Google::Cloud::DocumentAI::V1::Document Document}.
-          #     Useful when a page is taken out of a {::Google::Cloud::DocumentAI::V1::Document Document} for individual
-          #     processing.
+          #     1-based index for current
+          #     {::Google::Cloud::DocumentAI::V1::Document::Page Page} in a parent
+          #     {::Google::Cloud::DocumentAI::V1::Document Document}. Useful when a page is
+          #     taken out of a {::Google::Cloud::DocumentAI::V1::Document Document} for
+          #     individual processing.
           # @!attribute [rw] image
           #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Image]
           #     Rendered image for this page. This image is preprocessed to remove any
@@ -267,18 +274,23 @@ module Google
             # Visual element describing a layout unit on a page.
             # @!attribute [rw] text_anchor
             #   @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
-            #     Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+            #     Text anchor indexing into the
+            #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
             # @!attribute [rw] confidence
             #   @return [::Float]
-            #     Confidence of the current {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within context of the object this
-            #     layout is for. e.g. confidence can be for a single token, a table,
-            #     a visual element, etc. depending on context. Range `[0, 1]`.
+            #     Confidence of the current
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} within
+            #     context of the object this layout is for. e.g. confidence can be for a
+            #     single token, a table, a visual element, etc. depending on context.
+            #     Range `[0, 1]`.
             # @!attribute [rw] bounding_poly
             #   @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
-            #     The bounding polygon for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
+            #     The bounding polygon for the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
             # @!attribute [rw] orientation
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout::Orientation]
-            #     Detected orientation for the {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
+            #     Detected orientation for the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout}.
             class Layout
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -309,7 +321,8 @@ module Google
             # common line-spacing and orientation.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Block Block}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Block Block}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -324,7 +337,8 @@ module Google
             # A collection of lines that a human would perceive as a paragraph.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph Paragraph}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Paragraph Paragraph}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -340,7 +354,8 @@ module Google
             # Does not cross column boundaries, can be horizontal, vertical, etc.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Line Line}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Line Line}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -355,10 +370,12 @@ module Google
             # A detected token.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
             # @!attribute [rw] detected_break
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Token::DetectedBreak]
-            #     Detected break at the end of a {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
+            #     Detected break at the end of a
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -369,7 +386,8 @@ module Google
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
-              # Detected break at the end of a {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
+              # Detected break at the end of a
+              # {::Google::Cloud::DocumentAI::V1::Document::Page::Token Token}.
               # @!attribute [rw] type
               #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Token::DetectedBreak::Type]
               #     Detected break type.
@@ -397,7 +415,8 @@ module Google
             # A detected symbol.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Symbol Symbol}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Symbol Symbol}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -410,10 +429,12 @@ module Google
             # page.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
             # @!attribute [rw] type
             #   @return [::String]
-            #     Type of the {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
+            #     Type of the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::VisualElement VisualElement}.
             # @!attribute [rw] detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages together with confidence.
@@ -425,7 +446,8 @@ module Google
             # A table representation similar to HTML table structure.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Table Table}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Table Table}.
             # @!attribute [rw] header_rows
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableRow>]
             #     Header rows of the table.
@@ -454,7 +476,8 @@ module Google
               # A cell representation inside the table.
               # @!attribute [rw] layout
               #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-              #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableCell TableCell}.
+              #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+              #     {::Google::Cloud::DocumentAI::V1::Document::Page::Table::TableCell TableCell}.
               # @!attribute [rw] row_span
               #   @return [::Integer]
               #     How many rows this cell spans.
@@ -473,11 +496,13 @@ module Google
             # A form field detected on the page.
             # @!attribute [rw] field_name
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name. e.g. `Address`, `Email`,
-            #     `Grand total`, `Phone number`, etc.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} name.
+            #     e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
             # @!attribute [rw] field_value
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} value.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::FormField FormField} value.
             # @!attribute [rw] name_detected_languages
             #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Page::DetectedLanguage>]
             #     A list of detected languages for name together with confidence.
@@ -488,9 +513,10 @@ module Google
             #   @return [::String]
             #     If the value is non-textual, this field represents the type. Current
             #     valid values are:
-            #     - blank (this indicates the field_value is normal text)
-            #     - "unfilled_checkbox"
-            #     - "filled_checkbox"
+            #
+            #     - blank (this indicates the `field_value` is normal text)
+            #     - `unfilled_checkbox`
+            #     - `filled_checkbox`
             # @!attribute [rw] corrected_key_text
             #   @return [::String]
             #     Created for Labeling UI to export key text.
@@ -512,10 +538,12 @@ module Google
             # A detected barcode.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1::Document::Page::Layout]
-            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::Layout Layout} for
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
             # @!attribute [rw] barcode
             #   @return [::Google::Cloud::DocumentAI::V1::Barcode]
-            #     Detailed barcode information of the {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
+            #     Detailed barcode information of the
+            #     {::Google::Cloud::DocumentAI::V1::Document::Page::DetectedBarcode DetectedBarcode}.
             class DetectedBarcode
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -576,7 +604,8 @@ module Google
           # @!attribute [rw] text_anchor
           #   @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
           #     Optional. Provenance of the entity.
-          #     Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+          #     Text anchor indexing into the
+          #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
           # @!attribute [rw] type
           #   @return [::String]
           #     Required. Entity type from a schema e.g. `Address`.
@@ -591,28 +620,29 @@ module Google
           #     Optional. Confidence of detected Schema entity. Range `[0, 1]`.
           # @!attribute [rw] page_anchor
           #   @return [::Google::Cloud::DocumentAI::V1::Document::PageAnchor]
-          #     Optional. Represents the provenance of this entity wrt. the location on the
-          #     page where it was found.
+          #     Optional. Represents the provenance of this entity wrt. the location on
+          #     the page where it was found.
           # @!attribute [rw] id
           #   @return [::String]
           #     Optional. Canonical id. This will be a unique value in the entity list
           #     for this document.
           # @!attribute [rw] normalized_value
           #   @return [::Google::Cloud::DocumentAI::V1::Document::Entity::NormalizedValue]
-          #     Optional. Normalized entity value. Absent if the extracted value could not be
-          #     converted or the type (e.g. address) is not supported for certain
+          #     Optional. Normalized entity value. Absent if the extracted value could
+          #     not be converted or the type (e.g. address) is not supported for certain
           #     parsers. This field is also only populated for certain supported document
           #     types.
           # @!attribute [rw] properties
           #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::Entity>]
-          #     Optional. Entities can be nested to form a hierarchical data structure representing
-          #     the content in the document.
+          #     Optional. Entities can be nested to form a hierarchical data structure
+          #     representing the content in the document.
           # @!attribute [rw] provenance
           #   @return [::Google::Cloud::DocumentAI::V1::Document::Provenance]
           #     Optional. The history of this annotation.
           # @!attribute [rw] redacted
           #   @return [::Boolean]
-          #     Optional. Whether the entity will be redacted for de-identification purposes.
+          #     Optional. Whether the entity will be redacted for de-identification
+          #     purposes.
           class Entity
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -649,8 +679,8 @@ module Google
             #     Optional. An optional field to store a normalized string.
             #     For some entity types, one of respective `structured_value` fields may
             #     also be populated. Also not all the types of `structured_value` will be
-            #     normalized. For example, some processors may not generate float
-            #     or int normalized text by default.
+            #     normalized. For example, some processors may not generate `float`
+            #     or `integer` normalized text by default.
             #
             #     Below are sample formats mapped to structured values.
             #
@@ -663,7 +693,8 @@ module Google
             end
           end
-          # Relationship between {::Google::Cloud::DocumentAI::V1::Document::Entity Entities}.
+          # Relationship between
+          # {::Google::Cloud::DocumentAI::V1::Document::Entity Entities}.
           # @!attribute [rw] subject_id
           #   @return [::String]
           #     Subject entity id.
@@ -678,10 +709,12 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
-          # Text reference indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+          # Text reference indexing into the
+          # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
           # @!attribute [rw] text_segments
           #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment>]
-          #     The text segments from the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+          #     The text segments from the
+          #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
           # @!attribute [rw] content
           #   @return [::String]
           #     Contains the content of the text span so that users do
@@ -691,15 +724,20 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
-            # A text segment in the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. The indices may be out of bounds
-            # which indicate that the text extends into another document shard for
-            # large sharded documents. See {::Google::Cloud::DocumentAI::V1::Document::ShardInfo#text_offset ShardInfo.text_offset}
+            # A text segment in the
+            # {::Google::Cloud::DocumentAI::V1::Document#text Document.text}. The indices
+            # may be out of bounds which indicate that the text extends into another
+            # document shard for large sharded documents. See
+            # {::Google::Cloud::DocumentAI::V1::Document::ShardInfo#text_offset ShardInfo.text_offset}
             # @!attribute [rw] start_index
             #   @return [::Integer]
-            #     {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} start UTF-8 char index in the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
+            #     {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment}
+            #     start UTF-8 char index in the
+            #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
             # @!attribute [rw] end_index
             #   @return [::Integer]
-            #     {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment} half open end UTF-8 char index in the
+            #     {::Google::Cloud::DocumentAI::V1::Document::TextAnchor::TextSegment TextSegment}
+            #     half open end UTF-8 char index in the
             #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.
             class TextSegment
               include ::Google::Protobuf::MessageExts
@@ -707,9 +745,10 @@ module Google
             end
           end
-          # Referencing the visual context of the entity in the {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages}.
-          # Page anchors can be cross-page, consist of multiple bounding polygons and
-          # optionally reference specific layout element types.
+          # Referencing the visual context of the entity in the
+          # {::Google::Cloud::DocumentAI::V1::Document#pages Document.pages}. Page anchors
+          # can be cross-page, consist of multiple bounding polygons and optionally
+          # reference specific layout element types.
           # @!attribute [rw] page_refs
           #   @return [::Array<::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef>]
           #     One or more references to visual page elements
@@ -720,22 +759,29 @@ 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::V1::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
+            #     Required. Index into the
+            #     {::Google::Cloud::DocumentAI::V1::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::V1::Document::PageAnchor::PageRef::LayoutType]
-            #     Optional. The type of the layout element that is being referenced if any.
+            #     Optional. The type of the layout element that is being referenced if
+            #     any.
             # @!attribute [rw] layout_id
             #   @return [::String]
-            #     Optional. Deprecated.  Use {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly} instead.
+            #     Optional. Deprecated.  Use
+            #     {::Google::Cloud::DocumentAI::V1::Document::PageAnchor::PageRef#bounding_poly PageRef.bounding_poly}
+            #     instead.
             # @!attribute [rw] bounding_poly
             #   @return [::Google::Cloud::DocumentAI::V1::BoundingPoly]
-            #     Optional. Identifies the bounding polygon of a layout element on the page.
+            #     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]`.
+            #     Optional. Confidence of detected page element, if applicable. Range
+            #     `[0, 1]`.
             class PageRef
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -745,25 +791,38 @@ module Google
                 # Layout Unspecified.
                 LAYOUT_TYPE_UNSPECIFIED = 0
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#blocks Page.blocks} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#blocks Page.blocks}
+                # element.
                 BLOCK = 1
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#paragraphs Page.paragraphs}
+                # element.
                 PARAGRAPH = 2
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#lines Page.lines} element.
                 LINE = 3
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#tokens Page.tokens}
+                # element.
                 TOKEN = 4
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#visual_elements Page.visual_elements}
+                # element.
                 VISUAL_ELEMENT = 5
-                # Refrrences a {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables} element.
+                # Refrrences a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#tables Page.tables}
+                # element.
                 TABLE = 6
-                # References a {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields} element.
+                # References a
+                # {::Google::Cloud::DocumentAI::V1::Document::Page#form_fields Page.form_fields}
+                # element.
                 FORM_FIELD = 7
               end
             end
@@ -882,8 +941,9 @@ module Google
           # @!attribute [rw] text_anchor
           #   @return [::Google::Cloud::DocumentAI::V1::Document::TextAnchor]
           #     Provenance of the correction.
-          #     Text anchor indexing into the {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.  There can only be a
-          #     single `TextAnchor.text_segments` element.  If the start and
+          #     Text anchor indexing into the
+          #     {::Google::Cloud::DocumentAI::V1::Document#text Document.text}.  There can
+          #     only be a single `TextAnchor.text_segments` element.  If the start and
           #     end index of the text segment are the same, the text change is inserted
           #     before that index.
           # @!attribute [rw] changed_text

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

@@ -30,11 +30,15 @@ module Google
         #     A raw document content (bytes).
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The resource name of the {::Google::Cloud::DocumentAI::V1::Processor Processor} or
+        #     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
+        #     to use for processing. If a
+        #     {::Google::Cloud::DocumentAI::V1::Processor Processor} is specified, the server
+        #     will use its [default
+        #     version][google.cloud.documentai.v1.Processor.default_processor_version].
+        #     Format: `projects/{project}/locations/{location}/processors/{processor}`,
+        #     or
         #     `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
         # @!attribute [rw] skip_human_review
         #   @return [::Boolean]
@@ -105,7 +109,8 @@ module Google
         # Request message for batch process document method.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The resource name of {::Google::Cloud::DocumentAI::V1::Processor Processor} or
+        #     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
@@ -253,8 +258,8 @@ module Google
         # 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}`
+        #     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.
@@ -281,6 +286,15 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+        # Request message for get processor.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The processor type resource name.
+        class GetProcessorTypeRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
         # Request message for get processor.
         # @!attribute [rw] name
         #   @return [::String]
@@ -302,8 +316,9 @@ module Google
         # 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}`
+        #     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.
@@ -402,12 +417,13 @@ module Google
         # 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}`
+        #     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.
+        #     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
@@ -484,11 +500,14 @@ module Google
         # 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.
+        #     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:
+        #     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
@@ -517,8 +536,8 @@ module Google
         #     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.
+        #     Required. The resource name of the HumanReviewConfig that the document will
+        #     be reviewed with.
         # @!attribute [rw] enable_schema_validation
         #   @return [::Boolean]
         #     Whether the validation should be performed on the ad-hoc review request.

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

@@ -58,7 +58,7 @@ module Google
           #     conventions:
           #
           #     - *use `snake_casing`*
-          #     - name matching is case-insensitive
+          #     - name matching is case-sensitive
           #     - Maximum 64 characters.
           #     - Must start with a letter.
           #     - Allowed characters: ASCII letters `[a-z0-9_-]`.  (For backward

data/proto_docs/google/cloud/documentai/v1/processor.rb CHANGED Viewed

@@ -121,7 +121,8 @@ module Google
         #     The default processor version.
         # @!attribute [r] process_endpoint
         #   @return [::String]
-        #     Output only. Immutable. The http endpoint that can be called to invoke processing.
+        #     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.

data/proto_docs/google/cloud/documentai/v1/processor_type.rb CHANGED Viewed

@@ -43,6 +43,9 @@ module Google
         # @!attribute [rw] launch_stage
         #   @return [::Google::Api::LaunchStage]
         #     Launch stage of the processor type
+        # @!attribute [rw] sample_document_uris
+        #   @return [::Array<::String>]
+        #     A set of Cloud Storage URIs of sample documents for this processor.
         class ProcessorType
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Google LLC
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.16.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: 0.16.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.3'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -60,7 +60,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.3'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -254,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key:
 specification_version: 4
 summary: API Client library for the Document AI V1 API