google-apis-retail_v2 0.100.0 → 0.102.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 50806bd8c7a875ac516316f6a64c9f35171c02406fa26f1396241e1b644d886a
4
- data.tar.gz: 0d789d23af963e470c21d523ae886456dc472254c60a1c9e924eb06d98e8862d
3
+ metadata.gz: 50d7c27a64e08e19a6f529f86ae53beb01553354756e8aef1a8805f6b0e3254a
4
+ data.tar.gz: 9601ce54bb68ca89eead885cf9cbc7b80f5bb9dea13d14e0b5cd56bad5f2895f
5
5
  SHA512:
6
- metadata.gz: 1c5bd392180f81e5b7cbf5792465faadb4ec1f8694afe3cbc7da22a49068f877dc1337eec26e656b1c4c7249b3af865bda9278930a62e4955fcdc8d24ffa879f
7
- data.tar.gz: 578c90d2dc71d6165e3a3912edb8fc081847ff0d96a44cccb3c4e29dd99c8a2b52dd61385bd95aa446d91faf27b501b8e2dc4c124c363011469ee9ffef349829
6
+ metadata.gz: 568da76f00586978646d74b5a85d0ea7ab3acf2228a4f321b848a4fdd1d517abad9b3712717ac4f96a29aae689e797b7a8182dc9887deda7ed703f7a71c46e79
7
+ data.tar.gz: d8b8e997e3c4677bd4992528e7a6b5b851f9cdab9ee706f27908b134b4fc27b2990946ddf94cc6807bae61616aba0a23cddb8ae02942c8ae8b3fd7063adb8c5e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.102.0 (2024-09-29)
4
+
5
+ * Regenerated from discovery document revision 20240920
6
+
7
+ ### v0.101.0 (2024-09-22)
8
+
9
+ * Regenerated from discovery document revision 20240912
10
+
3
11
  ### v0.100.0 (2024-09-01)
4
12
 
5
13
  * Regenerated from discovery document revision 20240822
@@ -560,6 +560,44 @@ module Google
560
560
  end
561
561
  end
562
562
 
563
+ # Request for BatchUpdateGenerativeQuestionConfig method.
564
+ class GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest
565
+ include Google::Apis::Core::Hashable
566
+
567
+ # Required. The updates question configs.
568
+ # Corresponds to the JSON property `requests`
569
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest>]
570
+ attr_accessor :requests
571
+
572
+ def initialize(**args)
573
+ update!(**args)
574
+ end
575
+
576
+ # Update properties of this object
577
+ def update!(**args)
578
+ @requests = args[:requests] if args.key?(:requests)
579
+ end
580
+ end
581
+
582
+ # Aggregated response for UpdateGenerativeQuestionConfig method.
583
+ class GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse
584
+ include Google::Apis::Core::Hashable
585
+
586
+ # Optional. The updates question configs.
587
+ # Corresponds to the JSON property `generativeQuestionConfigs`
588
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig>]
589
+ attr_accessor :generative_question_configs
590
+
591
+ def initialize(**args)
592
+ update!(**args)
593
+ end
594
+
595
+ # Update properties of this object
596
+ def update!(**args)
597
+ @generative_question_configs = args[:generative_question_configs] if args.key?(:generative_question_configs)
598
+ end
599
+ end
600
+
563
601
  # A BigQuery output result.
564
602
  class GoogleCloudRetailV2BigQueryOutputResult
565
603
  include Google::Apis::Core::Hashable
@@ -1805,6 +1843,99 @@ module Google
1805
1843
  end
1806
1844
  end
1807
1845
 
1846
+ # Configuration for a single generated question.
1847
+ class GoogleCloudRetailV2GenerativeQuestionConfig
1848
+ include Google::Apis::Core::Hashable
1849
+
1850
+ # Optional. Whether the question is asked at serving time.
1851
+ # Corresponds to the JSON property `allowedInConversation`
1852
+ # @return [Boolean]
1853
+ attr_accessor :allowed_in_conversation
1854
+ alias_method :allowed_in_conversation?, :allowed_in_conversation
1855
+
1856
+ # Required. Resource name of the catalog. Format: projects/`project`/locations/`
1857
+ # location`/catalogs/`catalog`
1858
+ # Corresponds to the JSON property `catalog`
1859
+ # @return [String]
1860
+ attr_accessor :catalog
1861
+
1862
+ # Output only. Values that can be used to answer the question.
1863
+ # Corresponds to the JSON property `exampleValues`
1864
+ # @return [Array<String>]
1865
+ attr_accessor :example_values
1866
+
1867
+ # Required. The facet to which the question is associated.
1868
+ # Corresponds to the JSON property `facet`
1869
+ # @return [String]
1870
+ attr_accessor :facet
1871
+
1872
+ # Optional. The question that will be used at serving time. Question can have a
1873
+ # max length of 300 bytes. When not populated, generated_question should be used.
1874
+ # Corresponds to the JSON property `finalQuestion`
1875
+ # @return [String]
1876
+ attr_accessor :final_question
1877
+
1878
+ # Output only. The ratio of how often a question was asked.
1879
+ # Corresponds to the JSON property `frequency`
1880
+ # @return [Float]
1881
+ attr_accessor :frequency
1882
+
1883
+ # Output only. The LLM generated question.
1884
+ # Corresponds to the JSON property `generatedQuestion`
1885
+ # @return [String]
1886
+ attr_accessor :generated_question
1887
+
1888
+ def initialize(**args)
1889
+ update!(**args)
1890
+ end
1891
+
1892
+ # Update properties of this object
1893
+ def update!(**args)
1894
+ @allowed_in_conversation = args[:allowed_in_conversation] if args.key?(:allowed_in_conversation)
1895
+ @catalog = args[:catalog] if args.key?(:catalog)
1896
+ @example_values = args[:example_values] if args.key?(:example_values)
1897
+ @facet = args[:facet] if args.key?(:facet)
1898
+ @final_question = args[:final_question] if args.key?(:final_question)
1899
+ @frequency = args[:frequency] if args.key?(:frequency)
1900
+ @generated_question = args[:generated_question] if args.key?(:generated_question)
1901
+ end
1902
+ end
1903
+
1904
+ # Configuration for overall generative question feature state.
1905
+ class GoogleCloudRetailV2GenerativeQuestionsFeatureConfig
1906
+ include Google::Apis::Core::Hashable
1907
+
1908
+ # Required. Resource name of the affected catalog. Format: projects/`project`/
1909
+ # locations/`location`/catalogs/`catalog`
1910
+ # Corresponds to the JSON property `catalog`
1911
+ # @return [String]
1912
+ attr_accessor :catalog
1913
+
1914
+ # Optional. Determines whether questions will be used at serving time. Note:
1915
+ # This feature cannot be enabled until initial data requirements are satisfied.
1916
+ # Corresponds to the JSON property `featureEnabled`
1917
+ # @return [Boolean]
1918
+ attr_accessor :feature_enabled
1919
+ alias_method :feature_enabled?, :feature_enabled
1920
+
1921
+ # Optional. Minimum number of products in the response to trigger follow-up
1922
+ # questions. Value must be 0 or positive.
1923
+ # Corresponds to the JSON property `minimumProducts`
1924
+ # @return [Fixnum]
1925
+ attr_accessor :minimum_products
1926
+
1927
+ def initialize(**args)
1928
+ update!(**args)
1929
+ end
1930
+
1931
+ # Update properties of this object
1932
+ def update!(**args)
1933
+ @catalog = args[:catalog] if args.key?(:catalog)
1934
+ @feature_enabled = args[:feature_enabled] if args.key?(:feature_enabled)
1935
+ @minimum_products = args[:minimum_products] if args.key?(:minimum_products)
1936
+ end
1937
+ end
1938
+
1808
1939
  # Response message of CatalogService.GetDefaultBranch.
