google-apis-retail_v2alpha 0.139.0 → 0.140.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: da13819d17d1c043a19e9245a75fc7ba40aefb39b032a44625cbb05153889d43
4
- data.tar.gz: 9cf2f150c462d4a844fe118263f53e40d94bf26476faddc944378fa65cb67ae1
3
+ metadata.gz: a904313993a5b0ae32403980b212d72d2171ffa7c03212656c510955344240ee
4
+ data.tar.gz: c86dcc37fa4e2c85b23c3e86fa596ca88c4765a305daabec324a3794f0391c68
5
5
  SHA512:
6
- metadata.gz: 0615c2121c26c0a8afbe686015ceffeb4c6dd82ed3decb9cbee02f95e79871b280472b059ee646b3f46f6c108b271504b247f54caa26b28dd8e678bb2d35450d
7
- data.tar.gz: 129d1427da7fe6036026e6cd0c5f16eb39b5ce35e0e418c0af9a1d0267cb3dd4757fafd1a73fe74d01f2a7dc3929491ab7a81f3959fb9a37f2d4a070e91de69c
6
+ metadata.gz: 3eb6c739709d56572192033834ea8a7e28fcde561a304468f5c87a65f8aac7903d5b2c289be29949bdb8c91f16b32b9ab8636654141d046286ac4138e1343a00
7
+ data.tar.gz: 3689e18ca375872ab4ea795a5ff13344243bc8562fc48c9a494642a1d21491d5064b45567f65483a2cf552513353c74ced8cbaefbccbfb51bf3d76ee7e729fd3
data/CHANGELOG.md CHANGED
@@ -1,8 +1,12 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
- ### v0.139.0 (2026-08-02)
3
+ ### v0.140.0 (2026-08-23)
4
4
 
5
- * Regenerated from discovery document revision 20260723
5
+ * Regenerated from discovery document revision 20260813
6
+
7
+ ### v0.139.0 (2026-08-09)
8
+
9
+ * Regenerated from discovery document revision 20260803
6
10
 
7
11
  ### v0.138.0 (2026-07-19)
8
12
 
data/OVERVIEW.md CHANGED
@@ -1,6 +1,6 @@
1
- # Simple REST client for version V2alpha of the Vertex AI Search for commerce API
1
+ # Simple REST client for version V2alpha of the AI Commerce Search API
2
2
 
3
- This is a simple client library for version V2alpha of the Vertex AI Search for commerce API. It provides:
3
+ This is a simple client library for version V2alpha of the AI Commerce Search API. It provides:
4
4
 
5
5
  * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
6
  * 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
65
65
 
66
66
  (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Retail service in particular.)
67
67
 
68
- For reference information on specific calls in the Vertex AI Search for commerce API, see the {Google::Apis::RetailV2alpha::CloudRetailService class reference docs}.
68
+ For reference information on specific calls in the AI Commerce Search API, see the {Google::Apis::RetailV2alpha::CloudRetailService class reference docs}.
69
69
 
70
70
  ## Which client should I use?
71
71
 
@@ -2401,6 +2401,14 @@ module Google
2401
2401
  class GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult
2402
2402
  include Google::Apis::Core::Hashable
2403
2403
 
2404
+ # Conversational prompts to trigger agents like Shopping Agent. There may be
2405
+ # multiple prompts for a single suggestion. This is an experimental feature for
2406
+ # select customers. If you want to receive this prompt information, reach out to
2407
+ # the Retail support team.
2408
+ # Corresponds to the JSON property `agentPrompts`
2409
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResultAgentPrompt>]
2410
+ attr_accessor :agent_prompts
2411
+
2404
2412
  # Custom attributes for the suggestion term. * For `user-data`, the attributes
2405
2413
  # are additional custom attributes ingested through BigQuery. * For `cloud-
2406
2414
  # retail`, the attributes are product attributes generated by Cloud Retail. It
@@ -2435,6 +2443,7 @@ module Google
2435
2443
 
2436
2444
  # Update properties of this object
2437
2445
  def update!(**args)
2446
+ @agent_prompts = args[:agent_prompts] if args.key?(:agent_prompts)
2438
2447
  @attributes = args[:attributes] if args.key?(:attributes)
2439
2448
  @facets = args[:facets] if args.key?(:facets)
2440
2449
  @suggestion = args[:suggestion] if args.key?(:suggestion)
@@ -2442,6 +2451,25 @@ module Google
2442
2451
  end
2443
2452
  end
2444
2453
 
