google-apis-retail_v2 0.116.0 → 0.118.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b58c649b3457527ddf1fb6baf1e1b2a71738cc861f23b8b4dbd1332ef7c6a01
-  data.tar.gz: f21325e508547ae256ff96f2064d5a6b1cb950eb7fed4b8ae0dd8d447b1e9e14
+  metadata.gz: a36e4210d95b72910e626858d39941ba285f66ae86e1c5c9b3dfcbbc46d07ee5
+  data.tar.gz: dc45e2e42df222e86abc4bf01c0c5c16f56ec2b8bfc304039c759df8fb059823
 SHA512:
-  metadata.gz: a88c35ca22fe5aee466559809b7f33484a15fe6b4fbbe8a96fab4864093d045320745d9ae70b874a90ea544cf993a4238f7c8335ea72999137c0c579bb608b70
-  data.tar.gz: ec2648899088369bfb72495e732e85ce98e233d24677a7a77e6b3d556f392f8002a3bdccc0990eb1211f393606349d26fe1191f2ffb92613c56a142c325ab793
+  metadata.gz: 19b644583972b6087ac40f84309562deaf9abd26f41f63cedd7a28f0cd4077e41019b9ba64f43d5a55ffbd76674f60f0587f92e086a3b3ff4a05daa4f74df1eb
+  data.tar.gz: ac39f51fa59a4ae291bcbdab4ff71b13317425572422e0cccbe6175a92769b851baff897805d2250011133142b38f278a68c680d78b248536701733af7e99e89

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-retail_v2
 
+### v0.118.0 (2025-06-22)
+
+* Regenerated from discovery document revision 20250613
+* Regenerated using generator version 0.18.0
+
+### v0.117.0 (2025-05-21)
+
+* Regenerated from discovery document revision 20250515
+
 ### v0.116.0 (2025-05-18)
 
 * Regenerated from discovery document revision 20250508

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

@@ -1552,6 +1552,41 @@ module Google
         end
       end
       
+      # The public proto to represent the conversational search customization config.
+      # It will be converted to the internal proto in the backend.
+      class GoogleCloudRetailV2ConversationalSearchCustomizationConfig
+        include Google::Apis::Core::Hashable
+      
+        # Required. Resource name of the catalog. Format: projects/`project`/locations/`
+        # location`/catalogs/`catalog`
+        # Corresponds to the JSON property `catalog`
+        # @return [String]
+        attr_accessor :catalog
+      
+        # The public proto to represent the intent classification config. It will be
+        # converted to the internal proto in the backend.
+        # Corresponds to the JSON property `intentClassificationConfig`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfig]
+        attr_accessor :intent_classification_config
+      
+        # Optional. The retailer's display name that could be used in our LLM answers.
+        # Example - "Google"
+        # Corresponds to the JSON property `retailerDisplayName`
+        # @return [String]
+        attr_accessor :retailer_display_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @catalog = args[:catalog] if args.key?(:catalog)
+          @intent_classification_config = args[:intent_classification_config] if args.key?(:intent_classification_config)
+          @retailer_display_name = args[:retailer_display_name] if args.key?(:retailer_display_name)
+        end
+      end
+      
       # Metadata associated with a create operation.
       class GoogleCloudRetailV2CreateModelMetadata
         include Google::Apis::Core::Hashable
@@ -1630,6 +1665,25 @@ module Google
         end
       end
       
+      # A message with a list of double values.
+      class GoogleCloudRetailV2DoubleList
+        include Google::Apis::Core::Hashable
+      
+        # The list of double values.
+        # Corresponds to the JSON property `values`
+        # @return [Array<Float>]
+        attr_accessor :values
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @values = args[:values] if args.key?(:values)
+        end
+      end
+      
       # Metadata for active A/B testing experiment.
       class GoogleCloudRetailV2ExperimentInfo
         include Google::Apis::Core::Hashable
@@ -2332,6 +2386,84 @@ module Google
         end
       end
       
+      # The public proto to represent the intent classification config. It will be
+      # converted to the internal proto in the backend.
+      class GoogleCloudRetailV2IntentClassificationConfig
+        include Google::Apis::Core::Hashable
+      
+        # Optional. A list of keywords that will be used to classify the query to the "
+        # BLOCKLISTED" intent type. The keywords are case insensitive.
+        # Corresponds to the JSON property `blocklistKeywords`
+        # @return [Array<String>]
+        attr_accessor :blocklist_keywords
+      
+        # Optional. A list of intent types that will be disabled for this customer. The
+        # intent types must match one of the predefined intent types defined at https://
+        # cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#
+        # querytype
+        # Corresponds to the JSON property `disabledIntentTypes`
+        # @return [Array<String>]
+        attr_accessor :disabled_intent_types
+      
+        # Optional. A list of examples for intent classification.
+        # Corresponds to the JSON property `example`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfigExample>]
+        attr_accessor :example
+      
+        # Optional. Customers can use the preamble to specify any requirements for
+        # blocklisting intent classification. This preamble will be added to the
+        # blocklisting intent classification model prompt.
+        # Corresponds to the JSON property `modelPreamble`
+        # @return [String]
+        attr_accessor :model_preamble
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @blocklist_keywords = args[:blocklist_keywords] if args.key?(:blocklist_keywords)
+          @disabled_intent_types = args[:disabled_intent_types] if args.key?(:disabled_intent_types)
+          @example = args[:example] if args.key?(:example)
+          @model_preamble = args[:model_preamble] if args.key?(:model_preamble)
+        end
+      end
+      
+      # An example for intent classification.
+      class GoogleCloudRetailV2IntentClassificationConfigExample
+        include Google::Apis::Core::Hashable
+      
+        # Optional. The intent_type must match one of the predefined intent types
+        # defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.
+        # retail.v2alpha#querytype
+        # Corresponds to the JSON property `intentType`
+        # @return [String]
+        attr_accessor :intent_type
+      
+        # Required. Example query.
+        # Corresponds to the JSON property `query`
+        # @return [String]
+        attr_accessor :query
+      
+        # Optional. The reason for the intent classification. This is used to explain
+        # the intent classification decision.
+        # Corresponds to the JSON property `reason`
+        # @return [String]
+        attr_accessor :reason
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @intent_type = args[:intent_type] if args.key?(:intent_type)
+          @query = args[:query] if args.key?(:query)
+          @reason = args[:reason] if args.key?(:reason)
+        end
+      end
+      
       # A floating point interval.
       class GoogleCloudRetailV2Interval
         include Google::Apis::Core::Hashable
@@ -5528,9 +5660,9 @@ module Google
         # @return [String]
         attr_accessor :condition
       
-        # Whether to pin unexpanded results. If this field is set to true, unexpanded
-        # products are always at the top of the search results, followed by the expanded
-        # results.
+        # Whether to pin unexpanded results. The default value is false. If this field
+        # is set to true, unexpanded products are always at the top of the search
+        # results, followed by the expanded results.
         # Corresponds to the JSON property `pinUnexpandedResults`
         # @return [Boolean]
         attr_accessor :pin_unexpanded_results
@@ -5942,6 +6074,11 @@ module Google
         # @return [Hash<String,String>]
         attr_accessor :matching_variant_fields
       
+        # Google provided available scores.
+        # Corresponds to the JSON property `modelScores`
+        # @return [Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2DoubleList>]
+        attr_accessor :model_scores
+      
         # Specifies previous events related to this product for this user based on
         # UserEvent with same SearchRequest.visitor_id or UserInfo.user_id. This is set
         # only when SearchRequest.PersonalizationSpec.mode is SearchRequest.
@@ -5983,6 +6120,7 @@ module Google
           @id = args[:id] if args.key?(:id)
           @matching_variant_count = args[:matching_variant_count] if args.key?(:matching_variant_count)
           @matching_variant_fields = args[:matching_variant_fields] if args.key?(:matching_variant_fields)
+          @model_scores = args[:model_scores] if args.key?(:model_scores)
           @personal_labels = args[:personal_labels] if args.key?(:personal_labels)
           @product = args[:product] if args.key?(:product)
           @variant_rollup_values = args[:variant_rollup_values] if args.key?(:variant_rollup_values)
@@ -6601,9 +6739,9 @@ module Google
       
         # A unique identifier for tracking a visitor session with a length limit of 128
         # bytes. A session is an aggregation of an end user behavior in a time span. A