1809
1940
  class GoogleCloudRetailV2GetDefaultBranchResponse
1810
1941
  include Google::Apis::Core::Hashable
@@ -2235,6 +2366,25 @@ module Google
2235
2366
  end
2236
2367
  end
2237
2368
 
2369
+ # Response for ListQuestions method.
2370
+ class GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse
2371
+ include Google::Apis::Core::Hashable
2372
+
2373
+ # All the questions for a given catalog.
2374
+ # Corresponds to the JSON property `generativeQuestionConfigs`
2375
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig>]
2376
+ attr_accessor :generative_question_configs
2377
+
2378
+ def initialize(**args)
2379
+ update!(**args)
2380
+ end
2381
+
2382
+ # Update properties of this object
2383
+ def update!(**args)
2384
+ @generative_question_configs = args[:generative_question_configs] if args.key?(:generative_question_configs)
2385
+ end
2386
+ end
2387
+
2238
2388
  # Response to a ListModelRequest.
2239
2389
  class GoogleCloudRetailV2ListModelsResponse
2240
2390
  include Google::Apis::Core::Hashable
@@ -3365,6 +3515,58 @@ module Google
3365
3515
  end
3366
3516
  end
3367
3517
 
3518
+ # Product attribute name and numeric interval.
3519
+ class GoogleCloudRetailV2ProductAttributeInterval
3520
+ include Google::Apis::Core::Hashable
3521
+
3522
+ # A floating point interval.
3523
+ # Corresponds to the JSON property `interval`
3524
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Interval]
3525
+ attr_accessor :interval
3526
+
3527
+ # The attribute name (e.g. "length")
3528
+ # Corresponds to the JSON property `name`
3529
+ # @return [String]
3530
+ attr_accessor :name
3531
+
3532
+ def initialize(**args)
3533
+ update!(**args)
3534
+ end
3535
+
3536
+ # Update properties of this object
3537
+ def update!(**args)
3538
+ @interval = args[:interval] if args.key?(:interval)
3539
+ @name = args[:name] if args.key?(:name)
3540
+ end
3541
+ end
3542
+
3543
+ # Product attribute which structured by an attribute name and value. This
3544
+ # structure is used in conversational search filters and answers. For example,
3545
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
3546
+ class GoogleCloudRetailV2ProductAttributeValue
3547
+ include Google::Apis::Core::Hashable
3548
+
3549
+ # The attribute name.
3550
+ # Corresponds to the JSON property `name`
3551
+ # @return [String]
3552
+ attr_accessor :name
3553
+
3554
+ # The attribute value.
3555
+ # Corresponds to the JSON property `value`
3556
+ # @return [String]
3557
+ attr_accessor :value
3558
+
3559
+ def initialize(**args)
3560
+ update!(**args)
3561
+ end
3562
+
3563
+ # Update properties of this object
3564
+ def update!(**args)
3565
+ @name = args[:name] if args.key?(:name)
3566
+ @value = args[:value] if args.key?(:value)
3567
+ end
3568
+ end
3569
+
3368
3570
  # Detailed product information associated with a user event.
3369
3571
  class GoogleCloudRetailV2ProductDetail
3370
3572
  include Google::Apis::Core::Hashable
@@ -4538,6 +4740,12 @@ module Google
4538
4740
  # @return [String]
4539
4741
  attr_accessor :canonical_filter
4540
4742
 
4743
+ # This field specifies all conversational related parameters addition to
4744
+ # traditional retail search.
4745
+ # Corresponds to the JSON property `conversationalSearchSpec`
4746
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpec]
4747
+ attr_accessor :conversational_search_spec
4748
+
4541
4749
  # The specifications of dynamically generated facets.
4542
4750
  # Corresponds to the JSON property `dynamicFacetSpec`
4543
4751
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec]
@@ -4654,6 +4862,11 @@ module Google
4654
4862
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec]
4655
4863
  attr_accessor :spell_correction_spec
4656
4864
 
4865
+ # This field specifies tile navigation related parameters.
4866
+ # Corresponds to the JSON property `tileNavigationSpec`
4867
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestTileNavigationSpec]
4868
+ attr_accessor :tile_navigation_spec
4869
+
4657
4870
  # Information of an end user.
4658
4871
  # Corresponds to the JSON property `userInfo`
4659
4872
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo]
@@ -4708,6 +4921,7 @@ module Google
4708
4921
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
4709
4922
  @branch = args[:branch] if args.key?(:branch)
4710
4923
  @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
4924
+ @conversational_search_spec = args[:conversational_search_spec] if args.key?(:conversational_search_spec)
4711
4925
  @dynamic_facet_spec = args[:dynamic_facet_spec] if args.key?(:dynamic_facet_spec)
4712
4926
  @entity = args[:entity] if args.key?(:entity)
4713
4927
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
@@ -4723,6 +4937,7 @@ module Google
4723
4937
  @query_expansion_spec = args[:query_expansion_spec] if args.key?(:query_expansion_spec)
4724
4938
  @search_mode = args[:search_mode] if args.key?(:search_mode)
4725
4939
  @spell_correction_spec = args[:spell_correction_spec] if args.key?(:spell_correction_spec)
4940
+ @tile_navigation_spec = args[:tile_navigation_spec] if args.key?(:tile_navigation_spec)
4726
4941
  @user_info = args[:user_info] if args.key?(:user_info)
4727
4942
  @variant_rollup_keys = args[:variant_rollup_keys] if args.key?(:variant_rollup_keys)
4728
4943
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
@@ -4798,6 +5013,102 @@ module Google
4798
5013
  end
4799
5014
  end
4800
5015
 