2454
+ # A conversational prompt to trigger agents like Shopping Agent.
2455
+ class GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResultAgentPrompt
2456
+ include Google::Apis::Core::Hashable
2457
+
2458
+ # The conversational prompt string.
2459
+ # Corresponds to the JSON property `prompt`
2460
+ # @return [String]
2461
+ attr_accessor :prompt
2462
+
2463
+ def initialize(**args)
2464
+ update!(**args)
2465
+ end
2466
+
2467
+ # Update properties of this object
2468
+ def update!(**args)
2469
+ @prompt = args[:prompt] if args.key?(:prompt)
2470
+ end
2471
+ end
2472
+
2445
2473
  # Deprecated: Recent search of this user.
2446
2474
  class GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult
2447
2475
  include Google::Apis::Core::Hashable
@@ -7577,6 +7605,16 @@ module Google
7577
7605
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec]
7578
7606
  attr_accessor :conversational_search_spec
7579
7607
 
7608
+ # Optional. A set of controls that are applied dynamically to the search request.
7609
+ # These controls are applied in addition to the controls specified in the
7610
+ # serving config. These controls are expected to not yet be persisted in storage.
7611
+ # A control could be applied twice if it is in both the serving config and
7612
+ # specified here. A maximum of 5 values are allowed. Otherwise, an
7613
+ # INVALID_ARGUMENT error is returned.
7614
+ # Corresponds to the JSON property `dynamicControls`
7615
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl>]
7616
+ attr_accessor :dynamic_controls
7617
+
7580
7618
  # The specifications of dynamically generated facets.
7581
7619
  # Corresponds to the JSON property `dynamicFacetSpec`
7582
7620
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec]
@@ -7611,6 +7649,12 @@ module Google
7611
7649
  # @return [String]
7612
7650
  attr_accessor :filter
7613
7651
 
7652
+ # Optional. A list of control IDs to ignore. These controls will not be applied
7653
+ # to the search request, even if they are specified in the serving config.
7654
+ # Corresponds to the JSON property `ignoredControlIds`
7655
+ # @return [Array<String>]
7656
+ attr_accessor :ignored_control_ids
7657
+
7614
7658
  # The labels applied to a resource must meet the following requirements: * Each
7615
7659
  # resource can have multiple labels, up to a maximum of 64. * Each label must be
7616
7660
  # a key-value pair. * Keys have a minimum length of 1 character and a maximum
@@ -7802,11 +7846,13 @@ module Google
7802
7846
  @branch = args[:branch] if args.key?(:branch)
7803
7847
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
7804
7848
  @conversational_search_spec = args[:conversational_search_spec] if args.key?(:conversational_search_spec)
7849
+ @dynamic_controls = args[:dynamic_controls] if args.key?(:dynamic_controls)
7805
7850
  @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
7806
7851
  @entity = args[:entity] if args.key?(:entity)
7807
7852
  @experiment_id = args[:experiment_id] if args.key?(:experiment_id)
7808
7853
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
7809
7854
  @filter = args[:filter] if args.key?(:filter)
7855
+ @ignored_control_ids = args[:ignored_control_ids] if args.key?(:ignored_control_ids)
7810
7856
  @labels = args[:labels] if args.key?(:labels)
7811
7857
  @language_code = args[:language_code] if args.key?(:language_code)
7812
7858
  @offset = args[:offset] if args.key?(:offset)
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2alpha
18
18
  # Version of the google-apis-retail_v2alpha gem
19
- GEM_VERSION = "0.139.0"
19
+ GEM_VERSION = "0.140.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.19.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20260723"
25
+ REVISION = "20260813"
26
26
  end
27
27
  end
28
28
  end
@@ -484,6 +484,12 @@ module Google
484
484
  include Google::Apis::Core::JsonObjectSupport
485
485
  end
486
486
 
487
+ class GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResultAgentPrompt
488
+ class Representation < Google::Apis::Core::JsonRepresentation; end
489
+
490
+ include Google::Apis::Core::JsonObjectSupport
491
+ end
492
+
487
493
  class GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult
488
494
  class Representation < Google::Apis::Core::JsonRepresentation; end
489
495
 
@@ -2466,6 +2472,8 @@ module Google
2466
2472
  class GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult
2467
2473
  # @private
2468
2474
  class Representation < Google::Apis::Core::JsonRepresentation
2475
+ collection :agent_prompts, as: 'agentPrompts', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResultAgentPrompt, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResultAgentPrompt::Representation
2476
+
2469
2477
  hash :attributes, as: 'attributes', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCustomAttribute::Representation
2470
2478
 
2471
2479
  collection :facets, as: 'facets', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchResponseFacet::Representation
@@ -2475,6 +2483,13 @@ module Google
2475
2483
  end
