google-apis-discoveryengine_v1alpha 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01e199e758f187d04e45eb8ab25881bf8a7e81a0ad6470b8245cc4b2930f40e7
-  data.tar.gz: 73bae6449468b3c97aa62d5d59cd2567bcd620f2b8eba795ef0b59dc9e8f2cfb
+  metadata.gz: a7fdc13600bb0d0a75259ace1a752b91ed5024633691f81c586289c1ef372c41
+  data.tar.gz: 67aaa2dfe88369d205b8147945b485ef5b90a5d6ae6ab8348ccc77fd89cb4ec9
 SHA512:
-  metadata.gz: 6ce15c7093817b9f2f2dcefb906e5def44bcf397926bf297db75dce2e7d44b190f7608fbd93258703ed61b7a1b0f18357605b65bd85ae5c669061c460a824fc1
-  data.tar.gz: d2d315a46cdd0c0b4d5826a7fef0029baf140c62605c86b219f691f8d7f700d4cfe299f3d9852f6ba15c17be50927a8762175e0c8e596062aabc130d291beea1
+  metadata.gz: cd5b93d4e7eb636f7523cd5feaa4b2df18461ce2f019dc74b86ec1bd4f32e663cf094f4b1d7f19eda0f7360fb5cc7e32c1bdf4cbf4b7e6746deaf15a524d852e
+  data.tar.gz: f60d9a14b9f423d815a8638c19b40a9aceaf728d30d2e2ad07b0a9ed547c0bcbe7d3d5e270ed6ee614121daf6ca1fb9752d82a8b53dd080eed0f7bf3992ad47d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-discoveryengine_v1alpha
 
+### v0.31.0 (2023-12-24)
+
+* Regenerated from discovery document revision 20231218
+
 ### v0.30.0 (2023-12-17)
 
 * Regenerated from discovery document revision 20231209

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

@@ -1734,6 +1734,34 @@ module Google
         end
       end
       
+      # A singleton resource of DataStore. It's empty when DataStore is created, which
+      # defaults to digital parser. The first call to DataStoreService.
+      # UpdateDocumentProcessingConfig method will initialize the config.
+      class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
+        include Google::Apis::Core::Hashable
+      
+        # Output only. The full resource name of the Document Processing Config. Format:
+        # `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        # The OCR options for parsing documents.
+        # Corresponds to the JSON property `ocrConfig`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaOcrConfig]
+        attr_accessor :ocr_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @name = args[:name] if args.key?(:name)
+          @ocr_config = args[:ocr_config] if args.key?(:ocr_config)
+        end
+      end
+      
       # Double list.
       class GoogleCloudDiscoveryengineV1alphaDoubleList
         include Google::Apis::Core::Hashable
@@ -3124,6 +3152,42 @@ module Google
         end
       end
       
+      # The OCR options for parsing documents.
+      class GoogleCloudDiscoveryengineV1alphaOcrConfig
+        include Google::Apis::Core::Hashable
+      
+        # Required. If OCR is enabled or not. OCR must be enabled for other OcrConfig
+        # options to apply.
+        # Corresponds to the JSON property `enabled`
+        # @return [Boolean]
+        attr_accessor :enabled
+        alias_method :enabled?, :enabled
+      
+        # Apply additional enhanced OCR processing to a list of document elements.
+        # Supported values: * `table`: advanced table parsing model.
+        # Corresponds to the JSON property `enhancedDocumentElements`
+        # @return [Array<String>]
+        attr_accessor :enhanced_document_elements
+      
+        # If true, will use native text instead of OCR text on pages containing native
+        # text.
+        # Corresponds to the JSON property `useNativeText`
+        # @return [Boolean]
+        attr_accessor :use_native_text
+        alias_method :use_native_text?, :use_native_text
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @enabled = args[:enabled] if args.key?(:enabled)
+          @enhanced_document_elements = args[:enhanced_document_elements] if args.key?(:enhanced_document_elements)
+          @use_native_text = args[:use_native_text] if args.key?(:use_native_text)
+        end
+      end
+      
       # Detailed page information.
       class GoogleCloudDiscoveryengineV1alphaPageInfo
         include Google::Apis::Core::Hashable

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1alpha
       # Version of the google-apis-discoveryengine_v1alpha gem