5016
+ # This field specifies all conversational related parameters addition to
5017
+ # traditional retail search.
5018
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpec
5019
+ include Google::Apis::Core::Hashable
5020
+
5021
+ # This field specifies the conversation id, which maintains the state of the
5022
+ # conversation between client side and server side. Use the value from the
5023
+ # previous ConversationalSearchResult.conversation_id. For the initial request,
5024
+ # this should be empty.
5025
+ # Corresponds to the JSON property `conversationId`
5026
+ # @return [String]
5027
+ attr_accessor :conversation_id
5028
+
5029
+ # This field specifies whether the customer would like to do conversational
5030
+ # search. If this field is set to true, conversational related extra information
5031
+ # will be returned from server side, including follow-up question, answer
5032
+ # options, etc.
5033
+ # Corresponds to the JSON property `followupConversationRequested`
5034
+ # @return [Boolean]
5035
+ attr_accessor :followup_conversation_requested
5036
+ alias_method :followup_conversation_requested?, :followup_conversation_requested
5037
+
5038
+ # This field specifies the current user answer during the conversational search.
5039
+ # This can be either user selected from suggested answers or user input plain
5040
+ # text.
5041
+ # Corresponds to the JSON property `userAnswer`
5042
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer]
5043
+ attr_accessor :user_answer
5044
+
5045
+ def initialize(**args)
5046
+ update!(**args)
5047
+ end
5048
+
5049
+ # Update properties of this object
5050
+ def update!(**args)
5051
+ @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
5052
+ @followup_conversation_requested = args[:followup_conversation_requested] if args.key?(:followup_conversation_requested)
5053
+ @user_answer = args[:user_answer] if args.key?(:user_answer)
5054
+ end
5055
+ end
5056
+
5057
+ # This field specifies the current user answer during the conversational search.
5058
+ # This can be either user selected from suggested answers or user input plain
5059
+ # text.
5060
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer
5061
+ include Google::Apis::Core::Hashable
5062
+
5063
+ # This field specifies the selected answers during the conversational search.
5064
+ # Corresponds to the JSON property `selectedAnswer`
5065
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer]
5066
+ attr_accessor :selected_answer
5067
+
5068
+ # This field specifies the incremental input text from the user during the
5069
+ # conversational search.
5070
+ # Corresponds to the JSON property `textAnswer`
5071
+ # @return [String]
5072
+ attr_accessor :text_answer
5073
+
5074
+ def initialize(**args)
5075
+ update!(**args)
5076
+ end
5077
+
5078
+ # Update properties of this object
5079
+ def update!(**args)
5080
+ @selected_answer = args[:selected_answer] if args.key?(:selected_answer)
5081
+ @text_answer = args[:text_answer] if args.key?(:text_answer)
5082
+ end
5083
+ end
5084
+
5085
+ # This field specifies the selected answers during the conversational search.
5086
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer
5087
+ include Google::Apis::Core::Hashable
5088
+
5089
+ # Product attribute which structured by an attribute name and value. This
5090
+ # structure is used in conversational search filters and answers. For example,
5091
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
5092
+ # Corresponds to the JSON property `productAttributeValue`
5093
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue]
5094
+ attr_accessor :product_attribute_value
5095
+
5096
+ # This field is deprecated and should not be set.
5097
+ # Corresponds to the JSON property `productAttributeValues`
5098
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue>]
5099
+ attr_accessor :product_attribute_values
5100
+
5101
+ def initialize(**args)
5102
+ update!(**args)
5103
+ end
5104
+
5105
+ # Update properties of this object
5106
+ def update!(**args)
5107
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
5108
+ @product_attribute_values = args[:product_attribute_values] if args.key?(:product_attribute_values)
5109
+ end
5110
+ end
5111
+
4801
5112
  # The specifications of dynamically generated facets.
4802
5113
  class GoogleCloudRetailV2SearchRequestDynamicFacetSpec
4803
5114
  include Google::Apis::Core::Hashable
@@ -5076,6 +5387,35 @@ module Google
5076
5387
  end
5077
5388
  end
5078
5389
 
5390
+ # This field specifies tile navigation related parameters.
5391
+ class GoogleCloudRetailV2SearchRequestTileNavigationSpec
5392
+ include Google::Apis::Core::Hashable
5393
+
5394
+ # This field specifies the tiles which are already clicked in client side. NOTE:
5395
+ # This field is not being used for filtering search products. Client side should
5396
+ # also put all the applied tiles in SearchRequest.filter.
5397
+ # Corresponds to the JSON property `appliedTiles`
5398
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Tile>]
5399
+ attr_accessor :applied_tiles
5400
+
5401
+ # This field specifies whether the customer would like to request tile
5402
+ # navigation.
5403
+ # Corresponds to the JSON property `tileNavigationRequested`
5404
+ # @return [Boolean]
5405
+ attr_accessor :tile_navigation_requested
5406
+ alias_method :tile_navigation_requested?, :tile_navigation_requested
5407
+
5408
+ def initialize(**args)
5409
+ update!(**args)
5410
+ end
5411
+
5412
+ # Update properties of this object
5413
+ def update!(**args)
5414
+ @applied_tiles = args[:applied_tiles] if args.key?(:applied_tiles)
5415
+ @tile_navigation_requested = args[:tile_navigation_requested] if args.key?(:tile_navigation_requested)
5416
+ end
5417
+ end
5418
+
5079
5419
  # Response message for SearchService.Search method.
5080
5420
  class GoogleCloudRetailV2SearchResponse
5081
5421
  include Google::Apis::Core::Hashable
@@ -5093,6 +5433,12 @@ module Google
5093
5433
  # @return [String]
5094
5434
  attr_accessor :attribution_token
5095
5435
 
5436
+ # This field specifies all related information that is needed on client side for
5437
+ # UI rendering of conversational retail search.
5438
+ # Corresponds to the JSON property `conversationalSearchResult`
5439
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResult]
5440
+ attr_accessor :conversational_search_result
5441
+
5096
5442
  # Contains the spell corrected query, if found. If the spell correction type is
5097
5443
  # AUTOMATIC, then the search results are based on corrected_query. Otherwise the
5098
5444
  # original query is used for search.
@@ -5141,6 +5487,12 @@ module Google
5141
5487
  # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseSearchResult>]
5142
5488
  attr_accessor :results
5143
5489
 
5490
+ # This field specifies all related information for tile navigation that will be
5491
+ # used in client side.
5492
+ # Corresponds to the JSON property `tileNavigationResult`
5493
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseTileNavigationResult]
5494
+ attr_accessor :tile_navigation_result
5495
+
5144
5496
  # The estimated total count of matched items irrespective of pagination. The
5145
5497
  # count of results returned by pagination may be less than the total_size that
5146
5498
  # matches.
@@ -5156,6 +5508,7 @@ module Google
5156
5508
  def update!(**args)
5157
5509
  @applied_controls = args[:applied_controls] if args.key?(:applied_controls)
5158
5510
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
5511
+ @conversational_search_result = args[:conversational_search_result] if args.key?(:conversational_search_result)
5159
5512
  @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
5160
5513
  @experiment_info = args[:experiment_info] if args.key?(:experiment_info)
5161
5514
  @facets = args[:facets] if args.key?(:facets)
@@ -5164,10 +5517,113 @@ module Google
5164
5517
  @query_expansion_info = args[:query_expansion_info] if args.key?(:query_expansion_info)
