google-apis-retail_v2 0.101.0 → 0.103.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: 680a42cf4e9f51dd52a643eb7048e676921274048e424a19ddb013b9315b8b5f
4
- data.tar.gz: 1fdb8add6adb047d7595716b8728df06f6409b67796868c97accd101fde65563
3
+ metadata.gz: 845ece90df9a03d0e6752d7e388be862181bef94869bd0b91df52d40d922390b
4
+ data.tar.gz: d706233e2cfd05bd919ccd226c41747f9e9291ca3ed9116d049a5264f0fc316d
5
5
  SHA512:
6
- metadata.gz: 30fc70bd16a6f9363260f365a428e7b17e2caab331fc82fadda12595afa60fecfb8df696a51aad2da27814a9fbe3d05faefa23c88210f103603a0d3c29b88b53
7
- data.tar.gz: e3a4de2117e6901ba6d70ccaa884d3d5af7caeac8812b278fac32735628391736284df60282aa0737eb3f0873a4451652041ba3f2b86986bcc1414b621553710
6
+ metadata.gz: e1cf3a6043b7a57511b5fa3bad08510be29a0fbddb8b903a9aa7da3d0c9c3e18cb5fcf702459c557b8b2d5c0d5749635fa546d64bec0a1d1a01b4ad3bd3940f7
7
+ data.tar.gz: 7e04aab84e9d7f229eb5b6272875b27677344cb37ad492669b474b74adceaa6719a94b4157ecb4874604df7ab5eb11f2aa0e0f2e39859db31bf2a3cc48fe3728
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-retail_v2
2
2
 
3
+ ### v0.103.0 (2024-10-13)
4
+
5
+ * Regenerated from discovery document revision 20241003
6
+
7
+ ### v0.102.0 (2024-09-29)
8
+
9
+ * Regenerated from discovery document revision 20240920
10
+
3
11
  ### v0.101.0 (2024-09-22)
4
12
 
5
13
  * Regenerated from discovery document revision 20240912
@@ -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
@@ -3237,10 +3387,9 @@ module Google
3237
3387
  # attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION,
3238
3388
  # the following fields are always returned in SearchResponse by default: * name
3239
3389
  # For Type.VARIANT, the following fields are always returned in by default: *
3240
- # name * color_info The maximum number of paths is 30. Otherwise, an
3241
- # INVALID_ARGUMENT error is returned. Note: Returning more fields in
3242
- # SearchResponse can increase response payload size and serving latency. This
3243
- # field is deprecated. Use the retrievable site-wide control instead.
3390
+ # name * color_info Note: Returning more fields in SearchResponse can increase
3391
+ # response payload size and serving latency. This field is deprecated. Use the
3392
+ # retrievable site-wide control instead.
3244
3393
  # Corresponds to the JSON property `retrievableFields`
3245
3394
  # @return [String]
3246
3395
  attr_accessor :retrievable_fields
@@ -6062,6 +6211,33 @@ module Google
6062
6211
  end
6063
6212
  end
6064
6213
 
6214
+ # Request for UpdateGenerativeQuestionConfig method.
6215
+ class GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest
6216
+ include Google::Apis::Core::Hashable
6217
+
6218
+ # Configuration for a single generated question.
6219
+ # Corresponds to the JSON property `generativeQuestionConfig`
6220
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig]
6221
+ attr_accessor :generative_question_config
6222
+
6223
+ # Optional. Indicates which fields in the provided GenerativeQuestionConfig to
6224
+ # update. The following are NOT supported: * GenerativeQuestionConfig.frequency
6225
+ # If not set or empty, all supported fields are updated.
6226
+ # Corresponds to the JSON property `updateMask`
6227
+ # @return [String]
6228
+ attr_accessor :update_mask
6229
+
6230
+ def initialize(**args)
6231
+ update!(**args)
6232
+ end
6233
+
6234
+ # Update properties of this object
6235
+ def update!(**args)
6236
+ @generative_question_config = args[:generative_question_config] if args.key?(:generative_question_config)
6237
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
6238
+ end
6239
+ end
6240
+
6065
6241
  # UserEvent captures all metadata information Retail API needs to know about how
6066
6242
  # end users interact with customers' website.
6067
6243
  class GoogleCloudRetailV2UserEvent
@@ -7236,6 +7412,12 @@ module Google
7236
7412
  # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig]
7237
7413
  attr_accessor :frequently_bought_together_config
7238
7414
 
7415
+ # Config that turns on usage of llm embeddings as features to the model.
7416
+ # Embeddings leverage unstructured text fields like description and title.
7417
+ # Corresponds to the JSON property `llmEmbeddingConfig`
7418
+ # @return [Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig]
7419
+ attr_accessor :llm_embedding_config
7420
+
7239
7421
  def initialize(**args)
7240
7422
  update!(**args)
7241
7423
  end
@@ -7243,6 +7425,28 @@ module Google
7243
7425
  # Update properties of this object
7244
7426
  def update!(**args)
7245
7427
  @frequently_bought_together_config = args[:frequently_bought_together_config] if args.key?(:frequently_bought_together_config)
7428
+ @llm_embedding_config = args[:llm_embedding_config] if args.key?(:llm_embedding_config)
7429
+ end
7430
+ end
7431
+
7432
+ # Config that turns on usage of llm embeddings as features to the model.
7433
+ # Embeddings leverage unstructured text fields like description and title.
7434
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig
7435
+ include Google::Apis::Core::Hashable
7436
+
7437
+ # Optional. The LLM embedding version to use. Currently only `v0` is supported.
7438
+ # If not specified, feature will not be turned on.
7439
+ # Corresponds to the JSON property `llmEmbeddingVersion`
7440
+ # @return [String]
7441
+ attr_accessor :llm_embedding_version
7442
+
7443
+ def initialize(**args)
7444
+ update!(**args)
7445
+ end
7446
+
7447
+ # Update properties of this object
7448
+ def update!(**args)
7449
+ @llm_embedding_version = args[:llm_embedding_version] if args.key?(:llm_embedding_version)
7246
7450
  end
