google-apis-retail_v2alpha 0.123.0 → 0.125.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: 104632ff87aab7427ec92d5db7c3ce3ac8837c5c4164c074267c5721ef22c959
4
- data.tar.gz: 81c53fd43638fda6ce24d8b15f36b2b78c9a051bb4c2d3b2315b2bd505292ce6
3
+ metadata.gz: 69a398999a9ba1d4abf8cb8d91d397cf63bdace75cc4dd5c59c7a1a7b9fb079f
4
+ data.tar.gz: ac8aa6242dfe65a819df2384e830b3194a415098b2e39defb293ea31ec0f7b13
5
5
  SHA512:
6
- metadata.gz: 5862b10aa76293d7ed869fd456deeeb1e328131507cfa10b3ec490bdd6816690eaf0f7b95eb57df2439845124cb97e467f68b9c3e3b6e1ad4b9a0ff095cc29b8
7
- data.tar.gz: a55a04753b689c451443b424a0feb5554dcfcdbd55c038d0c9c449f9211938bc5a9c2c7e39c27d71c579c699f5dd34d232d9d6f1e780b0c622bcbffd1491f4e8
6
+ metadata.gz: 602694d7ccc95f3dce9d2810dbbfa00e183f2c37dbdf5d7b87f64b89e8a267365b2eb5d84f489e544ab248ee9ebf77a2ce079f6c14c2a4f61389afe1ea190914
7
+ data.tar.gz: ad31a0f125ba6a832f0ef717e2635270982d9964907f4c5cbe97c163dc45295802f4e3a856d1bdfe3ea5b24abb39456082da5fe16033e307fde45696b62fcfe4
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-retail_v2alpha
2
2
 
3
+ ### v0.125.0 (2025-08-03)
4
+
5
+ * Regenerated from discovery document revision 20250724
6
+
7
+ ### v0.124.0 (2025-07-27)
8
+
9
+ * Regenerated from discovery document revision 20250717
10
+
3
11
  ### v0.123.0 (2025-07-20)
4
12
 
5
13
  * Regenerated from discovery document revision 20250710
@@ -2851,6 +2851,11 @@ module Google
2851
2851
  # @return [String]
2852
2852
  attr_accessor :query
2853
2853
 
2854
+ # Optional. The safety settings to be applied to the generated content.
2855
+ # Corresponds to the JSON property `safetySettings`
2856
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSafetySetting>]
2857
+ attr_accessor :safety_settings
2858
+
2854
2859
  # Search parameters.
2855
2860
  # Corresponds to the JSON property `searchParams`
2856
2861
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams]
@@ -2897,6 +2902,7 @@ module Google
2897
2902
  @conversational_filtering_spec = args[:conversational_filtering_spec] if args.key?(:conversational_filtering_spec)
2898
2903
  @page_categories = args[:page_categories] if args.key?(:page_categories)
2899
2904
  @query = args[:query] if args.key?(:query)
2905
+ @safety_settings = args[:safety_settings] if args.key?(:safety_settings)
2900
2906
  @search_params = args[:search_params] if args.key?(:search_params)
2901
2907
  @user_info = args[:user_info] if args.key?(:user_info)
2902
2908
  @user_labels = args[:user_labels] if args.key?(:user_labels)
@@ -3048,6 +3054,16 @@ module Google
3048
3054
  # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult]
3049
3055
  attr_accessor :conversational_filtering_result
3050
3056
 
3057
+ # The conversational answer-based text response generated by the Server.
3058
+ # Corresponds to the JSON property `conversationalTextResponse`
3059
+ # @return [String]
3060
+ attr_accessor :conversational_text_response
3061
+
3062
+ # The conversational followup question generated for Intent refinement.
3063
+ # Corresponds to the JSON property `followupQuestion`
3064
+ # @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion]
3065
+ attr_accessor :followup_question
3066
+
3051
3067
  # The proposed refined search queries. They can be used to fetch the relevant
3052
3068
  # search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query
3053
3069
  # from search response will be populated here.
@@ -3055,6 +3071,21 @@ module Google
3055
3071
  # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch>]
3056
3072
  attr_accessor :refined_search
3057
3073
 