5165
5518
  @redirect_uri = args[:redirect_uri] if args.key?(:redirect_uri)
5166
5519
  @results = args[:results] if args.key?(:results)
5520
+ @tile_navigation_result = args[:tile_navigation_result] if args.key?(:tile_navigation_result)
5167
5521
  @total_size = args[:total_size] if args.key?(:total_size)
5168
5522
  end
5169
5523
  end
5170
5524
 
5525
+ # This field specifies all related information that is needed on client side for
5526
+ # UI rendering of conversational retail search.
5527
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResult
5528
+ include Google::Apis::Core::Hashable
5529
+
5530
+ # Additional filter that client side need to apply.
5531
+ # Corresponds to the JSON property `additionalFilter`
5532
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter]
5533
+ attr_accessor :additional_filter
5534
+
5535
+ # This field is deprecated but will be kept for backward compatibility. There is
5536
+ # expected to have only one additional filter and the value will be the same to
5537
+ # the same as field `additional_filter`.
5538
+ # Corresponds to the JSON property `additionalFilters`
5539
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter>]
5540
+ attr_accessor :additional_filters
5541
+
5542
+ # Conversation UUID. This field will be stored in client side storage to
5543
+ # maintain the conversation session with server and will be used for next search
5544
+ # request's SearchRequest.ConversationalSearchSpec.conversation_id to restore
5545
+ # conversation state in server.
5546
+ # Corresponds to the JSON property `conversationId`
5547
+ # @return [String]
5548
+ attr_accessor :conversation_id
5549
+
5550
+ # The follow-up question. e.g., `What is the color?`
5551
+ # Corresponds to the JSON property `followupQuestion`
5552
+ # @return [String]
5553
+ attr_accessor :followup_question
5554
+
5555
+ # The current refined query for the conversational search. This field will be
5556
+ # used in customer UI that the query in the search bar should be replaced with
5557
+ # the refined query. For example, if SearchRequest.query is `dress` and next
5558
+ # SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`,
5559
+ # which does not match any product attribute value filters, the refined query
5560
+ # will be `dress, red color`.
5561
+ # Corresponds to the JSON property `refinedQuery`
5562
+ # @return [String]
5563
+ attr_accessor :refined_query
5564
+
5565
+ # The answer options provided to client for the follow-up question.
5566
+ # Corresponds to the JSON property `suggestedAnswers`
5567
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer>]
5568
+ attr_accessor :suggested_answers
5569
+
5570
+ def initialize(**args)
5571
+ update!(**args)
5572
+ end
5573
+
5574
+ # Update properties of this object
5575
+ def update!(**args)
5576
+ @additional_filter = args[:additional_filter] if args.key?(:additional_filter)
5577
+ @additional_filters = args[:additional_filters] if args.key?(:additional_filters)
5578
+ @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
5579
+ @followup_question = args[:followup_question] if args.key?(:followup_question)
5580
+ @refined_query = args[:refined_query] if args.key?(:refined_query)
5581
+ @suggested_answers = args[:suggested_answers] if args.key?(:suggested_answers)
5582
+ end
5583
+ end
5584
+
5585
+ # Additional filter that client side need to apply.
5586
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter
5587
+ include Google::Apis::Core::Hashable
5588
+
5589
+ # Product attribute which structured by an attribute name and value. This
5590
+ # structure is used in conversational search filters and answers. For example,
5591
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
5592
+ # Corresponds to the JSON property `productAttributeValue`
5593
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue]
5594
+ attr_accessor :product_attribute_value
5595
+
5596
+ def initialize(**args)
5597
+ update!(**args)
5598
+ end
5599
+
5600
+ # Update properties of this object
5601
+ def update!(**args)
5602
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
5603
+ end
5604
+ end
5605
+
5606
+ # Suggested answers to the follow-up question.
5607
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer
5608
+ include Google::Apis::Core::Hashable
5609
+
5610
+ # Product attribute which structured by an attribute name and value. This
5611
+ # structure is used in conversational search filters and answers. For example,
5612
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
5613
+ # Corresponds to the JSON property `productAttributeValue`
5614
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue]
5615
+ attr_accessor :product_attribute_value
5616
+
5617
+ def initialize(**args)
5618
+ update!(**args)
5619
+ end
5620
+
5621
+ # Update properties of this object
5622
+ def update!(**args)
5623
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
5624
+ end
5625
+ end
5626
+
5171
5627
  # A facet result.
5172
5628
  class GoogleCloudRetailV2SearchResponseFacet
5173
5629
  include Google::Apis::Core::Hashable
@@ -5343,6 +5799,26 @@ module Google
5343
5799
  end
5344
5800
  end
5345
5801
 
5802
+ # This field specifies all related information for tile navigation that will be
5803
+ # used in client side.
5804
+ class GoogleCloudRetailV2SearchResponseTileNavigationResult
5805
+ include Google::Apis::Core::Hashable
5806
+
5807
+ # The current tiles that are used for tile navigation, sorted by engagement.
5808
+ # Corresponds to the JSON property `tiles`
5809
+ # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Tile>]
5810
+ attr_accessor :tiles
5811
+
5812
+ def initialize(**args)
5813
+ update!(**args)
5814
+ end
5815
+
5816
+ # Update properties of this object
5817
+ def update!(**args)
5818
+ @tiles = args[:tiles] if args.key?(:tiles)
5819
+ end
5820
+ end
5821
+
5346
5822
  # Configures metadata that is used to generate serving time results (e.g. search
5347
5823
  # results or recommendation predictions).
5348
5824
  class GoogleCloudRetailV2ServingConfig
@@ -5653,6 +6129,41 @@ module Google
5653
6129
  end
5654
6130
  end
5655
6131
 
6132
+ # This field specifies the tile information including an attribute key,
6133
+ # attribute value. More fields will be added in the future, eg: product id or
6134
+ # product counts, etc.
6135
+ class GoogleCloudRetailV2Tile
6136
+ include Google::Apis::Core::Hashable
6137
+
6138
+ # Product attribute name and numeric interval.
6139
+ # Corresponds to the JSON property `productAttributeInterval`
6140
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeInterval]
6141
+ attr_accessor :product_attribute_interval
6142
+
6143
+ # Product attribute which structured by an attribute name and value. This
6144
+ # structure is used in conversational search filters and answers. For example,
6145
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
6146
+ # Corresponds to the JSON property `productAttributeValue`
6147
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue]
6148
+ attr_accessor :product_attribute_value
6149
+
6150
+ # The representative product id for this tile.
6151
+ # Corresponds to the JSON property `representativeProductId`
6152
+ # @return [String]
6153
+ attr_accessor :representative_product_id
6154
+
6155
+ def initialize(**args)
6156
+ update!(**args)
6157
+ end
6158
+
6159
+ # Update properties of this object
6160
+ def update!(**args)
6161
+ @product_attribute_interval = args[:product_attribute_interval] if args.key?(:product_attribute_interval)
6162
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
6163
+ @representative_product_id = args[:representative_product_id] if args.key?(:representative_product_id)
6164
+ end
6165
+ end
6166
+
5656
6167
  # Metadata associated with a tune operation.