7247
7451
  end
7248
7452
 
@@ -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.101.0"
19
+ GEM_VERSION = "0.103.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 = "20240912"
25
+ REVISION = "20241003"
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
 
@@ -934,6 +964,12 @@ module Google
934
964
  include Google::Apis::Core::JsonObjectSupport
935
965
  end
936
966
 
967
+ class GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest
968
+ class Representation < Google::Apis::Core::JsonRepresentation; end
969
+
970
+ include Google::Apis::Core::JsonObjectSupport
971
+ end
972
+
937
973
  class GoogleCloudRetailV2UserEvent
938
974
  class Representation < Google::Apis::Core::JsonRepresentation; end
939
975
 
@@ -1114,6 +1150,12 @@ module Google
1114
1150
  include Google::Apis::Core::JsonObjectSupport
1115
1151
  end
1116
1152
 
1153
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig
1154
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1155
+
1156
+ include Google::Apis::Core::JsonObjectSupport
1157
+ end
1158
+
1117
1159
  class GoogleCloudRetailV2alphaModelPageOptimizationConfig
1118
1160
  class Representation < Google::Apis::Core::JsonRepresentation; end
1119
1161
 
@@ -1639,6 +1681,22 @@ module Google
1639
1681
  end
1640
1682
  end
1641
1683
 
1684
+ class GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest
1685
+ # @private
1686
+ class Representation < Google::Apis::Core::JsonRepresentation
1687
+ collection :requests, as: 'requests', class: Google::Apis::RetailV2::GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest::Representation
1688
+
1689
+ end
1690
+ end
1691
+
1692
+ class GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse
1693
+ # @private
1694
+ class Representation < Google::Apis::Core::JsonRepresentation
1695
+ collection :generative_question_configs, as: 'generativeQuestionConfigs', class: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig::Representation
1696
+
1697
+ end
1698
+ end
1699
+
1642
1700
  class GoogleCloudRetailV2BigQueryOutputResult
1643
1701
  # @private
1644
1702
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1948,6 +2006,28 @@ module Google
1948
2006
  end
1949
2007
  end
1950
2008
 
2009
+ class GoogleCloudRetailV2GenerativeQuestionConfig
2010
+ # @private
2011
+ class Representation < Google::Apis::Core::JsonRepresentation
2012
+ property :allowed_in_conversation, as: 'allowedInConversation'
2013
+ property :catalog, as: 'catalog'
2014
+ collection :example_values, as: 'exampleValues'
2015
+ property :facet, as: 'facet'
2016
+ property :final_question, as: 'finalQuestion'
2017
+ property :frequency, as: 'frequency'
2018
+ property :generated_question, as: 'generatedQuestion'
2019
+ end
2020
+ end
2021
+
2022
+ class GoogleCloudRetailV2GenerativeQuestionsFeatureConfig
2023
+ # @private
2024
+ class Representation < Google::Apis::Core::JsonRepresentation
2025
+ property :catalog, as: 'catalog'
2026
+ property :feature_enabled, as: 'featureEnabled'
2027
+ property :minimum_products, as: 'minimumProducts'
2028
+ end
2029
+ end
2030
+
1951
2031
  class GoogleCloudRetailV2GetDefaultBranchResponse
1952
2032
  # @private
1953
2033
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2076,6 +2156,14 @@ module Google
2076
2156
  end
2077
2157
  end
2078
2158
 
2159
+ class GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse
2160
+ # @private
2161
+ class Representation < Google::Apis::Core::JsonRepresentation
2162
+ collection :generative_question_configs, as: 'generativeQuestionConfigs', class: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig::Representation
2163
+
2164
+ end
2165
+ end
2166
+
2079
2167
  class GoogleCloudRetailV2ListModelsResponse
2080
2168
  # @private
2081
2169
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2990,6 +3078,15 @@ module Google
2990
3078
  end
2991
3079
  end
2992
3080
 
3081
+ class GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest
3082
+ # @private
3083
+ class Representation < Google::Apis::Core::JsonRepresentation
3084
+ property :generative_question_config, as: 'generativeQuestionConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2GenerativeQuestionConfig::Representation
3085
+
3086
+ property :update_mask, as: 'updateMask'
3087
+ end
3088
+ end
3089
+
2993
3090
  class GoogleCloudRetailV2UserEvent
2994
3091
  # @private
2995
3092
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3291,6 +3388,15 @@ module Google
3291
3388
  class Representation < Google::Apis::Core::JsonRepresentation
3292
3389
  property :frequently_bought_together_config, as: 'frequentlyBoughtTogetherConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig::Representation
3293
3390
 
3391
+ property :llm_embedding_config, as: 'llmEmbeddingConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig::Representation
3392
+
3393
+ end
3394
+ end
3395
+
3396
+ class GoogleCloudRetailV2alphaModelModelFeaturesConfigLlmEmbeddingConfig
3397
+ # @private
3398
+ class Representation < Google::Apis::Core::JsonRepresentation
3399
+ property :llm_embedding_version, as: 'llmEmbeddingVersion'
3294
3400
  end
3295
3401
  end
3296
3402
 
@@ -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.101.0
4
+ version: 0.103.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-22 00:00:00.000000000 Z
11
+ date: 2024-10-13 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.101.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.103.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: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.5.6
78
+ rubygems_version: 3.5.21
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Vertex AI Search for Retail API V2