2476
2484
  end
2477
2485
 
2486
+ class GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResultAgentPrompt
2487
+ # @private
2488
+ class Representation < Google::Apis::Core::JsonRepresentation
2489
+ property :prompt, as: 'prompt'
2490
+ end
2491
+ end
2492
+
2478
2493
  class GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult
2479
2494
  # @private
2480
2495
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3827,6 +3842,8 @@ module Google
3827
3842
  property :canonical_filter, as: 'canonicalFilter'
3828
3843
  property :conversational_search_spec, as: 'conversationalSearchSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec::Representation
3829
3844
 
3845
+ collection :dynamic_controls, as: 'dynamicControls', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaControl::Representation
3846
+
3830
3847
  property :dynamic_facet_spec, as: 'dynamicFacetSpec', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec::Representation
3831
3848
 
3832
3849
  property :entity, as: 'entity'
@@ -3834,6 +3851,7 @@ module Google
3834
3851
  collection :facet_specs, as: 'facetSpecs', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSearchRequestFacetSpec::Representation
3835
3852
 
3836
3853
  property :filter, as: 'filter'
3854
+ collection :ignored_control_ids, as: 'ignoredControlIds'
3837
3855
  hash :labels, as: 'labels'
3838
3856
  property :language_code, as: 'languageCode'
3839
3857
  property :offset, as: 'offset'
@@ -20,9 +20,9 @@ require 'google/apis/errors'
20
20
  module Google
21
21
  module Apis
22
22
  module RetailV2alpha
23
- # Vertex AI Search for commerce API
23
+ # AI Commerce Search API
24
24
  #
25
- # Vertex AI Search for commerce API is made up of Retail Search, Browse and
25
+ # The AI Commerce Search API is made up of Retail Search, Browse and
26
26
  # Recommendations. These discovery AI solutions help you implement personalized
27
27
  # search, browse and recommendations, based on machine learning models, across
28
28
  # your websites and mobile applications.
@@ -19,16 +19,16 @@ require 'google/apis/retail_v2alpha/gem_version.rb'
19
19
 
20
20
  module Google
21
21
  module Apis
22
- # Vertex AI Search for commerce API
22
+ # AI Commerce Search API
23
23
  #
24
- # Vertex AI Search for commerce API is made up of Retail Search, Browse and
24
+ # The AI Commerce Search API is made up of Retail Search, Browse and
25
25
  # Recommendations. These discovery AI solutions help you implement personalized
26
26
  # search, browse and recommendations, based on machine learning models, across
27
27
  # your websites and mobile applications.
28
28
  #
29
29
  # @see https://cloud.google.com/recommendations
30
30
  module RetailV2alpha
31
- # Version of the Vertex AI Search for commerce API this client connects to.
31
+ # Version of the AI Commerce Search API this client connects to.
32
32
  # This is NOT the gem version.
33
33
  VERSION = 'V2alpha'
34
34
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.139.0
4
+ version: 0.140.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -29,13 +29,13 @@ dependencies:
29
29
  - - "<"
30
30
  - !ruby/object:Gem::Version
31
31
  version: 2.a
32
- description: This is the simple REST client for Vertex AI Search for commerce API
33
- V2alpha. Simple REST clients are Ruby client libraries that provide access to Google
34
- services via their HTTP REST API endpoints. These libraries are generated and updated
35
- automatically based on the discovery documents published by the service, and they
36
- handle most concerns such as authentication, pagination, retry, timeouts, and logging.
37
- You can use this client to access the Vertex AI Search for commerce API, but note
38
- that some services may provide a separate modern client that is easier to use.
32
+ description: This is the simple REST client for AI Commerce Search API V2alpha. Simple
33
+ REST clients are Ruby client libraries that provide access to Google services via
34
+ their HTTP REST API endpoints. These libraries are generated and updated automatically
35
+ based on the discovery documents published by the service, and they handle most
36
+ concerns such as authentication, pagination, retry, timeouts, and logging. You can
37
+ use this client to access the AI Commerce Search API, but note that some services
38
+ may provide a separate modern client that is easier to use.
39
39
  email: googleapis-packages@google.com
40
40
  executables: []
41
41
  extensions: []
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.139.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.140.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
62
62
  rdoc_options: []
63
63
  require_paths:
@@ -75,5 +75,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  requirements: []
76
76
  rubygems_version: 3.6.9
77
77
  specification_version: 4
78
- summary: Simple REST client for Vertex AI Search for commerce API V2alpha
78
+ summary: Simple REST client for AI Commerce Search API V2alpha
79
79
  test_files: []