5657
6168
  class GoogleCloudRetailV2TuneModelMetadata
5658
6169
  include Google::Apis::Core::Hashable
@@ -5701,6 +6212,33 @@ module Google
5701
6212
  end
5702
6213
  end
5703
6214
 
6215
+ # Request for UpdateGenerativeQuestionConfig method.
6216
+ class GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest
6217
+ include Google::Apis::Core::Hashable
6218
+
6219
+ # Configuration for a single generated question.
6220
+ # Corresponds to the JSON property `generativeQuestionConfig`
6221
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig]
6222
+ attr_accessor :generative_question_config
6223
+
6224
+ # Optional. Indicates which fields in the provided GenerativeQuestionConfig to
6225
+ # update. The following are NOT supported: * GenerativeQuestionConfig.frequency
6226
+ # If not set or empty, all supported fields are updated.
6227
+ # Corresponds to the JSON property `updateMask`
6228
+ # @return [String]
6229
+ attr_accessor :update_mask
6230
+
6231
+ def initialize(**args)
6232
+ update!(**args)
6233
+ end
6234
+
6235
+ # Update properties of this object
6236
+ def update!(**args)
6237
+ @generative_question_config = args[:generative_question_config] if args.key?(:generative_question_config)
6238
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
6239
+ end
6240
+ end
6241
+
5704
6242
  # UserEvent captures all metadata information Retail API needs to know about how
5705
6243
  # end users interact with customers' website.
5706
6244
  class GoogleCloudRetailV2UserEvent
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module RetailV2
18
18
  # Version of the google-apis-retail_v2 gem
19
- GEM_VERSION = "0.100.0"
19
+ GEM_VERSION = "0.102.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.15.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240822"
25
+ REVISION = "20240920"
26
26
  end
27
27
  end
28
28
  end
@@ -124,6 +124,18 @@ module Google
124
124
  include Google::Apis::Core::JsonObjectSupport
125
125
  end
126
126
 
127
+ class GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest
128
+ class Representation < Google::Apis::Core::JsonRepresentation; end
129
+
130
+ include Google::Apis::Core::JsonObjectSupport
131
+ end
132
+
133
+ class GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
127
139
  class GoogleCloudRetailV2BigQueryOutputResult
128
140
  class Representation < Google::Apis::Core::JsonRepresentation; end
129
141
 
@@ -316,6 +328,18 @@ module Google
316
328
  include Google::Apis::Core::JsonObjectSupport
317
329
  end
318
330
 
331
+ class GoogleCloudRetailV2GenerativeQuestionConfig
332
+ class Representation < Google::Apis::Core::JsonRepresentation; end
333
+
334
+ include Google::Apis::Core::JsonObjectSupport
335
+ end
336
+
337
+ class GoogleCloudRetailV2GenerativeQuestionsFeatureConfig
338
+ class Representation < Google::Apis::Core::JsonRepresentation; end
339
+
340
+ include Google::Apis::Core::JsonObjectSupport
341
+ end
342
+
319
343
  class GoogleCloudRetailV2GetDefaultBranchResponse
320
344
  class Representation < Google::Apis::Core::JsonRepresentation; end
321
345
 
@@ -394,6 +418,12 @@ module Google
394
418
  include Google::Apis::Core::JsonObjectSupport
395
419
  end
396
420
 
421
+ class GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse
422
+ class Representation < Google::Apis::Core::JsonRepresentation; end
423
+
424
+ include Google::Apis::Core::JsonObjectSupport
425
+ end
426
+
397
427
  class GoogleCloudRetailV2ListModelsResponse
398
428
  class Representation < Google::Apis::Core::JsonRepresentation; end
399
429
 
@@ -508,6 +538,18 @@ module Google
508
538
  include Google::Apis::Core::JsonObjectSupport
509
539
  end
510
540
 
541
+ class GoogleCloudRetailV2ProductAttributeInterval
542
+ class Representation < Google::Apis::Core::JsonRepresentation; end
543
+
544
+ include Google::Apis::Core::JsonObjectSupport
545
+ end
546
+
547
+ class GoogleCloudRetailV2ProductAttributeValue
548
+ class Representation < Google::Apis::Core::JsonRepresentation; end
549
+
550
+ include Google::Apis::Core::JsonObjectSupport
551
+ end
552
+
511
553
  class GoogleCloudRetailV2ProductDetail
512
554
  class Representation < Google::Apis::Core::JsonRepresentation; end
513
555
 
@@ -754,6 +796,24 @@ module Google
754
796
  include Google::Apis::Core::JsonObjectSupport
755
797
  end
756
798
 
799
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpec
800
+ class Representation < Google::Apis::Core::JsonRepresentation; end
801
+
802
+ include Google::Apis::Core::JsonObjectSupport
803
+ end
804
+
805
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer
806
+ class Representation < Google::Apis::Core::JsonRepresentation; end
807
+
808
+ include Google::Apis::Core::JsonObjectSupport
809
+ end
810
+
811
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer
812
+ class Representation < Google::Apis::Core::JsonRepresentation; end
813
+
814
+ include Google::Apis::Core::JsonObjectSupport
815
+ end
816
+
757
817
  class GoogleCloudRetailV2SearchRequestDynamicFacetSpec
758
818
  class Representation < Google::Apis::Core::JsonRepresentation; end
759
819
 
@@ -790,12 +850,36 @@ module Google
790
850
  include Google::Apis::Core::JsonObjectSupport
791
851
  end
792
852
 
853
+ class GoogleCloudRetailV2SearchRequestTileNavigationSpec
854
+ class Representation < Google::Apis::Core::JsonRepresentation; end
855
+
856
+ include Google::Apis::Core::JsonObjectSupport
857
+ end
858
+
793
859
  class GoogleCloudRetailV2SearchResponse
794
860
  class Representation < Google::Apis::Core::JsonRepresentation; end
795
861
 
796
862
  include Google::Apis::Core::JsonObjectSupport
797
863
  end
798
864
 
865
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResult
866
+ class Representation < Google::Apis::Core::JsonRepresentation; end
867
+
868
+ include Google::Apis::Core::JsonObjectSupport
869
+ end
870
+
871
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter
872
+ class Representation < Google::Apis::Core::JsonRepresentation; end
873
+
874
+ include Google::Apis::Core::JsonObjectSupport
875
+ end
876
+
877
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer
878
+ class Representation < Google::Apis::Core::JsonRepresentation; end
879
+
880
+ include Google::Apis::Core::JsonObjectSupport
881
+ end
882
+
799
883
  class GoogleCloudRetailV2SearchResponseFacet
800
884
  class Representation < Google::Apis::Core::JsonRepresentation; end
801
885
 