3074
+ # Output only. The state of the response generation.
3075
+ # Corresponds to the JSON property `state`
3076
+ # @return [String]
3077
+ attr_accessor :state
3078
+
3079
+ # The types Retail classifies the search query as. Supported values are: - "
3080
+ # ADVERSARIAL" - "CHITCHAT" - "JAILBREAK" - "ORDER_SUPPORT" - "
3081
+ # SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "
3082
+ # PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" -
3083
+ # "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED" clang-format off clang-format
3084
+ # on
3085
+ # Corresponds to the JSON property `userQueryTypes`
3086
+ # @return [Array<String>]
3087
+ attr_accessor :user_query_types
3088
+
3058
3089
  def initialize(**args)
3059
3090
  update!(**args)
3060
3091
  end
@@ -3063,7 +3094,11 @@ module Google
3063
3094
  def update!(**args)
3064
3095
  @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
3065
3096
  @conversational_filtering_result = args[:conversational_filtering_result] if args.key?(:conversational_filtering_result)
3097
+ @conversational_text_response = args[:conversational_text_response] if args.key?(:conversational_text_response)
3098
+ @followup_question = args[:followup_question] if args.key?(:followup_question)
3066
3099
  @refined_search = args[:refined_search] if args.key?(:refined_search)
3100
+ @state = args[:state] if args.key?(:state)
3101
+ @user_query_types = args[:user_query_types] if args.key?(:user_query_types)
3067
3102
  end
3068
3103
  end
3069
3104
 
@@ -4933,6 +4968,11 @@ module Google
4933
4968
  # @return [Fixnum]
4934
4969
  attr_accessor :data_source_id
4935
4970
 
4971
+ # Merchant Center primary feed ID. Deprecated: use data_source_id instead.
4972
+ # Corresponds to the JSON property `primaryFeedId`
4973
+ # @return [Fixnum]
4974
+ attr_accessor :primary_feed_id
4975
+
4936
4976
  # Merchant Center primary feed name. The name is used for the display purposes
4937
4977
  # only.
4938
4978
  # Corresponds to the JSON property `primaryFeedName`
@@ -4946,6 +4986,7 @@ module Google
4946
4986
  # Update properties of this object
4947
4987
  def update!(**args)
4948
4988
  @data_source_id = args[:data_source_id] if args.key?(:data_source_id)
4989
+ @primary_feed_id = args[:primary_feed_id] if args.key?(:primary_feed_id)
4949
4990
  @primary_feed_name = args[:primary_feed_name] if args.key?(:primary_feed_name)
4950
4991
  end
4951
4992
  end
@@ -5460,6 +5501,57 @@ module Google
5460
5501
  end
5461
5502
  end
5462
5503
 
5504
+ # Detailed panel information associated with a user event.
5505
+ class GoogleCloudRetailV2alphaPanelInfo
5506
+ include Google::Apis::Core::Hashable
5507
+
5508
+ # Optional. The attribution token of the panel.
5509
+ # Corresponds to the JSON property `attributionToken`
5510
+ # @return [String]
5511
+ attr_accessor :attribution_token
5512
+
5513
+ # Optional. The display name of the panel.
5514
+ # Corresponds to the JSON property `displayName`
5515
+ # @return [String]
5516
+ attr_accessor :display_name
5517
+
5518
+ # Required. The panel ID.
5519
+ # Corresponds to the JSON property `panelId`
5520
+ # @return [String]
5521
+ attr_accessor :panel_id
5522
+
5523
+ # Optional. The ordered position of the panel, if shown to the user with other
5524
+ # panels. If set, then total_panels must also be set.
5525
+ # Corresponds to the JSON property `panelPosition`
5526
+ # @return [Fixnum]
5527
+ attr_accessor :panel_position
5528
+
5529
+ # Optional. The product details associated with the panel.
5530
+ # Corresponds to the JSON property `productDetails`
5531
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductDetail>]
5532
+ attr_accessor :product_details
5533
+
5534
+ # Optional. The total number of panels, including this one, shown to the user.
5535
+ # Must be set if panel_position is set.
5536
+ # Corresponds to the JSON property `totalPanels`
5537
+ # @return [Fixnum]
5538
+ attr_accessor :total_panels
5539
+
5540
+ def initialize(**args)
5541
+ update!(**args)
5542
+ end
5543
+
5544
+ # Update properties of this object
5545
+ def update!(**args)
5546
+ @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
5547
+ @display_name = args[:display_name] if args.key?(:display_name)
5548
+ @panel_id = args[:panel_id] if args.key?(:panel_id)
5549
+ @panel_position = args[:panel_position] if args.key?(:panel_position)
5550
+ @product_details = args[:product_details] if args.key?(:product_details)
5551
+ @total_panels = args[:total_panels] if args.key?(:total_panels)
5552
+ end
5553
+ end
5554
+
5463
5555
  # Request for pausing training of a model.