-        # general guideline to populate the sesion_id: 1. If user has no activity for 30
-        # min, a new session_id should be assigned. 2. The session_id should be unique
-        # across users, suggest use uuid or add visitor_id as prefix.
+        # general guideline to populate the session_id: 1. If user has no activity for
+        # 30 min, a new session_id should be assigned. 2. The session_id should be
+        # unique across users, suggest use uuid or add visitor_id as prefix.
         # Corresponds to the JSON property `sessionId`
         # @return [String]
         attr_accessor :session_id

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.116.0"
+      GEM_VERSION = "0.118.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.17.0"
+      GENERATOR_VERSION = "0.18.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20250508"
+      REVISION = "20250613"
     end
   end
 end

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

@@ -268,6 +268,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2ConversationalSearchCustomizationConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2CreateModelMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -280,6 +286,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2DoubleList
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2ExperimentInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -406,6 +418,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2IntentClassificationConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2IntentClassificationConfigExample
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2Interval
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1942,6 +1966,16 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2ConversationalSearchCustomizationConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :catalog, as: 'catalog'
+          property :intent_classification_config, as: 'intentClassificationConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfig::Representation
+      
+          property :retailer_display_name, as: 'retailerDisplayName'
+        end
+      end
+      
       class GoogleCloudRetailV2CreateModelMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1959,6 +1993,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2DoubleList
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :values, as: 'values'
+        end
+      end
+      
       class GoogleCloudRetailV2ExperimentInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2157,6 +2198,26 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2IntentClassificationConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :blocklist_keywords, as: 'blocklistKeywords'
+          collection :disabled_intent_types, as: 'disabledIntentTypes'
+          collection :example, as: 'example', class: Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfigExample, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfigExample::Representation
+      
+          property :model_preamble, as: 'modelPreamble'
+        end
+      end
+      
+      class GoogleCloudRetailV2IntentClassificationConfigExample
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :intent_type, as: 'intentType'
+          property :query, as: 'query'
+          property :reason, as: 'reason'
+        end
+      end
+      
       class GoogleCloudRetailV2Interval
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -3033,6 +3094,8 @@ module Google
           property :id, as: 'id'
           property :matching_variant_count, as: 'matchingVariantCount'
           hash :matching_variant_fields, as: 'matchingVariantFields'
+          hash :model_scores, as: 'modelScores', class: Google::Apis::RetailV2::GoogleCloudRetailV2DoubleList, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2DoubleList::Representation
+      
           collection :personal_labels, as: 'personalLabels'
           property :product, as: 'product', class: Google::Apis::RetailV2::GoogleCloudRetailV2Product, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Product::Representation
       

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

@@ -242,6 +242,37 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Returns the conversational search customization config for a given catalog.
+        # @param [String] name
+        #   Required. Resource name of the parent catalog. Format: projects/`project`/
+        #   locations/`location`/catalogs/`catalog`
+        # @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::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig]
+        #
+        # @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_catalog_conversational_search_customization_config(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/{+name}/conversationalSearchCustomizationConfig', options)
+          command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig
+          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
+        
         # Get which branch is currently default branch set by CatalogService.
         # SetDefaultBranch method under a specified parent catalog.
         # @param [String] catalog
@@ -523,6 +554,45 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Updates the conversational search customization config for a given catalog.
+        # @param [String] catalog
+        #   Required. Resource name of the catalog. Format: projects/`project`/locations/`
+        #   location`/catalogs/`catalog`
+        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig] google_cloud_retail_v2_conversational_search_customization_config_object
+        # @param [String] update_mask
+        #   Optional. Indicates which fields in the provided
+        #   ConversationalSearchCustomizationConfig to update. If not set or empty, 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::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig]
+        #
+        # @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_catalog_conversational_search_customization_config(catalog, google_cloud_retail_v2_conversational_search_customization_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v2/{+catalog}/conversationalSearchCustomizationConfig', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig::Representation
+          command.request_object = google_cloud_retail_v2_conversational_search_customization_config_object
+          command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig
+          command.params['catalog'] = catalog unless catalog.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
+        
         # Allows management of individual questions.
         # @param [String] catalog
         #   Required. Resource name of the catalog. Format: projects/`project`/locations/`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.116.0
+  version: 0.118.0
 platform: ruby
 authors:
 - Google LLC
@@ -57,7 +57,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-retail_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.116.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.118.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 rdoc_options: []
 require_paths:
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Simple REST client for Vertex AI Search for commerce API V2
 test_files: []