@@ -820,6 +904,12 @@ module Google
820
904
  include Google::Apis::Core::JsonObjectSupport
821
905
  end
822
906
 
907
+ class GoogleCloudRetailV2SearchResponseTileNavigationResult
908
+ class Representation < Google::Apis::Core::JsonRepresentation; end
909
+
910
+ include Google::Apis::Core::JsonObjectSupport
911
+ end
912
+
823
913
  class GoogleCloudRetailV2ServingConfig
824
914
  class Representation < Google::Apis::Core::JsonRepresentation; end
825
915
 
@@ -850,6 +940,12 @@ module Google
850
940
  include Google::Apis::Core::JsonObjectSupport
851
941
  end
852
942
 
943
+ class GoogleCloudRetailV2Tile
944
+ class Representation < Google::Apis::Core::JsonRepresentation; end
945
+
946
+ include Google::Apis::Core::JsonObjectSupport
947
+ end
948
+
853
949
  class GoogleCloudRetailV2TuneModelMetadata
854
950
  class Representation < Google::Apis::Core::JsonRepresentation; end
855
951
 
@@ -868,6 +964,12 @@ module Google
868
964
  include Google::Apis::Core::JsonObjectSupport
869
965
  end
870
966
 
967
+ class GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest
968
+ class Representation < Google::Apis::Core::JsonRepresentation; end
969
+
970
+ include Google::Apis::Core::JsonObjectSupport
971
+ end
972
+
871
973
  class GoogleCloudRetailV2UserEvent
872
974
  class Representation < Google::Apis::Core::JsonRepresentation; end
873
975
 
@@ -1573,6 +1675,22 @@ module Google
1573
1675
  end
1574
1676
  end
1575
1677
 
1678
+ class GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest
1679
+ # @private
1680
+ class Representation < Google::Apis::Core::JsonRepresentation
1681
+ collection :requests, as: 'requests', class: Google::Apis::RetailV2::GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest::Representation
1682
+
1683
+ end
1684
+ end
1685
+
1686
+ class GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse
1687
+ # @private
1688
+ class Representation < Google::Apis::Core::JsonRepresentation
1689
+ collection :generative_question_configs, as: 'generativeQuestionConfigs', class: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig::Representation
1690
+
1691
+ end
1692
+ end
1693
+
1576
1694
  class GoogleCloudRetailV2BigQueryOutputResult
1577
1695
  # @private
1578
1696
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1882,6 +2000,28 @@ module Google
1882
2000
  end
1883
2001
  end
1884
2002
 
2003
+ class GoogleCloudRetailV2GenerativeQuestionConfig
2004
+ # @private
2005
+ class Representation < Google::Apis::Core::JsonRepresentation
2006
+ property :allowed_in_conversation, as: 'allowedInConversation'
2007
+ property :catalog, as: 'catalog'
2008
+ collection :example_values, as: 'exampleValues'
2009
+ property :facet, as: 'facet'
2010
+ property :final_question, as: 'finalQuestion'
2011
+ property :frequency, as: 'frequency'
2012
+ property :generated_question, as: 'generatedQuestion'
2013
+ end
2014
+ end
2015
+
2016
+ class GoogleCloudRetailV2GenerativeQuestionsFeatureConfig
2017
+ # @private
2018
+ class Representation < Google::Apis::Core::JsonRepresentation
2019
+ property :catalog, as: 'catalog'
2020
+ property :feature_enabled, as: 'featureEnabled'
2021
+ property :minimum_products, as: 'minimumProducts'
2022
+ end
2023
+ end
2024
+
1885
2025
  class GoogleCloudRetailV2GetDefaultBranchResponse
1886
2026
  # @private
1887
2027
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2010,6 +2150,14 @@ module Google
2010
2150
  end
2011
2151
  end
2012
2152
 
2153
+ class GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse
2154
+ # @private
2155
+ class Representation < Google::Apis::Core::JsonRepresentation
2156
+ collection :generative_question_configs, as: 'generativeQuestionConfigs', class: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig::Representation
2157
+
2158
+ end
2159
+ end
2160
+
2013
2161
  class GoogleCloudRetailV2ListModelsResponse
2014
2162
  # @private
2015
2163
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2243,6 +2391,23 @@ module Google
2243
2391
  end
2244
2392
  end
2245
2393
 
2394
+ class GoogleCloudRetailV2ProductAttributeInterval
2395
+ # @private
2396
+ class Representation < Google::Apis::Core::JsonRepresentation
2397
+ property :interval, as: 'interval', class: Google::Apis::RetailV2::GoogleCloudRetailV2Interval, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Interval::Representation
2398
+
2399
+ property :name, as: 'name'
2400
+ end
2401
+ end
2402
+
2403
+ class GoogleCloudRetailV2ProductAttributeValue
2404
+ # @private
2405
+ class Representation < Google::Apis::Core::JsonRepresentation
2406
+ property :name, as: 'name'
2407
+ property :value, as: 'value'
2408
+ end
2409
+ end
2410
+
2246
2411
  class GoogleCloudRetailV2ProductDetail
2247
2412
  # @private
2248
2413
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2567,6 +2732,8 @@ module Google
2567
2732
 
2568
2733
  property :branch, as: 'branch'
2569
2734
  property :canonical_filter, as: 'canonicalFilter'
2735
+ property :conversational_search_spec, as: 'conversationalSearchSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpec::Representation
2736
+
2570
2737
  property :dynamic_facet_spec, as: 'dynamicFacetSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestDynamicFacetSpec::Representation
2571
2738
 
2572
2739
  property :entity, as: 'entity'
@@ -2587,6 +2754,8 @@ module Google
2587
2754
  property :search_mode, as: 'searchMode'
2588
2755
  property :spell_correction_spec, as: 'spellCorrectionSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestSpellCorrectionSpec::Representation
2589
2756
 
2757
+ property :tile_navigation_spec, as: 'tileNavigationSpec', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestTileNavigationSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestTileNavigationSpec::Representation
2758
+
2590
2759
  property :user_info, as: 'userInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo::Representation
2591
2760
 
2592
2761
  collection :variant_rollup_keys, as: 'variantRollupKeys'
@@ -2611,6 +2780,35 @@ module Google
2611
2780
  end
2612
2781
  end
2613
2782
 
2783
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpec
2784
+ # @private
2785
+ class Representation < Google::Apis::Core::JsonRepresentation
2786
+ property :conversation_id, as: 'conversationId'
2787
+ property :followup_conversation_requested, as: 'followupConversationRequested'
2788
+ property :user_answer, as: 'userAnswer', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer::Representation
2789
+
2790
+ end
2791
+ end
2792
+
2793
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer
2794
+ # @private
2795
+ class Representation < Google::Apis::Core::JsonRepresentation
2796
+ property :selected_answer, as: 'selectedAnswer', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer::Representation
2797
+
2798
+ property :text_answer, as: 'textAnswer'
2799
+ end
2800
+ end
2801
+
2802
+ class GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer
2803
+ # @private
2804
+ class Representation < Google::Apis::Core::JsonRepresentation
2805
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue::Representation
2806
+
2807
+ collection :product_attribute_values, as: 'productAttributeValues', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue::Representation
2808
+
2809
+ end
2810
+ end
2811
+
2614
2812
  class GoogleCloudRetailV2SearchRequestDynamicFacetSpec