5464
5556
  class GoogleCloudRetailV2alphaPauseModelRequest
5465
5557
  include Google::Apis::Core::Hashable
@@ -7469,6 +7561,38 @@ module Google
7469
7561
  end
7470
7562
  end
7471
7563
 
7564
+ # Safety settings.
7565
+ class GoogleCloudRetailV2alphaSafetySetting
7566
+ include Google::Apis::Core::Hashable
7567
+
7568
+ # Harm category.
7569
+ # Corresponds to the JSON property `category`
7570
+ # @return [String]
7571
+ attr_accessor :category
7572
+
7573
+ # Optional. Specify if the threshold is used for probability or severity score.
7574
+ # If not specified, the threshold is used for probability score.
7575
+ # Corresponds to the JSON property `method`
7576
+ # @return [String]
7577
+ attr_accessor :method_prop
7578
+
7579
+ # The harm block threshold.
7580
+ # Corresponds to the JSON property `threshold`
7581
+ # @return [String]
7582
+ attr_accessor :threshold
7583
+
7584
+ def initialize(**args)
7585
+ update!(**args)
7586
+ end
7587
+
7588
+ # Update properties of this object
7589
+ def update!(**args)
7590
+ @category = args[:category] if args.key?(:category)
7591
+ @method_prop = args[:method_prop] if args.key?(:method_prop)
7592
+ @threshold = args[:threshold] if args.key?(:threshold)
7593
+ end
7594
+ end
7595
+
7472
7596
  # Request message for SearchService.Search method.
7473
7597
  class GoogleCloudRetailV2alphaSearchRequest
7474
7598
  include Google::Apis::Core::Hashable
@@ -9247,6 +9371,12 @@ module Google
9247
9371
  # @return [String]
9248
9372
  attr_accessor :page_view_id
9249
9373
 
9374
+ # Optional. List of panels associated with this event. Used for panel-level
9375
+ # impression data.
9376
+ # Corresponds to the JSON property `panels`
9377
+ # @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPanelInfo>]
9378
+ attr_accessor :panels
9379
+
9250
9380
  # The main product details related to the event. This field is optional except
9251
9381
  # for the following event types: * `add-to-cart` * `detail-page-view` * `
9252
9382
  # purchase-complete` In a `search` event, this field represents the products
@@ -9334,6 +9464,7 @@ module Google
9334
9464
  @order_by = args[:order_by] if args.key?(:order_by)
9335
9465
  @page_categories = args[:page_categories] if args.key?(:page_categories)
9336
9466
  @page_view_id = args[:page_view_id] if args.key?(:page_view_id)
9467
+ @panels = args[:panels] if args.key?(:panels)
9337
9468
  @product_details = args[:product_details] if args.key?(:product_details)
9338
9469
  @purchase_transaction = args[:purchase_transaction] if args.key?(:purchase_transaction)
9339
9470
  @referrer_uri = args[:referrer_uri] if args.key?(:referrer_uri)
@@ -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.123.0"
19
+ GEM_VERSION = "0.125.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.18.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20250710"
25
+ REVISION = "20250724"
26
26
  end
27
27
  end
28
28
  end
@@ -1000,6 +1000,12 @@ module Google
1000
1000
  include Google::Apis::Core::JsonObjectSupport
1001
1001
  end
1002
1002
 
1003
+ class GoogleCloudRetailV2alphaPanelInfo
1004
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1005
+
1006
+ include Google::Apis::Core::JsonObjectSupport
1007
+ end
1008
+
1003
1009
  class GoogleCloudRetailV2alphaPauseModelRequest
1004
1010
  class Representation < Google::Apis::Core::JsonRepresentation; end
1005
1011
 
