google-apis-retail_v2alpha 0.139.0 → 0.141.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da13819d17d1c043a19e9245a75fc7ba40aefb39b032a44625cbb05153889d43
-  data.tar.gz: 9cf2f150c462d4a844fe118263f53e40d94bf26476faddc944378fa65cb67ae1
+  metadata.gz: 5408268e9df79ea3dc57a11246329f475adc76fe0a5d0c05f681c184220167e1
+  data.tar.gz: bab6e51bc0394adce07b4f7e5d555625ea5b27d0863789a09d509e319e56f620
 SHA512:
-  metadata.gz: 0615c2121c26c0a8afbe686015ceffeb4c6dd82ed3decb9cbee02f95e79871b280472b059ee646b3f46f6c108b271504b247f54caa26b28dd8e678bb2d35450d
-  data.tar.gz: 129d1427da7fe6036026e6cd0c5f16eb39b5ce35e0e418c0af9a1d0267cb3dd4757fafd1a73fe74d01f2a7dc3929491ab7a81f3959fb9a37f2d4a070e91de69c
+  metadata.gz: 27419301f5a31a3de852bae276b2cef0e5bce3b3bd024c9d17432037d3c545bcce3de9728ecb4281fa9f8a03e6c3843c9e3463c19ebbaf64af5824c8a5f61c96
+  data.tar.gz: b8f699aa4697115e3038bda9ce15fb8a50f6586754ac55cfce84507d5075e2821ebfc1cf60da271a999d704d7a6eb40694a5e64d5609d459288bb2561e275e17

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # Release history for google-apis-retail_v2alpha
 
-### v0.139.0 (2026-08-02)
+### v0.141.0 (2026-08-30)
 
-* Regenerated from discovery document revision 20260723
+* Regenerated from discovery document revision 20260826
+
+### v0.140.0 (2026-08-23)
+
+* Regenerated from discovery document revision 20260813
+
+### v0.139.0 (2026-08-09)
+
+* Regenerated from discovery document revision 20260803
 
 ### v0.138.0 (2026-07-19)
 

data/OVERVIEW.md

@@ -1,6 +1,6 @@
-# Simple REST client for version V2alpha of the Vertex AI Search for commerce API
+# Simple REST client for version V2alpha of the AI Commerce Search API
 
-This is a simple client library for version V2alpha of the Vertex AI Search for commerce API. It provides:
+This is a simple client library for version V2alpha of the AI Commerce Search API. It provides:
 
 * A client object that connects to the HTTP/JSON REST endpoint for the service.
 * Ruby objects for data structures related to the service.
@@ -65,7 +65,7 @@ More detailed descriptions of the Google simple REST clients are available in tw
 
 (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Retail service in particular.)
 
-For reference information on specific calls in the Vertex AI Search for commerce API, see the {Google::Apis::RetailV2alpha::CloudRetailService class reference docs}.
+For reference information on specific calls in the AI Commerce Search API, see the {Google::Apis::RetailV2alpha::CloudRetailService class reference docs}.
 
 ## Which client should I use?
 

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

@@ -2333,6 +2333,12 @@ module Google
       class GoogleCloudRetailV2alphaCompleteQueryResponse
         include Google::Apis::Core::Hashable
       
+        # Conversational prompts to trigger agents like Shopping Agent. This is an
+        # experimental feature for select customers.
+        # Corresponds to the JSON property `agentPrompts`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt>]
+        attr_accessor :agent_prompts
+      
         # A map of matched attribute suggestions. This field is only available for `
         # cloud-retail` dataset. Current supported keys: * `brands` * `categories`
         # Corresponds to the JSON property `attributeResults`
@@ -2371,6 +2377,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @agent_prompts = args[:agent_prompts] if args.key?(:agent_prompts)
           @attribute_results = args[:attribute_results] if args.key?(:attribute_results)
           @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
           @completion_results = args[:completion_results] if args.key?(:completion_results)
@@ -2378,6 +2385,25 @@ module Google
         end
       end
       