2615
2813
  # @private
2616
2814
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2667,11 +2865,22 @@ module Google
2667
2865
  end
2668
2866
  end
2669
2867
 
2868
+ class GoogleCloudRetailV2SearchRequestTileNavigationSpec
2869
+ # @private
2870
+ class Representation < Google::Apis::Core::JsonRepresentation
2871
+ collection :applied_tiles, as: 'appliedTiles', class: Google::Apis::RetailV2::GoogleCloudRetailV2Tile, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Tile::Representation
2872
+
2873
+ property :tile_navigation_requested, as: 'tileNavigationRequested'
2874
+ end
2875
+ end
2876
+
2670
2877
  class GoogleCloudRetailV2SearchResponse
2671
2878
  # @private
2672
2879
  class Representation < Google::Apis::Core::JsonRepresentation
2673
2880
  collection :applied_controls, as: 'appliedControls'
2674
2881
  property :attribution_token, as: 'attributionToken'
2882
+ property :conversational_search_result, as: 'conversationalSearchResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResult::Representation
2883
+
2675
2884
  property :corrected_query, as: 'correctedQuery'
2676
2885
  collection :experiment_info, as: 'experimentInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo::Representation
2677
2886
 
@@ -2685,10 +2894,43 @@ module Google
2685
2894
  property :redirect_uri, as: 'redirectUri'
2686
2895
  collection :results, as: 'results', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseSearchResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseSearchResult::Representation
2687
2896
 
2897
+ property :tile_navigation_result, as: 'tileNavigationResult', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseTileNavigationResult, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseTileNavigationResult::Representation
2898
+
2688
2899
  property :total_size, as: 'totalSize'
2689
2900
  end
2690
2901
  end
2691
2902
 
2903
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResult
2904
+ # @private
2905
+ class Representation < Google::Apis::Core::JsonRepresentation
2906
+ property :additional_filter, as: 'additionalFilter', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter::Representation
2907
+
2908
+ collection :additional_filters, as: 'additionalFilters', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter::Representation
2909
+
2910
+ property :conversation_id, as: 'conversationId'
2911
+ property :followup_question, as: 'followupQuestion'
2912
+ property :refined_query, as: 'refinedQuery'
2913
+ collection :suggested_answers, as: 'suggestedAnswers', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer::Representation
2914
+
2915
+ end
2916
+ end
2917
+
2918
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter
2919
+ # @private
2920
+ class Representation < Google::Apis::Core::JsonRepresentation
2921
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue::Representation
2922
+
2923
+ end
2924
+ end
2925
+
2926
+ class GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer
2927
+ # @private
2928
+ class Representation < Google::Apis::Core::JsonRepresentation
2929
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue::Representation
2930
+
2931
+ end
2932
+ end
2933
+
2692
2934
  class GoogleCloudRetailV2SearchResponseFacet
2693
2935
  # @private
2694
2936
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2732,6 +2974,14 @@ module Google
2732
2974
  end
2733
2975
  end
2734
2976
 
2977
+ class GoogleCloudRetailV2SearchResponseTileNavigationResult
2978
+ # @private
2979
+ class Representation < Google::Apis::Core::JsonRepresentation
2980
+ collection :tiles, as: 'tiles', class: Google::Apis::RetailV2::GoogleCloudRetailV2Tile, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Tile::Representation
2981
+
2982
+ end
2983
+ end
2984
+
2735
2985
  class GoogleCloudRetailV2ServingConfig
2736
2986
  # @private
2737
2987
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2792,6 +3042,17 @@ module Google
2792
3042
  end
2793
3043
  end
2794
3044
 
3045
+ class GoogleCloudRetailV2Tile
3046
+ # @private
3047
+ class Representation < Google::Apis::Core::JsonRepresentation
3048
+ property :product_attribute_interval, as: 'productAttributeInterval', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeInterval, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeInterval::Representation
3049
+
3050
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ProductAttributeValue::Representation
3051
+
3052
+ property :representative_product_id, as: 'representativeProductId'
3053
+ end
3054
+ end
3055
+
2795
3056
  class GoogleCloudRetailV2TuneModelMetadata
2796
3057
  # @private
2797
3058
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2811,6 +3072,15 @@ module Google
2811
3072
  end
2812
3073
  end
2813
3074
 
3075
+ class GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest
3076
+ # @private
3077
+ class Representation < Google::Apis::Core::JsonRepresentation
3078
+ property :generative_question_config, as: 'generativeQuestionConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig::Representation
3079
+
3080
+ property :update_mask, as: 'updateMask'
3081
+ end
3082
+ end
3083
+
2814
3084
  class GoogleCloudRetailV2UserEvent
2815
3085
  # @private
2816
3086
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -269,6 +269,38 @@ module Google
269
269
  execute_or_queue_command(command, &block)
270
270
  end
271
271
 
272
+ # Manages overal generative question feature state -- enables toggling feature
273
+ # on and off.
274
+ # @param [String] catalog
275
+ # Required. Resource name of the parent catalog. Format: projects/`project`/
276
+ # locations/`location`/catalogs/`catalog`
277
+ # @param [String] fields
278
+ # Selector specifying which fields to include in a partial response.
279
+ # @param [String] quota_user
280
+ # Available to use for quota purposes for server-side applications. Can be any
281
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
282
+ # @param [Google::Apis::RequestOptions] options
283
+ # Request-specific options
284
+ #
285
+ # @yield [result, err] Result & error if block supplied
286
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionsFeatureConfig] parsed result object
287
+ # @yieldparam err [StandardError] error object if request failed
288
+ #
289
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionsFeatureConfig]
290
+ #
291
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
292
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
293
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
294
+ def get_project_location_catalog_generative_question_feature(catalog, fields: nil, quota_user: nil, options: nil, &block)
295
+ command = make_simple_command(:get, 'v2/{+catalog}/generativeQuestionFeature', options)
296
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionsFeatureConfig::Representation
297
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionsFeatureConfig
298
+ command.params['catalog'] = catalog unless catalog.nil?
299
+ command.query['fields'] = fields unless fields.nil?
300
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
301
+ execute_or_queue_command(command, &block)
302
+ end
303
+
272
304
  # Lists all the Catalogs associated with the project.
273
305
  # @param [String] parent
274
306
  # Required. The account resource name with an associated location. If the caller
@@ -486,6 +518,85 @@ module Google
486
518
  execute_or_queue_command(command, &block)
487
519
  end
488
520
 
