google-apis-documentai_v1beta3 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 329044d27895d51679036ff3bcfa51b45583540c73eaf087490c3e6270026b50
-  data.tar.gz: dd2d91c98e84f0c19fddddc6482ae50ee04ddfc7643478072822a951beafd71c
+  metadata.gz: 54881d713ec3072ff77587cb0ad006bedf24609dcd3426ab80f20927af272e99
+  data.tar.gz: b72e127a17eef359c96e69b8b6b8490b1050e40abf79f23bb9715d4dd0f83eb3
 SHA512:
-  metadata.gz: 1a679d401f801e4673633d2d671946b717567819d2c5fb1541704a1babe3bbc4590bb4f7b7ffbaa3ae233b3dda3be04814069d98ed428e358ad4f4890fc7af4a
-  data.tar.gz: faf45fdaa88ddf7bb98aa8b16ff2a463dadc9bb9b1f237d0f7418c7fc06087ec1af4f3f2707c345249dddc6dccabd063aaa1224fa303e546a818434f91ad2300
+  metadata.gz: 4eeb81c79c8ec2f94dce1c20f85235a8af04b0e5b2c5db5cd07c5a3e53a519db31bde7748bd09cb873ccb6ec82c80a58b8c421225c40294d55d07961f135acc2
+  data.tar.gz: b335e5b8c50cd9872b28628bada6ebf32c740f3d3c0dd328f3676387a5d1ccebcd616d4f641427a3984ed76be0d78d517a73d9b262e391717877d24d49f946c4

data/CHANGELOG.md

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

data/OVERVIEW.md

@@ -51,7 +51,7 @@ require "google/apis/documentai_v1beta3"
 client = Google::Apis::DocumentaiV1beta3::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_v1beta3/classes.rb

@@ -856,7 +856,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]
@@ -1363,7 +1363,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
@@ -1521,8 +1521,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
@@ -2324,7 +2324,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
@@ -3090,7 +3090,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
@@ -3248,8 +3248,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
@@ -4088,7 +4088,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
@@ -4802,7 +4802,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]
@@ -5239,7 +5239,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 GoogleCloudDocumentaiV1beta3DocumentEntity
@@ -5397,8 +5397,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
@@ -6239,7 +6239,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
@@ -6956,7 +6956,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 GoogleCloudDocumentaiV1beta3Processor
         include Google::Apis::Core::Hashable
@@ -6982,8 +6982,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
@@ -7022,26 +7022,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 GoogleCloudDocumentaiV1beta3ProcessorType
         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
@@ -7125,9 +7111,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
@@ -7220,7 +7206,7 @@ module Google
         end
       end
       
-      # Request message for review document method. Next Id: 6.
+      # Request message for review document method.
       class GoogleCloudDocumentaiV1beta3ReviewDocumentRequest
         include Google::Apis::Core::Hashable
       

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DocumentaiV1beta3
       # Version of the google-apis-documentai_v1beta3 gem
-      GEM_VERSION = "0.29.0"
+      GEM_VERSION = "0.30.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_v1beta3/service.rb

@@ -51,11 +51,12 @@ module Google
           @batch_path = 'batch'
         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
@@ -273,10 +274,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::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequest] google_cloud_documentai_v1beta3_batch_process_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -311,7 +312,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::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3Processor] google_cloud_documentai_v1beta3_processor_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -472,7 +473,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
@@ -513,9 +514,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::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessRequest] google_cloud_documentai_v1beta3_process_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -618,10 +619,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::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3BatchProcessRequest] google_cloud_documentai_v1beta3_batch_process_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -749,7 +750,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
@@ -790,9 +791,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::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ProcessRequest] google_cloud_documentai_v1beta3_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_v1beta3
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.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_v1beta3/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.29.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.30.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1beta3
 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 V1beta3