-      GEM_VERSION = "0.30.0"
+      GEM_VERSION = "0.31.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 = "20231209"
+      REVISION = "20231218"
     end
   end
 end

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

@@ -322,6 +322,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaDoubleList
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -574,6 +580,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaOcrConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaPageInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1621,6 +1633,15 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :name, as: 'name'
+          property :ocr_config, as: 'ocrConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaOcrConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaOcrConfig::Representation
+      
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaDoubleList
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2019,6 +2040,15 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaOcrConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :enabled, as: 'enabled'
+          collection :enhanced_document_elements, as: 'enhancedDocumentElements'
+          property :use_native_text, as: 'useNativeText'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaPageInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -473,6 +473,38 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets a DocumentProcessingConfig.
+        # @param [String] name
+        #   Required. Full DocumentProcessingConfig resource name. Format: `projects/`
+        #   project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
+        #   `data_store_id`/documentProcessingConfig`
+        # @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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig]
+        #
+        # @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 get_project_location_collection_data_store_document_processing_config(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+name}', options)
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the SiteSearchEngine.
         # @param [String] name
         #   Required. Resource name of SiteSearchEngine, such as `projects/`project`/
@@ -631,6 +663,47 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon
+        # resource of DataStore. It's empty when DataStore is created. The first call to
+        # this method will set up DocumentProcessingConfig.
+        # @param [String] name
+        #   Output only. The full resource name of the Document Processing Config. Format:
+        #   `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig] google_cloud_discoveryengine_v1alpha_document_processing_config_object
+        # @param [String] update_mask
+        #   Indicates which fields in the provided DocumentProcessingConfig to update. The
+        #   following are the only supported fields: * DocumentProcessingConfig.orc_config
+        #   If not set, all supported fields are updated.
+        # @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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig]
+        #
+        # @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 update_project_location_collection_data_store_document_processing_config(name, google_cloud_discoveryengine_v1alpha_document_processing_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1alpha/{+name}', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_document_processing_config_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a Document.
         # @param [String] parent
         #   Required. The parent resource name, such as `projects/`project`/locations/`
@@ -3308,6 +3381,38 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets a DocumentProcessingConfig.
+        # @param [String] name
+        #   Required. Full DocumentProcessingConfig resource name. Format: `projects/`
+        #   project_number`/locations/`location_id`/collections/`collection_id`/dataStores/
+        #   `data_store_id`/documentProcessingConfig`
+        # @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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig]
+        #
+        # @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 get_project_location_data_store_document_processing_config(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+name}', options)
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the SiteSearchEngine.
         # @param [String] name
         #   Required. Resource name of SiteSearchEngine, such as `projects/`project`/
@@ -3431,6 +3536,47 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon
+        # resource of DataStore. It's empty when DataStore is created. The first call to
+        # this method will set up DocumentProcessingConfig.
+        # @param [String] name
+        #   Output only. The full resource name of the Document Processing Config. Format:
+        #   `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig] google_cloud_discoveryengine_v1alpha_document_processing_config_object
+        # @param [String] update_mask
+        #   Indicates which fields in the provided DocumentProcessingConfig to update. The
+        #   following are the only supported fields: * DocumentProcessingConfig.orc_config
+        #   If not set, all supported fields are updated.
+        # @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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig]
+        #
+        # @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 update_project_location_data_store_document_processing_config(name, google_cloud_discoveryengine_v1alpha_document_processing_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v1alpha/{+name}', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_document_processing_config_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a Document.
         # @param [String] parent
         #   Required. The parent resource name, such as `projects/`project`/locations/`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-17 00:00:00.000000000 Z
+date: 2023-12-24 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-discoveryengine_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.30.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.31.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
 post_install_message: 
 rdoc_options: []