521
+ # Allows management of individual questions.
522
+ # @param [String] catalog
523
+ # Required. Resource name of the catalog. Format: projects/`project`/locations/`
524
+ # location`/catalogs/`catalog`
525
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig] google_cloud_retail_v2_generative_question_config_object
526
+ # @param [String] update_mask
527
+ # Optional. Indicates which fields in the provided GenerativeQuestionConfig to
528
+ # update. The following are NOT supported: * GenerativeQuestionConfig.frequency
529
+ # If not set or empty, all supported fields are updated.
530
+ # @param [String] fields
531
+ # Selector specifying which fields to include in a partial response.
532
+ # @param [String] quota_user
533
+ # Available to use for quota purposes for server-side applications. Can be any
534
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
535
+ # @param [Google::Apis::RequestOptions] options
536
+ # Request-specific options
537
+ #
538
+ # @yield [result, err] Result & error if block supplied
539
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig] parsed result object
540
+ # @yieldparam err [StandardError] error object if request failed
541
+ #
542
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig]
543
+ #
544
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
545
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
546
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
547
+ def update_project_location_catalog_generative_question(catalog, google_cloud_retail_v2_generative_question_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
548
+ command = make_simple_command(:patch, 'v2/{+catalog}/generativeQuestion', options)
549
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig::Representation
550
+ command.request_object = google_cloud_retail_v2_generative_question_config_object
551
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig::Representation
552
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig
553
+ command.params['catalog'] = catalog unless catalog.nil?
554
+ command.query['updateMask'] = update_mask unless update_mask.nil?
555
+ command.query['fields'] = fields unless fields.nil?
556
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
557
+ execute_or_queue_command(command, &block)
558
+ end
559
+
560
+ # Manages overal generative question feature state -- enables toggling feature
561
+ # on and off.
562
+ # @param [String] catalog
563
+ # Required. Resource name of the affected catalog. Format: projects/`project`/
564
+ # locations/`location`/catalogs/`catalog`
565
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionsFeatureConfig] google_cloud_retail_v2_generative_questions_feature_config_object
566
+ # @param [String] update_mask
567
+ # Optional. Indicates which fields in the provided
568
+ # GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported
569
+ # fields are updated.
570
+ # @param [String] fields
571
+ # Selector specifying which fields to include in a partial response.
572
+ # @param [String] quota_user
573
+ # Available to use for quota purposes for server-side applications. Can be any
574
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
575
+ # @param [Google::Apis::RequestOptions] options
576
+ # Request-specific options
577
+ #
578
+ # @yield [result, err] Result & error if block supplied
579
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionsFeatureConfig] parsed result object
580
+ # @yieldparam err [StandardError] error object if request failed
581
+ #
582
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionsFeatureConfig]
583
+ #
584
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
585
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
586
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
587
+ def update_project_location_catalog_generative_question_feature(catalog, google_cloud_retail_v2_generative_questions_feature_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
588
+ command = make_simple_command(:patch, 'v2/{+catalog}/generativeQuestionFeature', options)
589
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionsFeatureConfig::Representation
590
+ command.request_object = google_cloud_retail_v2_generative_questions_feature_config_object
591
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionsFeatureConfig::Representation
592
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionsFeatureConfig
593
+ command.params['catalog'] = catalog unless catalog.nil?
594
+ command.query['updateMask'] = update_mask unless update_mask.nil?
595
+ command.query['fields'] = fields unless fields.nil?
596
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
597
+ execute_or_queue_command(command, &block)
598
+ end
599
+
489
600
  # Adds the specified CatalogAttribute to the AttributesConfig. If the
490
601
  # CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
491
602
  # @param [String] attributes_config
@@ -1405,6 +1516,71 @@ module Google
1405
1516
  execute_or_queue_command(command, &block)
1406
1517
  end
1407
1518
 
1519
+ # Allows management of multiple questions.
1520
+ # @param [String] parent
1521
+ # Optional. Resource name of the parent catalog. Format: projects/`project`/
1522
+ # locations/`location`/catalogs/`catalog`
1523
+ # @param [Google::Apis::RetailV2::GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest] google_cloud_retail_v2_batch_update_generative_question_configs_request_object
1524
+ # @param [String] fields
1525
+ # Selector specifying which fields to include in a partial response.
1526
+ # @param [String] quota_user
1527
+ # Available to use for quota purposes for server-side applications. Can be any
1528
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1529
+ # @param [Google::Apis::RequestOptions] options
1530
+ # Request-specific options
1531
+ #
1532
+ # @yield [result, err] Result & error if block supplied
1533
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse] parsed result object
1534
+ # @yieldparam err [StandardError] error object if request failed
1535
+ #
1536
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse]
1537
+ #
1538
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1539
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1540
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1541
+ def batch_project_location_catalog_generative_question_update(parent, google_cloud_retail_v2_batch_update_generative_question_configs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1542
+ command = make_simple_command(:post, 'v2/{+parent}/generativeQuestion:batchUpdate', options)
1543
+ command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest::Representation
1544
+ command.request_object = google_cloud_retail_v2_batch_update_generative_question_configs_request_object
1545
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse::Representation
1546
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse
1547
+ command.params['parent'] = parent unless parent.nil?
1548
+ command.query['fields'] = fields unless fields.nil?
1549
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1550
+ execute_or_queue_command(command, &block)
1551
+ end
1552
+
1553
+ # Returns all questions for a given catalog.
1554
+ # @param [String] parent
1555
+ # Required. Resource name of the parent catalog. Format: projects/`project`/
1556
+ # locations/`location`/catalogs/`catalog`
1557
+ # @param [String] fields
1558
+ # Selector specifying which fields to include in a partial response.
1559
+ # @param [String] quota_user
1560
+ # Available to use for quota purposes for server-side applications. Can be any
1561
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1562
+ # @param [Google::Apis::RequestOptions] options
1563
+ # Request-specific options
1564
+ #
1565
+ # @yield [result, err] Result & error if block supplied
1566
+ # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse] parsed result object
1567
+ # @yieldparam err [StandardError] error object if request failed
1568
+ #
1569
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse]
1570
+ #
1571
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1572
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1573
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1574
+ def list_project_location_catalog_generative_questions(parent, fields: nil, quota_user: nil, options: nil, &block)
1575
+ command = make_simple_command(:get, 'v2/{+parent}/generativeQuestions', options)
1576
+ command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse::Representation
1577
+ command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse
1578
+ command.params['parent'] = parent unless parent.nil?
1579
+ command.query['fields'] = fields unless fields.nil?
1580
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1581
+ execute_or_queue_command(command, &block)
1582
+ end
1583
+
1408
1584
  # Creates a new model.
1409
1585
  # @param [String] parent
1410
1586
  # Required. The parent resource under which to create the model. Format: `
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-retail_v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.100.0
4
+ version: 0.102.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-09-01 00:00:00.000000000 Z
11
+ date: 2024-09-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.100.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.102.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
63
63
  post_install_message:
64
64
  rdoc_options: []