google-apis-retail_v2beta 0.112.0 → 0.113.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: 9c7d063d0dadbec95172a154eb3dac12de1c36e04083617fd51f6fe988f3b8bc
|
4
|
+
data.tar.gz: ac919c2e1785560d10841c5e57e484d4f986eae0a6de434195c040d1ede8910c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5aafdb4ee75bd9ee71f27e059b68f3339c5c6ff502205a13082fba90a32981096b6884256ff072e3c3147630e2cb3497ad3e6dd5d3d4367e31bff8ac1d5ab247
|
7
|
+
data.tar.gz: 629fe238246d8ef0d45e8d4d7424e188436511c84f852f87b49ebec0473da142f68fff580425c0db66e86d63c4ed6b5af369f6cf647745aa7657518b3ad977ea
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,10 @@
|
|
1
1
|
# Release history for google-apis-retail_v2beta
|
2
2
|
|
3
|
+
### v0.113.0 (2025-06-22)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20250613
|
6
|
+
* Regenerated using generator version 0.18.0
|
7
|
+
|
3
8
|
### v0.112.0 (2025-05-21)
|
4
9
|
|
5
10
|
* Regenerated from discovery document revision 20250515
|
@@ -3856,6 +3856,41 @@ module Google
|
|
3856
3856
|
end
|
3857
3857
|
end
|
3858
3858
|
|
3859
|
+
# The public proto to represent the conversational search customization config.
|
3860
|
+
# It will be converted to the internal proto in the backend.
|
3861
|
+
class GoogleCloudRetailV2betaConversationalSearchCustomizationConfig
|
3862
|
+
include Google::Apis::Core::Hashable
|
3863
|
+
|
3864
|
+
# Required. Resource name of the catalog. Format: projects/`project`/locations/`
|
3865
|
+
# location`/catalogs/`catalog`
|
3866
|
+
# Corresponds to the JSON property `catalog`
|
3867
|
+
# @return [String]
|
3868
|
+
attr_accessor :catalog
|
3869
|
+
|
3870
|
+
# The public proto to represent the intent classification config. It will be
|
3871
|
+
# converted to the internal proto in the backend.
|
3872
|
+
# Corresponds to the JSON property `intentClassificationConfig`
|
3873
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaIntentClassificationConfig]
|
3874
|
+
attr_accessor :intent_classification_config
|
3875
|
+
|
3876
|
+
# Optional. The retailer's display name that could be used in our LLM answers.
|
3877
|
+
# Example - "Google"
|
3878
|
+
# Corresponds to the JSON property `retailerDisplayName`
|
3879
|
+
# @return [String]
|
3880
|
+
attr_accessor :retailer_display_name
|
3881
|
+
|
3882
|
+
def initialize(**args)
|
3883
|
+
update!(**args)
|
3884
|
+
end
|
3885
|
+
|
3886
|
+
# Update properties of this object
|
3887
|
+
def update!(**args)
|
3888
|
+
@catalog = args[:catalog] if args.key?(:catalog)
|
3889
|
+
@intent_classification_config = args[:intent_classification_config] if args.key?(:intent_classification_config)
|
3890
|
+
@retailer_display_name = args[:retailer_display_name] if args.key?(:retailer_display_name)
|
3891
|
+
end
|
3892
|
+
end
|
3893
|
+
|
3859
3894
|
# Metadata associated with a create operation.
|
3860
3895
|
class GoogleCloudRetailV2betaCreateModelMetadata
|
3861
3896
|
include Google::Apis::Core::Hashable
|
@@ -4820,6 +4855,84 @@ module Google
|
|
4820
4855
|
end
|
4821
4856
|
end
|
4822
4857
|
|
4858
|
+
# The public proto to represent the intent classification config. It will be
|
4859
|
+
# converted to the internal proto in the backend.
|
4860
|
+
class GoogleCloudRetailV2betaIntentClassificationConfig
|
4861
|
+
include Google::Apis::Core::Hashable
|
4862
|
+
|
4863
|
+
# Optional. A list of keywords that will be used to classify the query to the "
|
4864
|
+
# BLOCKLISTED" intent type. The keywords are case insensitive.
|
4865
|
+
# Corresponds to the JSON property `blocklistKeywords`
|
4866
|
+
# @return [Array<String>]
|
4867
|
+
attr_accessor :blocklist_keywords
|
4868
|
+
|
4869
|
+
# Optional. A list of intent types that will be disabled for this customer. The
|
4870
|
+
# intent types must match one of the predefined intent types defined at https://
|
4871
|
+
# cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#
|
4872
|
+
# querytype
|
4873
|
+
# Corresponds to the JSON property `disabledIntentTypes`
|
4874
|
+
# @return [Array<String>]
|
4875
|
+
attr_accessor :disabled_intent_types
|
4876
|
+
|
4877
|
+
# Optional. A list of examples for intent classification.
|
4878
|
+
# Corresponds to the JSON property `example`
|
4879
|
+
# @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaIntentClassificationConfigExample>]
|
4880
|
+
attr_accessor :example
|
4881
|
+
|
4882
|
+
# Optional. Customers can use the preamble to specify any requirements for
|
4883
|
+
# blocklisting intent classification. This preamble will be added to the
|
4884
|
+
# blocklisting intent classification model prompt.
|
4885
|
+
# Corresponds to the JSON property `modelPreamble`
|
4886
|
+
# @return [String]
|
4887
|
+
attr_accessor :model_preamble
|
4888
|
+
|
4889
|
+
def initialize(**args)
|
4890
|
+
update!(**args)
|
4891
|
+
end
|
4892
|
+
|
4893
|
+
# Update properties of this object
|
4894
|
+
def update!(**args)
|
4895
|
+
@blocklist_keywords = args[:blocklist_keywords] if args.key?(:blocklist_keywords)
|
4896
|
+
@disabled_intent_types = args[:disabled_intent_types] if args.key?(:disabled_intent_types)
|
4897
|
+
@example = args[:example] if args.key?(:example)
|
4898
|
+
@model_preamble = args[:model_preamble] if args.key?(:model_preamble)
|
4899
|
+
end
|
4900
|
+
end
|
4901
|
+
|
4902
|
+
# An example for intent classification.
|
4903
|
+
class GoogleCloudRetailV2betaIntentClassificationConfigExample
|
4904
|
+
include Google::Apis::Core::Hashable
|
4905
|
+
|
4906
|
+
# Optional. The intent_type must match one of the predefined intent types
|
4907
|
+
# defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.
|
4908
|
+
# retail.v2alpha#querytype
|
4909
|
+
# Corresponds to the JSON property `intentType`
|
4910
|
+
# @return [String]
|
4911
|
+
attr_accessor :intent_type
|
4912
|
+
|
4913
|
+
# Required. Example query.
|
4914
|
+
# Corresponds to the JSON property `query`
|
4915
|
+
# @return [String]
|
4916
|
+
attr_accessor :query
|
4917
|
+
|
4918
|
+
# Optional. The reason for the intent classification. This is used to explain
|
4919
|
+
# the intent classification decision.
|
4920
|
+
# Corresponds to the JSON property `reason`
|
4921
|
+
# @return [String]
|
4922
|
+
attr_accessor :reason
|
4923
|
+
|
4924
|
+
def initialize(**args)
|
4925
|
+
update!(**args)
|
4926
|
+
end
|
4927
|
+
|
4928
|
+
# Update properties of this object
|
4929
|
+
def update!(**args)
|
4930
|
+
@intent_type = args[:intent_type] if args.key?(:intent_type)
|
4931
|
+
@query = args[:query] if args.key?(:query)
|
4932
|
+
@reason = args[:reason] if args.key?(:reason)
|
4933
|
+
end
|
4934
|
+
end
|
4935
|
+
|
4823
4936
|
# A floating point interval.
|
4824
4937
|
class GoogleCloudRetailV2betaInterval
|
4825
4938
|
include Google::Apis::Core::Hashable
|
@@ -8138,9 +8251,9 @@ module Google
|
|
8138
8251
|
# @return [String]
|
8139
8252
|
attr_accessor :condition
|
8140
8253
|
|
8141
|
-
# Whether to pin unexpanded results.
|
8142
|
-
# products are always at the top of the search
|
8143
|
-
# results.
|
8254
|
+
# Whether to pin unexpanded results. The default value is false. If this field
|
8255
|
+
# is set to true, unexpanded products are always at the top of the search
|
8256
|
+
# results, followed by the expanded results.
|
8144
8257
|
# Corresponds to the JSON property `pinUnexpandedResults`
|
8145
8258
|
# @return [Boolean]
|
8146
8259
|
attr_accessor :pin_unexpanded_results
|
@@ -9217,9 +9330,9 @@ module Google
|
|
9217
9330
|
|
9218
9331
|
# A unique identifier for tracking a visitor session with a length limit of 128
|
9219
9332
|
# bytes. A session is an aggregation of an end user behavior in a time span. A
|
9220
|
-
# general guideline to populate the
|
9221
|
-
# min, a new session_id should be assigned. 2. The session_id should be
|
9222
|
-
# across users, suggest use uuid or add visitor_id as prefix.
|
9333
|
+
# general guideline to populate the session_id: 1. If user has no activity for
|
9334
|
+
# 30 min, a new session_id should be assigned. 2. The session_id should be
|
9335
|
+
# unique across users, suggest use uuid or add visitor_id as prefix.
|
9223
9336
|
# Corresponds to the JSON property `sessionId`
|
9224
9337
|
# @return [String]
|
9225
9338
|
attr_accessor :session_id
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module RetailV2beta
|
18
18
|
# Version of the google-apis-retail_v2beta gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.113.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
|
@@ -784,6 +784,12 @@ module Google
|
|
784
784
|
include Google::Apis::Core::JsonObjectSupport
|
785
785
|
end
|
786
786
|
|
787
|
+
class GoogleCloudRetailV2betaConversationalSearchCustomizationConfig
|
788
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
789
|
+
|
790
|
+
include Google::Apis::Core::JsonObjectSupport
|
791
|
+
end
|
792
|
+
|
787
793
|
class GoogleCloudRetailV2betaCreateModelMetadata
|
788
794
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
789
795
|
|
@@ -952,6 +958,18 @@ module Google
|
|
952
958
|
include Google::Apis::Core::JsonObjectSupport
|
953
959
|
end
|
954
960
|
|
961
|
+
class GoogleCloudRetailV2betaIntentClassificationConfig
|
962
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
963
|
+
|
964
|
+
include Google::Apis::Core::JsonObjectSupport
|
965
|
+
end
|
966
|
+
|
967
|
+
class GoogleCloudRetailV2betaIntentClassificationConfigExample
|
968
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
969
|
+
|
970
|
+
include Google::Apis::Core::JsonObjectSupport
|
971
|
+
end
|
972
|
+
|
955
973
|
class GoogleCloudRetailV2betaInterval
|
956
974
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
957
975
|
|
@@ -2721,6 +2739,16 @@ module Google
|
|
2721
2739
|
end
|
2722
2740
|
end
|
2723
2741
|
|
2742
|
+
class GoogleCloudRetailV2betaConversationalSearchCustomizationConfig
|
2743
|
+
# @private
|
2744
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2745
|
+
property :catalog, as: 'catalog'
|
2746
|
+
property :intent_classification_config, as: 'intentClassificationConfig', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaIntentClassificationConfig, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaIntentClassificationConfig::Representation
|
2747
|
+
|
2748
|
+
property :retailer_display_name, as: 'retailerDisplayName'
|
2749
|
+
end
|
2750
|
+
end
|
2751
|
+
|
2724
2752
|
class GoogleCloudRetailV2betaCreateModelMetadata
|
2725
2753
|
# @private
|
2726
2754
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2985,6 +3013,26 @@ module Google
|
|
2985
3013
|
end
|
2986
3014
|
end
|
2987
3015
|
|
3016
|
+
class GoogleCloudRetailV2betaIntentClassificationConfig
|
3017
|
+
# @private
|
3018
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3019
|
+
collection :blocklist_keywords, as: 'blocklistKeywords'
|
3020
|
+
collection :disabled_intent_types, as: 'disabledIntentTypes'
|
3021
|
+
collection :example, as: 'example', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaIntentClassificationConfigExample, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaIntentClassificationConfigExample::Representation
|
3022
|
+
|
3023
|
+
property :model_preamble, as: 'modelPreamble'
|
3024
|
+
end
|
3025
|
+
end
|
3026
|
+
|
3027
|
+
class GoogleCloudRetailV2betaIntentClassificationConfigExample
|
3028
|
+
# @private
|
3029
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
3030
|
+
property :intent_type, as: 'intentType'
|
3031
|
+
property :query, as: 'query'
|
3032
|
+
property :reason, as: 'reason'
|
3033
|
+
end
|
3034
|
+
end
|
3035
|
+
|
2988
3036
|
class GoogleCloudRetailV2betaInterval
|
2989
3037
|
# @private
|
2990
3038
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -311,6 +311,37 @@ module Google
|
|
311
311
|
execute_or_queue_command(command, &block)
|
312
312
|
end
|
313
313
|
|
314
|
+
# Returns the conversational search customization config for a given catalog.
|
315
|
+
# @param [String] name
|
316
|
+
# Required. Resource name of the parent catalog. Format: projects/`project`/
|
317
|
+
# locations/`location`/catalogs/`catalog`
|
318
|
+
# @param [String] fields
|
319
|
+
# Selector specifying which fields to include in a partial response.
|
320
|
+
# @param [String] quota_user
|
321
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
322
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
323
|
+
# @param [Google::Apis::RequestOptions] options
|
324
|
+
# Request-specific options
|
325
|
+
#
|
326
|
+
# @yield [result, err] Result & error if block supplied
|
327
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchCustomizationConfig] parsed result object
|
328
|
+
# @yieldparam err [StandardError] error object if request failed
|
329
|
+
#
|
330
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchCustomizationConfig]
|
331
|
+
#
|
332
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
333
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
334
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
335
|
+
def get_project_location_catalog_conversational_search_customization_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
336
|
+
command = make_simple_command(:get, 'v2beta/{+name}/conversationalSearchCustomizationConfig', options)
|
337
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchCustomizationConfig::Representation
|
338
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchCustomizationConfig
|
339
|
+
command.params['name'] = name unless name.nil?
|
340
|
+
command.query['fields'] = fields unless fields.nil?
|
341
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
342
|
+
execute_or_queue_command(command, &block)
|
343
|
+
end
|
344
|
+
|
314
345
|
# Get which branch is currently default branch set by CatalogService.
|
315
346
|
# SetDefaultBranch method under a specified parent catalog.
|
316
347
|
# @param [String] catalog
|
@@ -592,6 +623,45 @@ module Google
|
|
592
623
|
execute_or_queue_command(command, &block)
|
593
624
|
end
|
594
625
|
|
626
|
+
# Updates the conversational search customization config for a given catalog.
|
627
|
+
# @param [String] catalog
|
628
|
+
# Required. Resource name of the catalog. Format: projects/`project`/locations/`
|
629
|
+
# location`/catalogs/`catalog`
|
630
|
+
# @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchCustomizationConfig] google_cloud_retail_v2beta_conversational_search_customization_config_object
|
631
|
+
# @param [String] update_mask
|
632
|
+
# Optional. Indicates which fields in the provided
|
633
|
+
# ConversationalSearchCustomizationConfig to update. If not set or empty, all
|
634
|
+
# supported fields are updated.
|
635
|
+
# @param [String] fields
|
636
|
+
# Selector specifying which fields to include in a partial response.
|
637
|
+
# @param [String] quota_user
|
638
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
639
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
640
|
+
# @param [Google::Apis::RequestOptions] options
|
641
|
+
# Request-specific options
|
642
|
+
#
|
643
|
+
# @yield [result, err] Result & error if block supplied
|
644
|
+
# @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchCustomizationConfig] parsed result object
|
645
|
+
# @yieldparam err [StandardError] error object if request failed
|
646
|
+
#
|
647
|
+
# @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchCustomizationConfig]
|
648
|
+
#
|
649
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
650
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
651
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
652
|
+
def update_project_location_catalog_conversational_search_customization_config(catalog, google_cloud_retail_v2beta_conversational_search_customization_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
653
|
+
command = make_simple_command(:patch, 'v2beta/{+catalog}/conversationalSearchCustomizationConfig', options)
|
654
|
+
command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchCustomizationConfig::Representation
|
655
|
+
command.request_object = google_cloud_retail_v2beta_conversational_search_customization_config_object
|
656
|
+
command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchCustomizationConfig::Representation
|
657
|
+
command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchCustomizationConfig
|
658
|
+
command.params['catalog'] = catalog unless catalog.nil?
|
659
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
660
|
+
command.query['fields'] = fields unless fields.nil?
|
661
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
662
|
+
execute_or_queue_command(command, &block)
|
663
|
+
end
|
664
|
+
|
595
665
|
# Allows management of individual questions.
|
596
666
|
# @param [String] catalog
|
597
667
|
# 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_v2beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.113.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_v2beta/CHANGELOG.md
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.113.0
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2beta
|
62
62
|
rdoc_options: []
|
63
63
|
require_paths:
|