@@ -1306,6 +1312,12 @@ module Google
1306
1312
  include Google::Apis::Core::JsonObjectSupport
1307
1313
  end
1308
1314
 
1315
+ class GoogleCloudRetailV2alphaSafetySetting
1316
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1317
+
1318
+ include Google::Apis::Core::JsonObjectSupport
1319
+ end
1320
+
1309
1321
  class GoogleCloudRetailV2alphaSearchRequest
1310
1322
  class Representation < Google::Apis::Core::JsonRepresentation; end
1311
1323
 
@@ -2568,6 +2580,8 @@ module Google
2568
2580
 
2569
2581
  collection :page_categories, as: 'pageCategories'
2570
2582
  property :query, as: 'query'
2583
+ collection :safety_settings, as: 'safetySettings', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSafetySetting, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaSafetySetting::Representation
2584
+
2571
2585
  property :search_params, as: 'searchParams', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams::Representation
2572
2586
 
2573
2587
  property :user_info, as: 'userInfo', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaUserInfo::Representation
@@ -2621,8 +2635,13 @@ module Google
2621
2635
  property :conversation_id, as: 'conversationId'
2622
2636
  property :conversational_filtering_result, as: 'conversationalFilteringResult', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult::Representation
2623
2637
 
2638
+ property :conversational_text_response, as: 'conversationalTextResponse'
2639
+ property :followup_question, as: 'followupQuestion', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion::Representation
2640
+
2624
2641
  collection :refined_search, as: 'refinedSearch', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch::Representation
2625
2642
 
2643
+ property :state, as: 'state'
2644
+ collection :user_query_types, as: 'userQueryTypes'
2626
2645
  end
2627
2646
  end
2628
2647
 
@@ -3161,6 +3180,7 @@ module Google
3161
3180
  # @private
3162
3181
  class Representation < Google::Apis::Core::JsonRepresentation
3163
3182
  property :data_source_id, :numeric_string => true, as: 'dataSourceId'
3183
+ property :primary_feed_id, :numeric_string => true, as: 'primaryFeedId'
3164
3184
  property :primary_feed_name, as: 'primaryFeedName'
3165
3185
  end
3166
3186
  end
@@ -3297,6 +3317,19 @@ module Google
3297
3317
  end
3298
3318
  end
3299
3319
 
3320
+ class GoogleCloudRetailV2alphaPanelInfo
3321
+ # @private
3322
+ class Representation < Google::Apis::Core::JsonRepresentation
3323
+ property :attribution_token, as: 'attributionToken'
3324
+ property :display_name, as: 'displayName'
3325
+ property :panel_id, as: 'panelId'
3326
+ property :panel_position, as: 'panelPosition'
3327
+ collection :product_details, as: 'productDetails', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductDetail, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductDetail::Representation
3328
+
3329
+ property :total_panels, as: 'totalPanels'
3330
+ end
3331
+ end
3332
+
3300
3333
  class GoogleCloudRetailV2alphaPauseModelRequest
3301
3334
  # @private
3302
3335
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3778,6 +3811,15 @@ module Google
3778
3811
  end
3779
3812
  end
3780
3813
 
3814
+ class GoogleCloudRetailV2alphaSafetySetting
3815
+ # @private
3816
+ class Representation < Google::Apis::Core::JsonRepresentation
3817
+ property :category, as: 'category'
3818
+ property :method_prop, as: 'method'
3819
+ property :threshold, as: 'threshold'
3820
+ end
3821
+ end
3822
+
3781
3823
  class GoogleCloudRetailV2alphaSearchRequest
3782
3824
  # @private
3783
3825
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4178,6 +4220,8 @@ module Google
4178
4220
  property :order_by, as: 'orderBy'
4179
4221
  collection :page_categories, as: 'pageCategories'
4180
4222
  property :page_view_id, as: 'pageViewId'
4223
+ collection :panels, as: 'panels', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPanelInfo, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPanelInfo::Representation
4224
+
4181
4225
  collection :product_details, as: 'productDetails', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductDetail, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaProductDetail::Representation
4182
4226
 
4183
4227
  property :purchase_transaction, as: 'purchaseTransaction', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurchaseTransaction, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPurchaseTransaction::Representation
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.123.0
4
+ version: 0.125.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -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.123.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.125.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: