google-apis-documentai_v1 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90d271cf9685a78ad2dd7d3e5a6f68ce8ea4228def3bd9e8908cc75e2c672276
-  data.tar.gz: bd54b0a10f031f392f8f48642c523e145e4c06ba9ff1e03b850d1837aba789dd
+  metadata.gz: 358880430803ef26497a94317660017acfd74fc45e1f8be76ff8f80d3c109087
+  data.tar.gz: 2dba20e265eca1fe053474f2fdc0fd88f65c770e6ac4956c0f0fb822b33e1fba
 SHA512:
-  metadata.gz: 7cd1e8f0012c8c69e0eeb36e0a6ed12ec9a5fa126650570cb061e83f9bdd39eb0d8d136fd5a70bbfcdba2eb7309667179bca1e2cb0ce3218a46db47a85d3cb6a
-  data.tar.gz: 9a783e14d0af2ceb22edc904f6323f309202c232f3b15015f8e3e7080ef40c6c212e1b9d51487dcdcb7fd2c6863b50e8a2e0d56c6d75b10b5ae790518ce6bacf
+  metadata.gz: fbb1519a16624d805c1cc7406f50b3d7d5e3dea8a519cb7ff54f3470fd8dac2ad24dffb4530ea808bd9e48ab140a1285d13e4765a1c2b5e52ab13efadcc81146
+  data.tar.gz: dbd2850c50b28459d14384ec4194213ee795d1408cd6178333d4e1e7a30462d9dc5d9785d4dd28aa9adeca995375d7458e5e78ff99f73952dd754e246c217a03

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-documentai_v1
 
+### v0.23.0 (2022-01-06)
+
+* Regenerated from discovery document revision 20211230
+* Unspecified changes
+
 ### v0.22.0 (2021-12-07)
 
 * Regenerated from discovery document revision 20211203

data/OVERVIEW.md

@@ -51,7 +51,7 @@ require "google/apis/documentai_v1"
 client = Google::Apis::DocumentaiV1::DocumentService.new
 
 # Authenticate calls
-client.authentication = # ... use the googleauth gem to create credentials
+client.authorization = # ... use the googleauth gem to create credentials
 ```
 
 See the class reference docs for information on the methods you can call from a client.

data/lib/google/apis/documentai_v1/classes.rb

@@ -881,7 +881,7 @@ module Google
         # @return [String]
         attr_accessor :input_gcs_source
       
-        # The output_gcs_destination (in the request as 'output_gcs_destination') of the
+        # The output_gcs_destination (in the request as `output_gcs_destination`) of the
         # processed document if it was successful, otherwise empty.
         # Corresponds to the JSON property `outputGcsDestination`
         # @return [String]
@@ -1259,7 +1259,7 @@ module Google
         end
       end
       
-      # An entity that could be a phrase in the text or a property belongs to the
+      # An entity that could be a phrase in the text or a property that belongs to the
       # document. It is a known entity type, such as a person, an organization, or
       # location.
       class GoogleCloudDocumentaiV1DocumentEntity
@@ -1417,8 +1417,8 @@ module Google
         attr_accessor :money_value
       
         # 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
+        # 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. Below are
         # sample formats mapped to structured values. - Money/Currency type (`
         # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
@@ -2259,7 +2259,7 @@ module Google
         attr_accessor :id
       
         # The index of the parent item in the corresponding item list (eg. list of
-        # entities, properties within entities, etc.) on parent revision.
+        # entities, properties within entities, etc.) in the parent revision.
         # Corresponds to the JSON property `index`
         # @return [Fixnum]
         attr_accessor :index
@@ -2958,7 +2958,7 @@ module Google
         end
       end
       
-      # The first-class citizen for DAI. Each processor defines how to extract
+      # The first-class citizen for Document AI. Each processor defines how to extract
       # structural information from a document.
       class GoogleCloudDocumentaiV1Processor
         include Google::Apis::Core::Hashable
@@ -2984,8 +2984,8 @@ module Google
         # @return [String]
         attr_accessor :kms_key_name
       
-        # Output only. Immutable. The resource name of the processor. Format: projects/`
-        # project`/locations/`location`/processors/`processor`
+        # Output only. Immutable. The resource name of the processor. Format: `projects/`
+        # project`/locations/`location`/processors/`processor``
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -3024,26 +3024,12 @@ module Google
       end
       
       # A processor type is responsible for performing a certain document
-      # understanding task on a certain type of document. All processor types are
-      # created by the documentai service internally. User will only list all
-      # available processor types via UI. For different users (projects), the
-      # available processor types may be different since we'll expose the access of
-      # some types via EAP whitelisting. We make the ProcessorType a resource under
-      # location so we have a unified API and keep the possibility that UI will load
-      # different available processor types from different regions. But for alpha the
-      # behavior is that the user will always get the union of all available processor
-      # types among all regions no matter which regionalized endpoint is called, and
-      # then we use the 'available_locations' field to show under which regions a
-      # processor type is available. For example, users can call either the 'US' or '
-      # EU' endpoint to feach processor types. In the return, we will have an 'invoice
-      # parsing' processor with 'available_locations' field only containing 'US'. So
-      # the user can try to create an 'invoice parsing' processor under the location '
-      # US'. Such attempt of creating under the location 'EU' will fail. Next ID: 9.
+      # understanding task on a certain type of document.
       class GoogleCloudDocumentaiV1ProcessorType
         include Google::Apis::Core::Hashable
       
-        # Whether the processor type allows creation. If yes, user can create a
-        # processor of this processor type. Otherwise, user needs to request access.
+        # Whether the processor type allows creation. If true, users can create a
+        # processor of this processor type. Otherwise, users need to request access.
         # Corresponds to the JSON property `allowCreation`
         # @return [Boolean]
         attr_accessor :allow_creation
@@ -3127,9 +3113,9 @@ module Google
         # @return [String]
         attr_accessor :display_name
       
-        # The resource name of the processor version. Format: projects/`project`/
+        # The resource name of the processor version. Format: `projects/`project`/
         # locations/`location`/processors/`processor`/processorVersions/`
-        # processor_version`
+        # processor_version``
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -3197,7 +3183,7 @@ module Google
         end
       end
       
-      # Request message for review document method. Next Id: 6.
+      # Request message for review document method.
       class GoogleCloudDocumentaiV1ReviewDocumentRequest
         include Google::Apis::Core::Hashable
       
@@ -3523,7 +3509,7 @@ module Google
         end
       end
       
-      # An entity that could be a phrase in the text or a property belongs to the
+      # An entity that could be a phrase in the text or a property that belongs to the
       # document. It is a known entity type, such as a person, an organization, or
       # location.
       class GoogleCloudDocumentaiV1beta1DocumentEntity
@@ -3681,8 +3667,8 @@ module Google
         attr_accessor :money_value
       
         # 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
+        # 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. Below are
         # sample formats mapped to structured values. - Money/Currency type (`
         # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
@@ -4484,7 +4470,7 @@ module Google
         attr_accessor :id
       
         # The index of the parent item in the corresponding item list (eg. list of
-        # entities, properties within entities, etc.) on parent revision.
+        # entities, properties within entities, etc.) in the parent revision.
         # Corresponds to the JSON property `index`
         # @return [Fixnum]
         attr_accessor :index
@@ -5250,7 +5236,7 @@ module Google
         end
       end
       
-      # An entity that could be a phrase in the text or a property belongs to the
+      # An entity that could be a phrase in the text or a property that belongs to the
       # document. It is a known entity type, such as a person, an organization, or
       # location.
       class GoogleCloudDocumentaiV1beta2DocumentEntity
@@ -5408,8 +5394,8 @@ module Google
         attr_accessor :money_value
       
         # 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
+        # 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. Below are
         # sample formats mapped to structured values. - Money/Currency type (`
         # money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in
@@ -6248,7 +6234,7 @@ module Google
         attr_accessor :id
       
         # The index of the parent item in the corresponding item list (eg. list of
-        # entities, properties within entities, etc.) on parent revision.
+        # entities, properties within entities, etc.) in the parent revision.
         # Corresponds to the JSON property `index`
         # @return [Fixnum]
         attr_accessor :index
@@ -6937,7 +6923,7 @@ module Google
         # @return [String]
         attr_accessor :input_gcs_source
       
-        # The output_gcs_destination (in the request as 'output_gcs_destination') of the
+        # The output_gcs_destination (in the request as `output_gcs_destination`) of the
         # processed document if it was successful, otherwise empty.
         # Corresponds to the JSON property `outputGcsDestination`
         # @return [String]

data/lib/google/apis/documentai_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DocumentaiV1
       # Version of the google-apis-documentai_v1 gem
-      GEM_VERSION = "0.22.0"
+      GEM_VERSION = "0.23.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20211203"
+      REVISION = "20211230"
     end
   end
 end

data/lib/google/apis/documentai_v1/service.rb

@@ -84,11 +84,12 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Fetches processor types.
+        # Fetches processor types. Note that we do not use ListProcessorTypes here
+        # because it is not paginated.
         # @param [String] parent
         #   Required. The project of processor type to list. The available processor types
-        #   may depend on the whitelisting on projects. Format: projects/`project`/
-        #   locations/`location`
+        #   may depend on the allow-listing on projects. Format: `projects/`project`/
+        #   locations/`location``
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -306,10 +307,10 @@ module Google
         # LRO endpoint to batch process many documents. The output is written to Cloud
         # Storage as JSON in the [Document] format.
         # @param [String] name
-        #   Required. The resource name of Processor or ProcessorVersion. Format: projects/
-        #   `project`/locations/`location`/processors/`processor`, or projects/`project`/
-        #   locations/`location`/processors/`processor`/processorVersions/`
-        #   processorVersion`
+        #   Required. The resource name of Processor or ProcessorVersion. Format: `
+        #   projects/`project`/locations/`location`/processors/`processor``, or `projects/`
+        #   project`/locations/`location`/processors/`processor`/processorVersions/`
+        #   processorVersion``
         # @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchProcessRequest] google_cloud_documentai_v1_batch_process_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -344,7 +345,7 @@ module Google
         # will be at "ENABLED" state by default after its creation.
         # @param [String] parent
         #   Required. The parent (project and location) under which to create the
-        #   processor. Format: projects/`project`/locations/`location`
+        #   processor. Format: `projects/`project`/locations/`location``
         # @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Processor] google_cloud_documentai_v1_processor_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -505,7 +506,7 @@ module Google
         # Lists all processors which belong to this project.
         # @param [String] parent
         #   Required. The parent (project and location) which owns this collection of
-        #   Processors. Format: projects/`project`/locations/`location`
+        #   Processors. Format: `projects/`project`/locations/`location``
         # @param [Fixnum] page_size
         #   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
@@ -546,9 +547,9 @@ module Google
         # @param [String] name
         #   Required. The resource name of the Processor or ProcessorVersion to use for
         #   processing. If a Processor is specified, the server will use its default
-        #   version. Format: projects/`project`/locations/`location`/processors/`processor`
-        #   , or projects/`project`/locations/`location`/processors/`processor`/
-        #   processorVersions/`processorVersion`
+        #   version. Format: `projects/`project`/locations/`location`/processors/`
+        #   processor``, or `projects/`project`/locations/`location`/processors/`processor`
+        #   /processorVersions/`processorVersion``
         # @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessRequest] google_cloud_documentai_v1_process_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -651,10 +652,10 @@ module Google
         # LRO endpoint to batch process many documents. The output is written to Cloud
         # Storage as JSON in the [Document] format.
         # @param [String] name
-        #   Required. The resource name of Processor or ProcessorVersion. Format: projects/
-        #   `project`/locations/`location`/processors/`processor`, or projects/`project`/
-        #   locations/`location`/processors/`processor`/processorVersions/`
-        #   processorVersion`
+        #   Required. The resource name of Processor or ProcessorVersion. Format: `
+        #   projects/`project`/locations/`location`/processors/`processor``, or `projects/`
+        #   project`/locations/`location`/processors/`processor`/processorVersions/`
+        #   processorVersion``
         # @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1BatchProcessRequest] google_cloud_documentai_v1_batch_process_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -782,7 +783,7 @@ module Google
         # Lists all versions of a processor.
         # @param [String] parent
         #   Required. The parent (project, location and processor) to list all versions.
-        #   Format: projects/`project`/locations/`location`/processors/`processor`
+        #   Format: `projects/`project`/locations/`location`/processors/`processor``
         # @param [Fixnum] page_size
         #   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
@@ -823,9 +824,9 @@ module Google
         # @param [String] name
         #   Required. The resource name of the Processor or ProcessorVersion to use for
         #   processing. If a Processor is specified, the server will use its default
-        #   version. Format: projects/`project`/locations/`location`/processors/`processor`
-        #   , or projects/`project`/locations/`location`/processors/`processor`/
-        #   processorVersions/`processorVersion`
+        #   version. Format: `projects/`project`/locations/`location`/processors/`
+        #   processor``, or `projects/`project`/locations/`location`/processors/`processor`
+        #   /processorVersions/`processorVersion``
         # @param [Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1ProcessRequest] google_cloud_documentai_v1_process_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-documentai_v1
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.22.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1/v0.23.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Document AI API V1