+      # A conversational prompt to trigger agents like Shopping Agent.
+      class GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt
+        include Google::Apis::Core::Hashable
+      
+        # The conversational prompt string.
+        # Corresponds to the JSON property `prompt`
+        # @return [String]
+        attr_accessor :prompt
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @prompt = args[:prompt] if args.key?(:prompt)
+        end
+      end
+      
       # Resource that represents attribute results.
       class GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult
         include Google::Apis::Core::Hashable
@@ -2401,6 +2427,13 @@ module Google
       class GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult
         include Google::Apis::Core::Hashable
       
+        # Deprecated: Use CompleteQueryResponse.agent_prompts instead. Conversational
+        # prompts to trigger agents like Shopping Agent. There may be multiple prompts
+        # for a single suggestion. This is an experimental feature for select customers.
+        # Corresponds to the JSON property `agentPrompts`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt>]
+        attr_accessor :agent_prompts
+      
         # Custom attributes for the suggestion term. * For `user-data`, the attributes
         # are additional custom attributes ingested through BigQuery. * For `cloud-
         # retail`, the attributes are product attributes generated by Cloud Retail. It
@@ -2435,6 +2468,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @agent_prompts = args[:agent_prompts] if args.key?(:agent_prompts)
           @attributes = args[:attributes] if args.key?(:attributes)
           @facets = args[:facets] if args.key?(:facets)
           @suggestion = args[:suggestion] if args.key?(:suggestion)
@@ -7577,6 +7611,16 @@ module Google
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec]
         attr_accessor :conversational_search_spec
       
+        # Optional. A set of controls that are applied dynamically to the search request.
+        # These controls are applied in addition to the controls specified in the
+        # serving config. These controls are expected to not yet be persisted in storage.
+        # A control could be applied twice if it is in both the serving config and
+        # specified here. A maximum of 5 values are allowed. Otherwise, an
+        # INVALID_ARGUMENT error is returned.
+        # Corresponds to the JSON property `dynamicControls`
+        # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl>]
+        attr_accessor :dynamic_controls
+      
         # The specifications of dynamically generated facets.
         # Corresponds to the JSON property `dynamicFacetSpec`
         # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec]
@@ -7611,6 +7655,12 @@ module Google
         # @return [String]
         attr_accessor :filter
       
+        # Optional. A list of control IDs to ignore. These controls will not be applied
+        # to the search request, even if they are specified in the serving config.
+        # Corresponds to the JSON property `ignoredControlIds`
+        # @return [Array<String>]
+        attr_accessor :ignored_control_ids
+      
         # The labels applied to a resource must meet the following requirements: * Each
         # resource can have multiple labels, up to a maximum of 64. * Each label must be
         # a key-value pair. * Keys have a minimum length of 1 character and a maximum
@@ -7802,11 +7852,13 @@ module Google
           @branch = args[:branch] if args.key?(:branch)
           @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
           @conversational_search_spec = args[:conversational_search_spec] if args.key?(:conversational_search_spec)
+          @dynamic_controls = args[:dynamic_controls] if args.key?(:dynamic_controls)
           @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
           @entity = args[:entity] if args.key?(:entity)
           @experiment_id = args[:experiment_id] if args.key?(:experiment_id)
           @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
           @filter = args[:filter] if args.key?(:filter)
+          @ignored_control_ids = args[:ignored_control_ids] if args.key?(:ignored_control_ids)
           @labels = args[:labels] if args.key?(:labels)
           @language_code = args[:language_code] if args.key?(:language_code)
           @offset = args[:offset] if args.key?(:offset)

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2alpha
       # Version of the google-apis-retail_v2alpha gem
-      GEM_VERSION = "0.139.0"
+      GEM_VERSION = "0.141.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.19.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20260723"
+      REVISION = "20260826"
     end
   end
 end

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

@@ -472,6 +472,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2446,6 +2452,8 @@ module Google
       class GoogleCloudRetailV2alphaCompleteQueryResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          collection :agent_prompts, as: 'agentPrompts', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt::Representation
