google-apis-documentai_v1beta3 0.83.0 → 0.84.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8a167b5f1ff25163151d91460d2c1203e47be78d8cd2e742e6edf49f8f76dd8
-  data.tar.gz: 37ef1b6b8619ac7cd9d8b74c7960009344c4e3a96ca3de70925a41849634c0bf
+  metadata.gz: d0aa8fb910b87ea903a3df5aace99d6b1185b9348d7a9bda37e06b15e8005921
+  data.tar.gz: 57b542ba69d8e400f413b12d82653644238198a2c97375c6869fbf662e7c534a
 SHA512:
-  metadata.gz: 415fd741f7d820949fe04e708e7210da67e92040ae14ec7a7c88bfde27a79b86d700baaa368014cd4adec8f9230d4c2862b4cdfc4649ae3291fe0b106dfeb3dd
-  data.tar.gz: b8428eb8a28ca91845b52c4ace1898ecc828cf86b9c78f7020c6d7d15bb92cf4bc020803765a516d28c1739b1905fa12056e82dc3f327cdaf39e101464fba312
+  metadata.gz: ed9f04e52fc8fa209421e2ec92e9172f71710b6a34aa0293b9fec07bb49d871afea9168028c5f79916e91fba89ec388762140cc8cc21991a291f219ce39d52b2
+  data.tar.gz: 9fa345b33459762099a65efdfd19ccd7f0dd35fed48036d3fb27727bc9622e1de1fcc4b337d803d98e6f74423e5703ef5f2c92ffa4fbbe124e61776b5696fa8a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-documentai_v1beta3
 
+### v0.84.0 (2023-10-01)
+
+* Regenerated from discovery document revision 20230923
+
 ### v0.83.0 (2023-09-24)
 
 * Regenerated from discovery document revision 20230914

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

@@ -6734,7 +6734,7 @@ module Google
       end
       
       # A singleton resource under a Processor which configures a collection of
-      # documents. Next Id: 8.
+      # documents.
       class GoogleCloudDocumentaiV1beta3Dataset
         include Google::Apis::Core::Hashable
       
@@ -7409,6 +7409,49 @@ module Google
         end
       end
       
+      # Metadata about a document.
+      class GoogleCloudDocumentaiV1beta3DocumentMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Type of the dataset split to which the document belongs.
+        # Corresponds to the JSON property `datasetType`
+        # @return [String]
+        attr_accessor :dataset_type
+      
+        # The display name of the document.
+        # Corresponds to the JSON property `displayName`
+        # @return [String]
+        attr_accessor :display_name
+      
+        # Document Identifier.
+        # Corresponds to the JSON property `documentId`
+        # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId]
+        attr_accessor :document_id
+      
+        # Labelling state of the document.
+        # Corresponds to the JSON property `labelingState`
+        # @return [String]
+        attr_accessor :labeling_state
+      
+        # Number of pages in the document.
+        # Corresponds to the JSON property `pageCount`
+        # @return [Fixnum]
+        attr_accessor :page_count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @dataset_type = args[:dataset_type] if args.key?(:dataset_type)
+          @display_name = args[:display_name] if args.key?(:display_name)
+          @document_id = args[:document_id] if args.key?(:document_id)
+          @labeling_state = args[:labeling_state] if args.key?(:labeling_state)
+          @page_count = args[:page_count] if args.key?(:page_count)
+        end
+      end
+      
       # Config that controls the output of documents. All documents will be written as
       # a JSON file.
       class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
@@ -10031,6 +10074,102 @@ module Google
         end
       end
       
+      # 
+      class GoogleCloudDocumentaiV1beta3ListDocumentsRequest
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Query to filter the documents based on https://google.aip.dev/160. ##
+        # Currently support query strings are: `SplitType=DATASET_SPLIT_TEST|
+        # DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED` - `LabelingState=
+        # DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED` - `DisplayName=\"
+        # file_name.pdf\"` - `EntityType=abc/def` - `TagName=\"auto-labeling-running\"|\"
+        # sampled\"` Note: - Only `AND`, `=` and `!=` are supported. e.g. `DisplayName=
+        # file_name AND EntityType!=abc` IS supported. - Wildcard `*` is supported only
+        # in `DisplayName` filter - No duplicate filter keys are allowed, e.g. `
+        # EntityType=a AND EntityType=b` is NOT supported. - String match is case
+        # sensitive (for filter `DisplayName` & `EntityType`).
+        # Corresponds to the JSON property `filter`
+        # @return [String]
+        attr_accessor :filter
+      
+        # The maximum number of documents to return. The service may return fewer than
+        # this value. If unspecified, at most 20 documents will be returned. The maximum
+        # value is 100; values above 100 will be coerced to 100.
+        # Corresponds to the JSON property `pageSize`
+        # @return [Fixnum]
+        attr_accessor :page_size
+      
+        # A page token, received from a previous `ListDocuments` call. Provide this to
+        # retrieve the subsequent page. When paginating, all other parameters provided
+        # to `ListDocuments` must match the call that provided the page token.
+        # Corresponds to the JSON property `pageToken`
+        # @return [String]
+        attr_accessor :page_token
+      
+        # Optional. Controls if the ListDocuments request requires a total size of
+        # matched documents. See ListDocumentsResponse.total_size. Enabling this flag
+        # may adversely impact performance. Defaults to false.
+        # Corresponds to the JSON property `returnTotalSize`
+        # @return [Boolean]
+        attr_accessor :return_total_size
+        alias_method :return_total_size?, :return_total_size
+      
+        # Optional. Number of results to skip beginning from the `page_token` if
+        # provided. https://google.aip.dev/158#skipping-results. It must be a non-
+        # negative integer. Negative values wil be rejected. Note that this is not the
+        # number of pages to skip. If this value causes the cursor to move past the end
+        # of results, `ListDocumentsResponse.document_metadata` and `
+        # ListDocumentsResponse.next_page_token` will be empty.
+        # Corresponds to the JSON property `skip`
+        # @return [Fixnum]
+        attr_accessor :skip
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @filter = args[:filter] if args.key?(:filter)
+          @page_size = args[:page_size] if args.key?(:page_size)
+          @page_token = args[:page_token] if args.key?(:page_token)
+          @return_total_size = args[:return_total_size] if args.key?(:return_total_size)
+          @skip = args[:skip] if args.key?(:skip)
+        end
+      end
+      
+      # 
+      class GoogleCloudDocumentaiV1beta3ListDocumentsResponse
+        include Google::Apis::Core::Hashable
+      
+        # Document metadata corresponding to the listed documents.
+        # Corresponds to the JSON property `documentMetadata`
+        # @return [Array<Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentMetadata>]
+        attr_accessor :document_metadata
+      
+        # A token, which can be sent as `page_token` to retrieve the next page. If this
+        # field is omitted, there are no subsequent pages.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # Total count of documents queried.
+        # Corresponds to the JSON property `totalSize`
+        # @return [Fixnum]
+        attr_accessor :total_size
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @total_size = args[:total_size] if args.key?(:total_size)
+        end
+      end
+      
       # The response from `ListEvaluations`.
       class GoogleCloudDocumentaiV1beta3ListEvaluationsResponse
         include Google::Apis::Core::Hashable
@@ -10179,7 +10318,7 @@ module Google
         alias_method :compute_style_info?, :compute_style_info
       
         # Turn off character box detector in OCR engine. Character box detection is
-        # enabled by default in OCR 2.0+ processors.
+        # enabled by default in OCR 2.0 (and later) processors.
         # Corresponds to the JSON property `disableCharacterBoxesDetection`
         # @return [Boolean]
         attr_accessor :disable_character_boxes_detection
@@ -10273,8 +10412,8 @@ module Google
         attr_accessor :enable_math_ocr
         alias_method :enable_math_ocr?, :enable_math_ocr
       
-        # Turn on selection mark detector in OCR engine. Only available in OCR 2.0+
-        # processors.
+        # Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and
+        # later) processors.
         # Corresponds to the JSON property `enableSelectionMarkDetection`
         # @return [Boolean]
         attr_accessor :enable_selection_mark_detection
@@ -10301,8 +10440,8 @@ module Google
         # @return [Fixnum]
         attr_accessor :from_end
       
-        # Only process certain pages from the start, process all if the document has
-        # less pages.
+        # Only process certain pages from the start. Process all if the document has
+        # fewer pages.
         # Corresponds to the JSON property `fromStart`
         # @return [Fixnum]
         attr_accessor :from_start

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.83.0"
+      GEM_VERSION = "0.84.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230914"
+      REVISION = "20230923"
     end
   end
 end

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

@@ -1318,6 +1318,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDocumentaiV1beta3DocumentMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1750,6 +1756,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDocumentaiV1beta3ListDocumentsRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDocumentaiV1beta3ListDocumentsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDocumentaiV1beta3ListEvaluationsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -4272,6 +4290,18 @@ module Google
         end
       end
       
+      class GoogleCloudDocumentaiV1beta3DocumentMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :dataset_type, as: 'datasetType'
+          property :display_name, as: 'displayName'
+          property :document_id, as: 'documentId', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentId::Representation
+      
+          property :labeling_state, as: 'labelingState'
+          property :page_count, as: 'pageCount'
+        end
+      end
+      
       class GoogleCloudDocumentaiV1beta3DocumentOutputConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -5033,6 +5063,27 @@ module Google
         end
       end
       
+      class GoogleCloudDocumentaiV1beta3ListDocumentsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :filter, as: 'filter'
+          property :page_size, as: 'pageSize'
+          property :page_token, as: 'pageToken'
+          property :return_total_size, as: 'returnTotalSize'
+          property :skip, as: 'skip'
+        end
+      end
+      
+      class GoogleCloudDocumentaiV1beta3ListDocumentsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :document_metadata, as: 'documentMetadata', class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentMetadata, decorator: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentMetadata::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+          property :total_size, as: 'totalSize'
+        end
+      end
+      
       class GoogleCloudDocumentaiV1beta3ListEvaluationsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -843,6 +843,40 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Returns a list of documents present in the dataset.
+        # @param [String] dataset
+        #   Required. The resource name of the dataset to be listed. Format: projects/`
+        #   project`/locations/`location`/processors/`processor`/dataset
+        # @param [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListDocumentsRequest] google_cloud_documentai_v1beta3_list_documents_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListDocumentsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListDocumentsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_processor_dataset_documents(dataset, google_cloud_documentai_v1beta3_list_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta3/{+dataset}:listDocuments', options)
+          command.request_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListDocumentsRequest::Representation
+          command.request_object = google_cloud_documentai_v1beta3_list_documents_request_object
+          command.response_representation = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListDocumentsResponse::Representation
+          command.response_class = Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3ListDocumentsResponse
+          command.params['dataset'] = dataset unless dataset.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Updates a `DatasetSchema`.
         # @param [String] name
         #   Dataset schema resource name. Format: `projects/`project`/locations/`location`/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-documentai_v1beta3
 version: !ruby/object:Gem::Version
-  version: 0.83.0
+  version: 0.84.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-24 00:00:00.000000000 Z
+date: 2023-10-01 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.83.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-documentai_v1beta3/v0.84.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-documentai_v1beta3
 post_install_message: 
 rdoc_options: []