google-apis-retail_v2 0.117.0 → 0.118.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:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a36e4210d95b72910e626858d39941ba285f66ae86e1c5c9b3dfcbbc46d07ee5
|
4
|
+
data.tar.gz: dc45e2e42df222e86abc4bf01c0c5c16f56ec2b8bfc304039c759df8fb059823
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 19b644583972b6087ac40f84309562deaf9abd26f41f63cedd7a28f0cd4077e41019b9ba64f43d5a55ffbd76674f60f0587f92e086a3b3ff4a05daa4f74df1eb
|
7
|
+
data.tar.gz: ac39f51fa59a4ae291bcbdab4ff71b13317425572422e0cccbe6175a92769b851baff897805d2250011133142b38f278a68c680d78b248536701733af7e99e89
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,10 @@
|
|
1
1
|
# Release history for google-apis-retail_v2
|
2
2
|
|
3
|
+
### v0.118.0 (2025-06-22)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20250613
|
6
|
+
* Regenerated using generator version 0.18.0
|
7
|
+
|
3
8
|
### v0.117.0 (2025-05-21)
|
4
9
|
|
5
10
|
* Regenerated from discovery document revision 20250515
|
@@ -1552,6 +1552,41 @@ module Google
|
|
1552
1552
|
end
|
1553
1553
|
end
|
1554
1554
|
|
1555
|
+
# The public proto to represent the conversational search customization config.
|
1556
|
+
# It will be converted to the internal proto in the backend.
|
1557
|
+
class GoogleCloudRetailV2ConversationalSearchCustomizationConfig
|
1558
|
+
include Google::Apis::Core::Hashable
|
1559
|
+
|
1560
|
+
# Required. Resource name of the catalog. Format: projects/`project`/locations/`
|
1561
|
+
# location`/catalogs/`catalog`
|
1562
|
+
# Corresponds to the JSON property `catalog`
|
1563
|
+
# @return [String]
|
1564
|
+
attr_accessor :catalog
|
1565
|
+
|
1566
|
+
# The public proto to represent the intent classification config. It will be
|
1567
|
+
# converted to the internal proto in the backend.
|
1568
|
+
# Corresponds to the JSON property `intentClassificationConfig`
|
1569
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfig]
|
1570
|
+
attr_accessor :intent_classification_config
|
1571
|
+
|
1572
|
+
# Optional. The retailer's display name that could be used in our LLM answers.
|
1573
|
+
# Example - "Google"
|
1574
|
+
# Corresponds to the JSON property `retailerDisplayName`
|
1575
|
+
# @return [String]
|
1576
|
+
attr_accessor :retailer_display_name
|
1577
|
+
|
1578
|
+
def initialize(**args)
|
1579
|
+
update!(**args)
|
1580
|
+
end
|
1581
|
+
|
1582
|
+
# Update properties of this object
|
1583
|
+
def update!(**args)
|
1584
|
+
@catalog = args[:catalog] if args.key?(:catalog)
|
1585
|
+
@intent_classification_config = args[:intent_classification_config] if args.key?(:intent_classification_config)
|
1586
|
+
@retailer_display_name = args[:retailer_display_name] if args.key?(:retailer_display_name)
|
1587
|
+
end
|
1588
|
+
end
|
1589
|
+
|
1555
1590
|
# Metadata associated with a create operation.
|
1556
1591
|
class GoogleCloudRetailV2CreateModelMetadata
|
1557
1592
|
include Google::Apis::Core::Hashable
|
@@ -2351,6 +2386,84 @@ module Google
|
|
2351
2386
|
end
|
2352
2387
|
end
|
2353
2388
|
|
2389
|
+
# The public proto to represent the intent classification config. It will be
|
2390
|
+
# converted to the internal proto in the backend.
|
2391
|
+
class GoogleCloudRetailV2IntentClassificationConfig
|
2392
|
+
include Google::Apis::Core::Hashable
|
2393
|
+
|
2394
|
+
# Optional. A list of keywords that will be used to classify the query to the "
|
2395
|
+
# BLOCKLISTED" intent type. The keywords are case insensitive.
|
2396
|
+
# Corresponds to the JSON property `blocklistKeywords`
|
2397
|
+
# @return [Array<String>]
|
2398
|
+
attr_accessor :blocklist_keywords
|
2399
|
+
|
2400
|
+
# Optional. A list of intent types that will be disabled for this customer. The
|
2401
|
+
# intent types must match one of the predefined intent types defined at https://
|
2402
|
+
# cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#
|
2403
|
+
# querytype
|
2404
|
+
# Corresponds to the JSON property `disabledIntentTypes`
|
2405
|
+
# @return [Array<String>]
|
2406
|
+
attr_accessor :disabled_intent_types
|
2407
|
+
|
2408
|
+
# Optional. A list of examples for intent classification.
|
2409
|
+
# Corresponds to the JSON property `example`
|
2410
|
+
# @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfigExample>]
|
2411
|
+
attr_accessor :example
|
2412
|
+
|
2413
|
+
# Optional. Customers can use the preamble to specify any requirements for
|
2414
|
+
# blocklisting intent classification. This preamble will be added to the
|
2415
|
+
# blocklisting intent classification model prompt.
|
2416
|
+
# Corresponds to the JSON property `modelPreamble`
|
2417
|
+
# @return [String]
|
2418
|
+
attr_accessor :model_preamble
|
2419
|
+
|
2420
|
+
def initialize(**args)
|
2421
|
+
update!(**args)
|
2422
|
+
end
|
2423
|
+
|
2424
|
+
# Update properties of this object
|
2425
|
+
def update!(**args)
|
2426
|
+
@blocklist_keywords = args[:blocklist_keywords] if args.key?(:blocklist_keywords)
|
2427
|
+
@disabled_intent_types = args[:disabled_intent_types] if args.key?(:disabled_intent_types)
|
2428
|
+
@example = args[:example] if args.key?(:example)
|
2429
|
+
@model_preamble = args[:model_preamble] if args.key?(:model_preamble)
|
2430
|
+
end
|
2431
|
+
end
|
2432
|
+
|
2433
|
+
# An example for intent classification.
|
2434
|
+
class GoogleCloudRetailV2IntentClassificationConfigExample
|
2435
|
+
include Google::Apis::Core::Hashable
|
2436
|
+
|
2437
|
+
# Optional. The intent_type must match one of the predefined intent types
|
2438
|
+
# defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.
|
2439
|
+
# retail.v2alpha#querytype
|
2440
|
+
# Corresponds to the JSON property `intentType`
|
2441
|
+
# @return [String]
|
2442
|
+
attr_accessor :intent_type
|
2443
|
+
|
2444
|
+
# Required. Example query.
|
2445
|
+
# Corresponds to the JSON property `query`
|
2446
|
+
# @return [String]
|
2447
|
+
attr_accessor :query
|
2448
|
+
|
2449
|
+
# Optional. The reason for the intent classification. This is used to explain
|
2450
|
+
# the intent classification decision.
|
2451
|
+
# Corresponds to the JSON property `reason`
|
2452
|
+
# @return [String]
|
2453
|
+
attr_accessor :reason
|
2454
|
+
|
2455
|
+
def initialize(**args)
|
2456
|
+
update!(**args)
|
2457
|
+
end
|
2458
|
+
|
2459
|
+
# Update properties of this object
|
2460
|
+
def update!(**args)
|
2461
|
+
@intent_type = args[:intent_type] if args.key?(:intent_type)
|
2462
|
+
@query = args[:query] if args.key?(:query)
|
2463
|
+
@reason = args[:reason] if args.key?(:reason)
|
2464
|
+
end
|
2465
|
+
end
|
2466
|
+
|
2354
2467
|
# A floating point interval.
|
2355
2468
|
class GoogleCloudRetailV2Interval
|
2356
2469
|
include Google::Apis::Core::Hashable
|
@@ -5547,9 +5660,9 @@ module Google
|
|
5547
5660
|
# @return [String]
|
5548
5661
|
attr_accessor :condition
|
5549
5662
|
|
5550
|
-
# Whether to pin unexpanded results.
|
5551
|
-
# products are always at the top of the search
|
5552
|
-
# results.
|
5663
|
+
# Whether to pin unexpanded results. The default value is false. If this field
|
5664
|
+
# is set to true, unexpanded products are always at the top of the search
|
5665
|
+
# results, followed by the expanded results.
|
5553
5666
|
# Corresponds to the JSON property `pinUnexpandedResults`
|
5554
5667
|
# @return [Boolean]
|
5555
5668
|
attr_accessor :pin_unexpanded_results
|
@@ -6626,9 +6739,9 @@ module Google
|
|
6626
6739
|
|
6627
6740
|
# A unique identifier for tracking a visitor session with a length limit of 128
|
6628
6741
|
# bytes. A session is an aggregation of an end user behavior in a time span. A
|
6629
|
-
# general guideline to populate the
|
6630
|
-
# min, a new session_id should be assigned. 2. The session_id should be
|
6631
|
-
# across users, suggest use uuid or add visitor_id as prefix.
|
6742
|
+
# general guideline to populate the session_id: 1. If user has no activity for
|
6743
|
+
# 30 min, a new session_id should be assigned. 2. The session_id should be
|
6744
|
+
# unique across users, suggest use uuid or add visitor_id as prefix.
|
6632
6745
|
# Corresponds to the JSON property `sessionId`
|
6633
6746
|
# @return [String]
|
6634
6747
|
attr_accessor :session_id
|
@@ -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.
|
19
|
+
GEM_VERSION = "0.118.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.18.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20250613"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -268,6 +268,12 @@ module Google
|
|
268
268
|
include Google::Apis::Core::JsonObjectSupport
|
269
269
|
end
|
270
270
|
|
271
|
+
class GoogleCloudRetailV2ConversationalSearchCustomizationConfig
|
272
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
273
|
+
|
274
|
+
include Google::Apis::Core::JsonObjectSupport
|
275
|
+
end
|
276
|
+
|
271
277
|
class GoogleCloudRetailV2CreateModelMetadata
|
272
278
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
273
279
|
|
@@ -412,6 +418,18 @@ module Google
|
|
412
418
|
include Google::Apis::Core::JsonObjectSupport
|
413
419
|
end
|
414
420
|
|
421
|
+
class GoogleCloudRetailV2IntentClassificationConfig
|
422
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
423
|
+
|
424
|
+
include Google::Apis::Core::JsonObjectSupport
|
425
|
+
end
|
426
|
+
|
427
|
+
class GoogleCloudRetailV2IntentClassificationConfigExample
|
428
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
429
|
+
|
430
|
+
include Google::Apis::Core::JsonObjectSupport
|
431
|
+
end
|
432
|
+
|
415
433
|
class GoogleCloudRetailV2Interval
|
416
434
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
417
435
|
|
@@ -1948,6 +1966,16 @@ module Google
|
|
1948
1966
|
end
|
1949
1967
|
end
|
1950
1968
|
|
1969
|
+
class GoogleCloudRetailV2ConversationalSearchCustomizationConfig
|
1970
|
+
# @private
|
1971
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1972
|
+
property :catalog, as: 'catalog'
|
1973
|
+
property :intent_classification_config, as: 'intentClassificationConfig', class: Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfig, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfig::Representation
|
1974
|
+
|
1975
|
+
property :retailer_display_name, as: 'retailerDisplayName'
|
1976
|
+
end
|
1977
|
+
end
|
1978
|
+
|
1951
1979
|
class GoogleCloudRetailV2CreateModelMetadata
|
1952
1980
|
# @private
|
1953
1981
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2170,6 +2198,26 @@ module Google
|
|
2170
2198
|
end
|
2171
2199
|
end
|
2172
2200
|
|
2201
|
+
class GoogleCloudRetailV2IntentClassificationConfig
|
2202
|
+
# @private
|
2203
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2204
|
+
collection :blocklist_keywords, as: 'blocklistKeywords'
|
2205
|
+
collection :disabled_intent_types, as: 'disabledIntentTypes'
|
2206
|
+
collection :example, as: 'example', class: Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfigExample, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2IntentClassificationConfigExample::Representation
|
2207
|
+
|
2208
|
+
property :model_preamble, as: 'modelPreamble'
|
2209
|
+
end
|
2210
|
+
end
|
2211
|
+
|
2212
|
+
class GoogleCloudRetailV2IntentClassificationConfigExample
|
2213
|
+
# @private
|
2214
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2215
|
+
property :intent_type, as: 'intentType'
|
2216
|
+
property :query, as: 'query'
|
2217
|
+
property :reason, as: 'reason'
|
2218
|
+
end
|
2219
|
+
end
|
2220
|
+
|
2173
2221
|
class GoogleCloudRetailV2Interval
|
2174
2222
|
# @private
|
2175
2223
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -242,6 +242,37 @@ module Google
|
|
242
242
|
execute_or_queue_command(command, &block)
|
243
243
|
end
|
244
244
|
|
245
|
+
# Returns the conversational search customization config for a given catalog.
|
246
|
+
# @param [String] name
|
247
|
+
# Required. Resource name of the parent catalog. Format: projects/`project`/
|
248
|
+
# locations/`location`/catalogs/`catalog`
|
249
|
+
# @param [String] fields
|
250
|
+
# Selector specifying which fields to include in a partial response.
|
251
|
+
# @param [String] quota_user
|
252
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
253
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
254
|
+
# @param [Google::Apis::RequestOptions] options
|
255
|
+
# Request-specific options
|
256
|
+
#
|
257
|
+
# @yield [result, err] Result & error if block supplied
|
258
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig] parsed result object
|
259
|
+
# @yieldparam err [StandardError] error object if request failed
|
260
|
+
#
|
261
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig]
|
262
|
+
#
|
263
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
264
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
265
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
266
|
+
def get_project_location_catalog_conversational_search_customization_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
267
|
+
command = make_simple_command(:get, 'v2/{+name}/conversationalSearchCustomizationConfig', options)
|
268
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig::Representation
|
269
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig
|
270
|
+
command.params['name'] = name unless name.nil?
|
271
|
+
command.query['fields'] = fields unless fields.nil?
|
272
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
273
|
+
execute_or_queue_command(command, &block)
|
274
|
+
end
|
275
|
+
|
245
276
|
# Get which branch is currently default branch set by CatalogService.
|
246
277
|
# SetDefaultBranch method under a specified parent catalog.
|
247
278
|
# @param [String] catalog
|
@@ -523,6 +554,45 @@ module Google
|
|
523
554
|
execute_or_queue_command(command, &block)
|
524
555
|
end
|
525
556
|
|
557
|
+
# Updates the conversational search customization config for a given catalog.
|
558
|
+
# @param [String] catalog
|
559
|
+
# Required. Resource name of the catalog. Format: projects/`project`/locations/`
|
560
|
+
# location`/catalogs/`catalog`
|
561
|
+
# @param [Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig] google_cloud_retail_v2_conversational_search_customization_config_object
|
562
|
+
# @param [String] update_mask
|
563
|
+
# Optional. Indicates which fields in the provided
|
564
|
+
# ConversationalSearchCustomizationConfig to update. If not set or empty, all
|
565
|
+
# supported fields are updated.
|
566
|
+
# @param [String] fields
|
567
|
+
# Selector specifying which fields to include in a partial response.
|
568
|
+
# @param [String] quota_user
|
569
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
570
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
571
|
+
# @param [Google::Apis::RequestOptions] options
|
572
|
+
# Request-specific options
|
573
|
+
#
|
574
|
+
# @yield [result, err] Result & error if block supplied
|
575
|
+
# @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig] parsed result object
|
576
|
+
# @yieldparam err [StandardError] error object if request failed
|
577
|
+
#
|
578
|
+
# @return [Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig]
|
579
|
+
#
|
580
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
581
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
582
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
583
|
+
def update_project_location_catalog_conversational_search_customization_config(catalog, google_cloud_retail_v2_conversational_search_customization_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
584
|
+
command = make_simple_command(:patch, 'v2/{+catalog}/conversationalSearchCustomizationConfig', options)
|
585
|
+
command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig::Representation
|
586
|
+
command.request_object = google_cloud_retail_v2_conversational_search_customization_config_object
|
587
|
+
command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig::Representation
|
588
|
+
command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ConversationalSearchCustomizationConfig
|
589
|
+
command.params['catalog'] = catalog unless catalog.nil?
|
590
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
591
|
+
command.query['fields'] = fields unless fields.nil?
|
592
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
593
|
+
execute_or_queue_command(command, &block)
|
594
|
+
end
|
595
|
+
|
526
596
|
# Allows management of individual questions.
|
527
597
|
# @param [String] catalog
|
528
598
|
# Required. Resource name of the catalog. Format: projects/`project`/locations/`
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-retail_v2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.118.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
@@ -57,7 +57,7 @@ licenses:
|
|
57
57
|
metadata:
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.118.0
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
|
62
62
|
rdoc_options: []
|
63
63
|
require_paths:
|