google-apis-discoveryengine_v1alpha 0.40.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e020a3d7fe1af51fb4d90edc37ad6530ec625d30d4f935231cb5f358f5710884
-  data.tar.gz: 7cb9134ff492833fe171b1266bf0b06e0533f577c2b4b5dfebdcf2e155f81c36
+  metadata.gz: 145fa208491edaeb9d4163fcbd4692d5d3915f0cee5e8b355b9aa5bcfef15586
+  data.tar.gz: c1d2f4ac0565f2d9dc9165a09a4b72eb99303664adab5f41dd580acb63b106e1
 SHA512:
-  metadata.gz: 787263a0b31c58bbe02a146d7645b1e2c331839665f30d42f27da9a940bdb4a21e4e4da27d8a742c8148a150b55625b7faddead26b2257e6811c8f0f2f2b6278
-  data.tar.gz: d7bf892ea9a019cc741cac2698787e520e37464c1f501c4fac89e92107a11ccc5694af84fb08bc4277cec081e556cc45e25353271082bdca44a2a866e7605be4
+  metadata.gz: 881f2063ccc9c5e66ca1d120ffb87658144fba0c07f4821f34617d97f78a461bc39f660ebf7ce01dc147c922a19a0c8344f3b33631ca557f3fafe7d9100ea07c
+  data.tar.gz: 398a1bf7046058dca8be4028e7c397648822cf22c9b9d7f2638f6b18dc71a96b0e02f2ef118a2c9aff5324d95fe4bed362c00c8dc9e64d7046730ee1f40f13dc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-discoveryengine_v1alpha
 
+### v0.41.0 (2024-03-24)
+
+* Regenerated from discovery document revision 20240318
+
 ### v0.40.0 (2024-03-17)
 
 * Regenerated from discovery document revision 20240312

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

@@ -4926,6 +4926,33 @@ module Google
         end
       end
       
+      # Document captures all raw metadata information of items to be recommended or
+      # searched.
+      class GoogleCloudDiscoveryengineV1alphaProcessedDocument
+        include Google::Apis::Core::Hashable
+      
+        # Required. Full resource name of the referenced document, in the format `
+        # projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+        # Corresponds to the JSON property `document`
+        # @return [String]
+        attr_accessor :document
+      
+        # The JSON string representation of the processed document.
+        # Corresponds to the JSON property `jsonData`
+        # @return [String]
+        attr_accessor :json_data
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @document = args[:document] if args.key?(:document)
+          @json_data = args[:json_data] if args.key?(:json_data)
+        end
+      end
+      
       # Metadata related to the progress of the PurgeDocuments operation. This will be
       # returned by the google.longrunning.Operation.metadata field.
       class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
@@ -5988,7 +6015,10 @@ module Google
         # document a big demotion. However, results that are deeply relevant might still
         # be shown. The document will have an upstream battle to get a fairly high
         # ranking, but it is not blocked out completely. Setting to 0.0 means no boost
-        # applied. The boosting condition is ignored.
+        # applied. The boosting condition is ignored. Only one of the (condition, boost)
+        # combination or the boost_control_spec below are set. If both are set then the
+        # global boost is ignored and the more fine-grained boost_control_spec is
+        # applied.
         # Corresponds to the JSON property `boost`
         # @return [Float]
         attr_accessor :boost
@@ -6219,6 +6249,16 @@ module Google
         # @return [Fixnum]
         attr_accessor :summary_result_count
       
+        # If true, answer will be generated from most relevant chunks from top search
+        # results. This feature will improve summary quality. Please note that with this
+        # feature enabled, not all top search results will be referenced and included in
+        # the reference list, so the citation source index only points to the search
+        # results listed in the reference list.
+        # Corresponds to the JSON property `useSemanticChunks`
+        # @return [Boolean]
+        attr_accessor :use_semantic_chunks
+        alias_method :use_semantic_chunks?, :use_semantic_chunks
+      
         def initialize(**args)
            update!(**args)
         end
@@ -6232,6 +6272,7 @@ module Google
           @model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
           @model_spec = args[:model_spec] if args.key?(:model_spec)
           @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
+          @use_semantic_chunks = args[:use_semantic_chunks] if args.key?(:use_semantic_chunks)
         end
       end
       

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.40.0"
+      GEM_VERSION = "0.41.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.14.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240312"
+      REVISION = "20240318"
     end
   end
 end

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

@@ -928,6 +928,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaProcessedDocument
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -3167,6 +3173,14 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaProcessedDocument
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :document, as: 'document'
+          property :json_data, as: 'jsonData'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -3481,6 +3495,7 @@ module Google
           property :model_spec, as: 'modelSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec::Representation
       
           property :summary_result_count, as: 'summaryResultCount'
+          property :use_semantic_chunks, as: 'useSemanticChunks'
         end
       end
       

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

@@ -890,6 +890,47 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets the parsed layout information for a Document.
+        # @param [String] name
+        #   Required. Full resource name of Document, such as `projects/`project`/
+        #   locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
+        #   `branch`/documents/`document``. If the caller does not have permission to
+        #   access the Document, regardless of whether or not it exists, a `
+        #   PERMISSION_DENIED` error is returned. If the requested Document does not exist,
+        #   a `NOT_FOUND` error is returned.
+        # @param [String] processed_document_format
+        #   What format output should be. If unspecified, defaults to JSON.
+        # @param [String] processed_document_type
+        #   Required. What type of processing to return.
+        # @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::GoogleCloudDiscoveryengineV1alphaProcessedDocument] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument]
+        #
+        # @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_branch_document_processed_document(name, processed_document_format: nil, processed_document_type: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+name}:getProcessedDocument', options)
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument
+          command.params['name'] = name unless name.nil?
+          command.query['processedDocumentFormat'] = processed_document_format unless processed_document_format.nil?
+          command.query['processedDocumentType'] = processed_document_type unless processed_document_type.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Bulk import of multiple Documents. Request processing may be synchronous. Non-
         # existing items will be created. Note: It is possible for a subset of the
         # Documents to be successfully updated.
@@ -4143,6 +4184,47 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Gets the parsed layout information for a Document.
+        # @param [String] name
+        #   Required. Full resource name of Document, such as `projects/`project`/
+        #   locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
+        #   `branch`/documents/`document``. If the caller does not have permission to
+        #   access the Document, regardless of whether or not it exists, a `
+        #   PERMISSION_DENIED` error is returned. If the requested Document does not exist,
+        #   a `NOT_FOUND` error is returned.
+        # @param [String] processed_document_format
+        #   What format output should be. If unspecified, defaults to JSON.
+        # @param [String] processed_document_type
+        #   Required. What type of processing to return.
+        # @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::GoogleCloudDiscoveryengineV1alphaProcessedDocument] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument]
+        #
+        # @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_branch_document_processed_document(name, processed_document_format: nil, processed_document_type: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1alpha/{+name}:getProcessedDocument', options)
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument
+          command.params['name'] = name unless name.nil?
+          command.query['processedDocumentFormat'] = processed_document_format unless processed_document_format.nil?
+          command.query['processedDocumentType'] = processed_document_type unless processed_document_type.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Bulk import of multiple Documents. Request processing may be synchronous. Non-
         # existing items will be created. Note: It is possible for a subset of the
         # Documents to be successfully updated.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.41.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-17 00:00:00.000000000 Z
+date: 2024-03-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.40.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.41.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
 post_install_message: 
 rdoc_options: []