+      
           hash :attribute_results, as: 'attributeResults', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult::Representation
       
           property :attribution_token, as: 'attributionToken'
@@ -2456,6 +2464,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :prompt, as: 'prompt'
+        end
+      end
+      
       class GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2466,6 +2481,8 @@ module Google
       class GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          collection :agent_prompts, as: 'agentPrompts', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt::Representation
+      
           hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
       
           collection :facets, as: 'facets', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet::Representation
@@ -3827,6 +3844,8 @@ module Google
           property :canonical_filter, as: 'canonicalFilter'
           property :conversational_search_spec, as: 'conversationalSearchSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec::Representation
       
+          collection :dynamic_controls, as: 'dynamicControls', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
+      
           property :dynamic_facet_spec, as: 'dynamicFacetSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec::Representation
       
           property :entity, as: 'entity'
@@ -3834,6 +3853,7 @@ module Google
           collection :facet_specs, as: 'facetSpecs', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec::Representation
       
           property :filter, as: 'filter'
+          collection :ignored_control_ids, as: 'ignoredControlIds'
           hash :labels, as: 'labels'
           property :language_code, as: 'languageCode'
           property :offset, as: 'offset'

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

@@ -20,9 +20,9 @@ require 'google/apis/errors'
 module Google
   module Apis
     module RetailV2alpha
-      # Vertex AI Search for commerce API
+      # AI Commerce Search API
       #
-      # Vertex AI Search for commerce API is made up of Retail Search, Browse and
+      # The AI Commerce Search API is made up of Retail Search, Browse and
       #  Recommendations. These discovery AI solutions help you implement personalized
       #  search, browse and recommendations, based on machine learning models, across
       #  your websites and mobile applications.

data/lib/google/apis/retail_v2alpha.rb

@@ -19,16 +19,16 @@ require 'google/apis/retail_v2alpha/gem_version.rb'
 
 module Google
   module Apis
-    # Vertex AI Search for commerce API
+    # AI Commerce Search API
     #
-    # Vertex AI Search for commerce API is made up of Retail Search, Browse and
+    # The AI Commerce Search API is made up of Retail Search, Browse and
     # Recommendations. These discovery AI solutions help you implement personalized
     # search, browse and recommendations, based on machine learning models, across
     # your websites and mobile applications.
     #
     # @see https://cloud.google.com/recommendations
     module RetailV2alpha
-      # Version of the Vertex AI Search for commerce API this client connects to.
+      # Version of the AI Commerce Search API this client connects to.
       # This is NOT the gem version.
       VERSION = 'V2alpha'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2alpha
 version: !ruby/object:Gem::Version
-  version: 0.139.0
+  version: 0.141.0
 platform: ruby
 authors:
 - Google LLC
@@ -29,13 +29,13 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
-description: This is the simple REST client for Vertex AI Search for commerce API
-  V2alpha. Simple REST clients are Ruby client libraries that provide access to Google
-  services via their HTTP REST API endpoints. These libraries are generated and updated
-  automatically based on the discovery documents published by the service, and they
-  handle most concerns such as authentication, pagination, retry, timeouts, and logging.
-  You can use this client to access the Vertex AI Search for commerce API, but note
-  that some services may provide a separate modern client that is easier to use.
+description: This is the simple REST client for AI Commerce Search API V2alpha. Simple
+  REST clients are Ruby client libraries that provide access to Google services via
+  their HTTP REST API endpoints. These libraries are generated and updated automatically
+  based on the discovery documents published by the service, and they handle most
+  concerns such as authentication, pagination, retry, timeouts, and logging. You can
+  use this client to access the AI Commerce Search API, but note that some services
+  may provide a separate modern client that is easier to use.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -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_v2alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.139.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.141.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
 rdoc_options: []
 require_paths:
@@ -75,5 +75,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Simple REST client for Vertex AI Search for commerce API V2alpha
+summary: Simple REST client for AI Commerce Search API V2alpha
 test_files: []