google-apis-discoveryengine_v1alpha 0.22.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c13ca72d119cad12e2e1445c5e2d48878a34269026159691976b315eaed78dd
-  data.tar.gz: f953015892fb521e7f2ab068397fb92d637ded26976d1728d89d634db4daef3a
+  metadata.gz: e8491e62c4d2ba6efede0bd3af9f48fa11e0449b1419558a5f5f77e874b4dc92
+  data.tar.gz: 2c4abb841cfc3214d3f951abbfe53857b11d222f20fafa9e24d4a98795bb0b72
 SHA512:
-  metadata.gz: d53093596560775764fcf708f9f11c564dd25fe44c46acce53175654e90eb5824bf38f4b9d60eae9c377e47d364ae5f034878125490bee25a20b1d162bae75c9
-  data.tar.gz: aa294cdfd80c35f7ec4407485d5a1bfd31fc84f2e4631e4c557cc3f1a40082ec07bfbd589f7e4445299330cb7efdb908dc5594d6499d70c6f93c598f9788b735
+  metadata.gz: 01f2da54e8a0351473587e41d5a80d7fd149a8b117555e265186ecef2d83f8960b5099c67ae7ba73f67f9052225ad36fbc5d263b63c336ab7ea48809e1a8db28
+  data.tar.gz: 2aacb8f70bc7926c229192a2e5fb328af26783bdc3323c64f4cdb1042bf7f0d319415de9fa4322c2a9b06b4771289554cc3a37b6f6c177cf1fc2c80b0d278c5b

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-discoveryengine_v1alpha
 
+### v0.24.0 (2023-10-15)
+
+* Regenerated from discovery document revision 20231003
+
+### v0.23.0 (2023-10-08)
+
+* Regenerated from discovery document revision 20230928
+
 ### v0.22.0 (2023-10-01)
 
 * Regenerated from discovery document revision 20230925

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

@@ -3521,6 +3521,11 @@ module Google
         # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseFacet>]
         attr_accessor :facets
       
+        # 
+        # Corresponds to the JSON property `geoSearchDebugInfo`
+        # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo>]
+        attr_accessor :geo_search_debug_info
+      
         # Guided search result. The guided search helps user to refine the search
         # results and narrow down to the real needs from a broaded search results.
         # Corresponds to the JSON property `guidedSearchResult`
@@ -3573,6 +3578,7 @@ module Google
           @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
           @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
           @facets = args[:facets] if args.key?(:facets)
+          @geo_search_debug_info = args[:geo_search_debug_info] if args.key?(:geo_search_debug_info)
           @guided_search_result = args[:guided_search_result] if args.key?(:guided_search_result)
           @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
           @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
@@ -3647,6 +3653,32 @@ module Google
         end
       end
       
+      # Debug information specifically related to forward geocoding issues arising
+      # from Geolocation Search.
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo
+        include Google::Apis::Core::Hashable
+      
+        # The error produced.
+        # Corresponds to the JSON property `errorMessage`
+        # @return [String]
+        attr_accessor :error_message
+      
+        # The address from which forward geocoding ingestion produced issues.
+        # Corresponds to the JSON property `originalAddressQuery`
+        # @return [String]
+        attr_accessor :original_address_query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @error_message = args[:error_message] if args.key?(:error_message)
+          @original_address_query = args[:original_address_query] if args.key?(:original_address_query)
+        end
+      end
+      
       # Guided search result. The guided search helps user to refine the search
       # results and narrow down to the real needs from a broaded search results.
       class GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult
@@ -4478,6 +4510,12 @@ module Google
         attr_accessor :llm_enabled
         alias_method :llm_enabled?, :llm_enabled
       
+        # Output only. Whether the customer accepted data use terms.
+        # Corresponds to the JSON property `minimumDataTermAccepted`
+        # @return [Boolean]
+        attr_accessor :minimum_data_term_accepted
+        alias_method :minimum_data_term_accepted?, :minimum_data_term_accepted
+      
         # Immutable. The full resource name of the widget config. Format: `projects/`
         # project`/locations/`location`/collections/`collection_id`/dataStores/`
         # data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
@@ -4486,6 +4524,13 @@ module Google
         # @return [String]
         attr_accessor :name
       
+        # The type of snippet to display in UCS widget. -
+        # RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-
+        # enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
+        # Corresponds to the JSON property `resultDisplayType`
+        # @return [String]
+        attr_accessor :result_display_type
+      
         # Required. Immutable. Specifies the solution type that this WidgetConfig can be
         # used for.
         # Corresponds to the JSON property `solutionType`
@@ -4520,7 +4565,9 @@ module Google
           @facet_field = args[:facet_field] if args.key?(:facet_field)
           @fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
           @llm_enabled = args[:llm_enabled] if args.key?(:llm_enabled)
+          @minimum_data_term_accepted = args[:minimum_data_term_accepted] if args.key?(:minimum_data_term_accepted)
           @name = args[:name] if args.key?(:name)
+          @result_display_type = args[:result_display_type] if args.key?(:result_display_type)
           @solution_type = args[:solution_type] if args.key?(:solution_type)
           @update_time = args[:update_time] if args.key?(:update_time)
         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.22.0"
+      GEM_VERSION = "0.24.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 = "20230925"
+      REVISION = "20231003"
     end
   end
 end

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

@@ -574,6 +574,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1714,6 +1720,8 @@ module Google
           property :corrected_query, as: 'correctedQuery'
           collection :facets, as: 'facets', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseFacet, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseFacet::Representation
       
+          collection :geo_search_debug_info, as: 'geoSearchDebugInfo', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo::Representation
+      
           property :guided_search_result, as: 'guidedSearchResult', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult::Representation
       
           property :next_page_token, as: 'nextPageToken'
@@ -1748,6 +1756,14 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :error_message, as: 'errorMessage'
+          property :original_address_query, as: 'originalAddressQuery'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1961,7 +1977,9 @@ module Google
           hash :fields_ui_components_map, as: 'fieldsUiComponentsMap', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField::Representation
       
           property :llm_enabled, as: 'llmEnabled'
+          property :minimum_data_term_accepted, as: 'minimumDataTermAccepted'
           property :name, as: 'name'
+          property :result_display_type, as: 'resultDisplayType'
           property :solution_type, as: 'solutionType'
           property :update_time, as: 'updateTime'
         end

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

@@ -1703,6 +1703,78 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Makes a recommendation, which requires a contextual user event.
+        # @param [String] serving_config
+        #   Required. Full resource name of the format: `projects/*/locations/global/
+        #   collections/*/dataStores/*/servingConfigs/*` Before you can request
+        #   recommendations from your model, you must create at least one serving config
+        #   for it.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse]
+        #
+        # @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 recommend_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+servingConfig}:recommend', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_recommend_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse
+          command.params['servingConfig'] = serving_config unless serving_config.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Performs a search.
+        # @param [String] serving_config
+        #   Required. The resource name of the Search serving config, such as `projects/*/
+        #   locations/global/collections/default_collection/dataStores/default_data_store/
+        #   servingConfigs/default_serving_config`. This field is used to identify the
+        #   serving configuration name, set of models used to make the search.
+        # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_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::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
+        #
+        # @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 search_project_location_collection_engine_serving_configs(serving_config, google_cloud_discoveryengine_v1alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1alpha/{+servingConfig}:search', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1alpha_search_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
+          command.params['servingConfig'] = serving_config unless serving_config.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 latest state of a long-running operation. Clients can use this method
         # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name

metadata

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