google-apis-retail_v2alpha 0.119.0 → 0.120.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: 4a93bfcdc7774b692289d17ccb274cc767b3ed4fef041419436f0e1c148f24ac
|
4
|
+
data.tar.gz: 8467a1d7d95b7d8eff878c228f0461f2aec38245a0a63f9aba5eec547513debc
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1cf556182a7727e0312cd1b3aec54d6a1a7112b2e9ab3dfa41ce7ffb9c1bac70c4266a7ebcfb5b7adc1dd60448c739abfdeb2c75e3207c4c225a085f1f8c2bcd
|
7
|
+
data.tar.gz: 4ef68a0745cc199935d31245df6515ba159883054d3375539bdb548843c0269ac36dafa29fc29390c18f39d9c07195d975793533c412c96b133fc033f0596bab
|
data/CHANGELOG.md
CHANGED
@@ -2774,6 +2774,41 @@ module Google
|
|
2774
2774
|
end
|
2775
2775
|
end
|
2776
2776
|
|
2777
|
+
# The public proto to represent the conversational search customization config.
|
2778
|
+
# It will be converted to the internal proto in the backend.
|
2779
|
+
class GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig
|
2780
|
+
include Google::Apis::Core::Hashable
|
2781
|
+
|
2782
|
+
# Required. Resource name of the catalog. Format: projects/`project`/locations/`
|
2783
|
+
# location`/catalogs/`catalog`
|
2784
|
+
# Corresponds to the JSON property `catalog`
|
2785
|
+
# @return [String]
|
2786
|
+
attr_accessor :catalog
|
2787
|
+
|
2788
|
+
# The public proto to represent the intent classification config. It will be
|
2789
|
+
# converted to the internal proto in the backend.
|
2790
|
+
# Corresponds to the JSON property `intentClassificationConfig`
|
2791
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaIntentClassificationConfig]
|
2792
|
+
attr_accessor :intent_classification_config
|
2793
|
+
|
2794
|
+
# Optional. The retailer's display name that could be used in our LLM answers.
|
2795
|
+
# Example - "Google"
|
2796
|
+
# Corresponds to the JSON property `retailerDisplayName`
|
2797
|
+
# @return [String]
|
2798
|
+
attr_accessor :retailer_display_name
|
2799
|
+
|
2800
|
+
def initialize(**args)
|
2801
|
+
update!(**args)
|
2802
|
+
end
|
2803
|
+
|
2804
|
+
# Update properties of this object
|
2805
|
+
def update!(**args)
|
2806
|
+
@catalog = args[:catalog] if args.key?(:catalog)
|
2807
|
+
@intent_classification_config = args[:intent_classification_config] if args.key?(:intent_classification_config)
|
2808
|
+
@retailer_display_name = args[:retailer_display_name] if args.key?(:retailer_display_name)
|
2809
|
+
end
|
2810
|
+
end
|
2811
|
+
|
2777
2812
|
# Request message for ConversationalSearchService.ConversationalSearch method.
|
2778
2813
|
class GoogleCloudRetailV2alphaConversationalSearchRequest
|
2779
2814
|
include Google::Apis::Core::Hashable
|
@@ -4206,6 +4241,84 @@ module Google
|
|
4206
4241
|
end
|
4207
4242
|
end
|
4208
4243
|
|
4244
|
+
# The public proto to represent the intent classification config. It will be
|
4245
|
+
# converted to the internal proto in the backend.
|
4246
|
+
class GoogleCloudRetailV2alphaIntentClassificationConfig
|
4247
|
+
include Google::Apis::Core::Hashable
|
4248
|
+
|
4249
|
+
# Optional. A list of keywords that will be used to classify the query to the "
|
4250
|
+
# BLOCKLISTED" intent type. The keywords are case insensitive.
|
4251
|
+
# Corresponds to the JSON property `blocklistKeywords`
|
4252
|
+
# @return [Array<String>]
|
4253
|
+
attr_accessor :blocklist_keywords
|
4254
|
+
|
4255
|
+
# Optional. A list of intent types that will be disabled for this customer. The
|
4256
|
+
# intent types must match one of the predefined intent types defined at https://
|
4257
|
+
# cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#
|
4258
|
+
# querytype
|
4259
|
+
# Corresponds to the JSON property `disabledIntentTypes`
|
4260
|
+
# @return [Array<String>]
|
4261
|
+
attr_accessor :disabled_intent_types
|
4262
|
+
|
4263
|
+
# Optional. A list of examples for intent classification.
|
4264
|
+
# Corresponds to the JSON property `example`
|
4265
|
+
# @return [Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaIntentClassificationConfigExample>]
|
4266
|
+
attr_accessor :example
|
4267
|
+
|
4268
|
+
# Optional. Customers can use the preamble to specify any requirements for
|
4269
|
+
# blocklisting intent classification. This preamble will be added to the
|
4270
|
+
# blocklisting intent classification model prompt.
|
4271
|
+
# Corresponds to the JSON property `modelPreamble`
|
4272
|
+
# @return [String]
|
4273
|
+
attr_accessor :model_preamble
|
4274
|
+
|
4275
|
+
def initialize(**args)
|
4276
|
+
update!(**args)
|
4277
|
+
end
|
4278
|
+
|
4279
|
+
# Update properties of this object
|
4280
|
+
def update!(**args)
|
4281
|
+
@blocklist_keywords = args[:blocklist_keywords] if args.key?(:blocklist_keywords)
|
4282
|
+
@disabled_intent_types = args[:disabled_intent_types] if args.key?(:disabled_intent_types)
|
4283
|
+
@example = args[:example] if args.key?(:example)
|
4284
|
+
@model_preamble = args[:model_preamble] if args.key?(:model_preamble)
|
4285
|
+
end
|
4286
|
+
end
|
4287
|
+
|
4288
|
+
# An example for intent classification.
|
4289
|
+
class GoogleCloudRetailV2alphaIntentClassificationConfigExample
|
4290
|
+
include Google::Apis::Core::Hashable
|
4291
|
+
|
4292
|
+
# Optional. The intent_type must match one of the predefined intent types
|
4293
|
+
# defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.
|
4294
|
+
# retail.v2alpha#querytype
|
4295
|
+
# Corresponds to the JSON property `intentType`
|
4296
|
+
# @return [String]
|
4297
|
+
attr_accessor :intent_type
|
4298
|
+
|
4299
|
+
# Required. Example query.
|
4300
|
+
# Corresponds to the JSON property `query`
|
4301
|
+
# @return [String]
|
4302
|
+
attr_accessor :query
|
4303
|
+
|
4304
|
+
# Optional. The reason for the intent classification. This is used to explain
|
4305
|
+
# the intent classification decision.
|
4306
|
+
# Corresponds to the JSON property `reason`
|
4307
|
+
# @return [String]
|
4308
|
+
attr_accessor :reason
|
4309
|
+
|
4310
|
+
def initialize(**args)
|
4311
|
+
update!(**args)
|
4312
|
+
end
|
4313
|
+
|
4314
|
+
# Update properties of this object
|
4315
|
+
def update!(**args)
|
4316
|
+
@intent_type = args[:intent_type] if args.key?(:intent_type)
|
4317
|
+
@query = args[:query] if args.key?(:query)
|
4318
|
+
@reason = args[:reason] if args.key?(:reason)
|
4319
|
+
end
|
4320
|
+
end
|
4321
|
+
|
4209
4322
|
# A floating point interval.
|
4210
4323
|
class GoogleCloudRetailV2alphaInterval
|
4211
4324
|
include Google::Apis::Core::Hashable
|
@@ -7986,9 +8099,9 @@ module Google
|
|
7986
8099
|
# @return [String]
|
7987
8100
|
attr_accessor :condition
|
7988
8101
|
|
7989
|
-
# Whether to pin unexpanded results.
|
7990
|
-
# products are always at the top of the search
|
7991
|
-
# results.
|
8102
|
+
# Whether to pin unexpanded results. The default value is false. If this field
|
8103
|
+
# is set to true, unexpanded products are always at the top of the search
|
8104
|
+
# results, followed by the expanded results.
|
7992
8105
|
# Corresponds to the JSON property `pinUnexpandedResults`
|
7993
8106
|
# @return [Boolean]
|
7994
8107
|
attr_accessor :pin_unexpanded_results
|
@@ -9110,9 +9223,9 @@ module Google
|
|
9110
9223
|
|
9111
9224
|
# A unique identifier for tracking a visitor session with a length limit of 128
|
9112
9225
|
# bytes. A session is an aggregation of an end user behavior in a time span. A
|
9113
|
-
# general guideline to populate the
|
9114
|
-
# min, a new session_id should be assigned. 2. The session_id should be
|
9115
|
-
# across users, suggest use uuid or add visitor_id as prefix.
|
9226
|
+
# general guideline to populate the session_id: 1. If user has no activity for
|
9227
|
+
# 30 min, a new session_id should be assigned. 2. The session_id should be
|
9228
|
+
# unique across users, suggest use uuid or add visitor_id as prefix.
|
9116
9229
|
# Corresponds to the JSON property `sessionId`
|
9117
9230
|
# @return [String]
|
9118
9231
|
attr_accessor :session_id
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module RetailV2alpha
|
18
18
|
# Version of the google-apis-retail_v2alpha gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.120.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.18.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20250613"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -532,6 +532,12 @@ module Google
|
|
532
532
|
include Google::Apis::Core::JsonObjectSupport
|
533
533
|
end
|
534
534
|
|
535
|
+
class GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig
|
536
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
537
|
+
|
538
|
+
include Google::Apis::Core::JsonObjectSupport
|
539
|
+
end
|
540
|
+
|
535
541
|
class GoogleCloudRetailV2alphaConversationalSearchRequest
|
536
542
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
537
543
|
|
@@ -790,6 +796,18 @@ module Google
|
|
790
796
|
include Google::Apis::Core::JsonObjectSupport
|
791
797
|
end
|
792
798
|
|
799
|
+
class GoogleCloudRetailV2alphaIntentClassificationConfig
|
800
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
801
|
+
|
802
|
+
include Google::Apis::Core::JsonObjectSupport
|
803
|
+
end
|
804
|
+
|
805
|
+
class GoogleCloudRetailV2alphaIntentClassificationConfigExample
|
806
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
807
|
+
|
808
|
+
include Google::Apis::Core::JsonObjectSupport
|
809
|
+
end
|
810
|
+
|
793
811
|
class GoogleCloudRetailV2alphaInterval
|
794
812
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
795
813
|
|
@@ -2519,6 +2537,16 @@ module Google
|
|
2519
2537
|
end
|
2520
2538
|
end
|
2521
2539
|
|
2540
|
+
class GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig
|
2541
|
+
# @private
|
2542
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2543
|
+
property :catalog, as: 'catalog'
|
2544
|
+
property :intent_classification_config, as: 'intentClassificationConfig', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaIntentClassificationConfig, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaIntentClassificationConfig::Representation
|
2545
|
+
|
2546
|
+
property :retailer_display_name, as: 'retailerDisplayName'
|
2547
|
+
end
|
2548
|
+
end
|
2549
|
+
|
2522
2550
|
class GoogleCloudRetailV2alphaConversationalSearchRequest
|
2523
2551
|
# @private
|
2524
2552
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2923,6 +2951,26 @@ module Google
|
|
2923
2951
|
end
|
2924
2952
|
end
|
2925
2953
|
|
2954
|
+
class GoogleCloudRetailV2alphaIntentClassificationConfig
|
2955
|
+
# @private
|
2956
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2957
|
+
collection :blocklist_keywords, as: 'blocklistKeywords'
|
2958
|
+
collection :disabled_intent_types, as: 'disabledIntentTypes'
|
2959
|
+
collection :example, as: 'example', class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaIntentClassificationConfigExample, decorator: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaIntentClassificationConfigExample::Representation
|
2960
|
+
|
2961
|
+
property :model_preamble, as: 'modelPreamble'
|
2962
|
+
end
|
2963
|
+
end
|
2964
|
+
|
2965
|
+
class GoogleCloudRetailV2alphaIntentClassificationConfigExample
|
2966
|
+
# @private
|
2967
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
2968
|
+
property :intent_type, as: 'intentType'
|
2969
|
+
property :query, as: 'query'
|
2970
|
+
property :reason, as: 'reason'
|
2971
|
+
end
|
2972
|
+
end
|
2973
|
+
|
2926
2974
|
class GoogleCloudRetailV2alphaInterval
|
2927
2975
|
# @private
|
2928
2976
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -482,6 +482,37 @@ module Google
|
|
482
482
|
execute_or_queue_command(command, &block)
|
483
483
|
end
|
484
484
|
|
485
|
+
# Returns the conversational search customization config for a given catalog.
|
486
|
+
# @param [String] name
|
487
|
+
# Required. Resource name of the parent catalog. Format: projects/`project`/
|
488
|
+
# locations/`location`/catalogs/`catalog`
|
489
|
+
# @param [String] fields
|
490
|
+
# Selector specifying which fields to include in a partial response.
|
491
|
+
# @param [String] quota_user
|
492
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
493
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
494
|
+
# @param [Google::Apis::RequestOptions] options
|
495
|
+
# Request-specific options
|
496
|
+
#
|
497
|
+
# @yield [result, err] Result & error if block supplied
|
498
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig] parsed result object
|
499
|
+
# @yieldparam err [StandardError] error object if request failed
|
500
|
+
#
|
501
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig]
|
502
|
+
#
|
503
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
504
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
505
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
506
|
+
def get_project_location_catalog_conversational_search_customization_config(name, fields: nil, quota_user: nil, options: nil, &block)
|
507
|
+
command = make_simple_command(:get, 'v2alpha/{+name}/conversationalSearchCustomizationConfig', options)
|
508
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig::Representation
|
509
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig
|
510
|
+
command.params['name'] = name unless name.nil?
|
511
|
+
command.query['fields'] = fields unless fields.nil?
|
512
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
513
|
+
execute_or_queue_command(command, &block)
|
514
|
+
end
|
515
|
+
|
485
516
|
# Get which branch is currently default branch set by CatalogService.
|
486
517
|
# SetDefaultBranch method under a specified parent catalog.
|
487
518
|
# @param [String] catalog
|
@@ -763,6 +794,45 @@ module Google
|
|
763
794
|
execute_or_queue_command(command, &block)
|
764
795
|
end
|
765
796
|
|
797
|
+
# Updates the conversational search customization config for a given catalog.
|
798
|
+
# @param [String] catalog
|
799
|
+
# Required. Resource name of the catalog. Format: projects/`project`/locations/`
|
800
|
+
# location`/catalogs/`catalog`
|
801
|
+
# @param [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig] google_cloud_retail_v2alpha_conversational_search_customization_config_object
|
802
|
+
# @param [String] update_mask
|
803
|
+
# Optional. Indicates which fields in the provided
|
804
|
+
# ConversationalSearchCustomizationConfig to update. If not set or empty, all
|
805
|
+
# supported fields are updated.
|
806
|
+
# @param [String] fields
|
807
|
+
# Selector specifying which fields to include in a partial response.
|
808
|
+
# @param [String] quota_user
|
809
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
810
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
811
|
+
# @param [Google::Apis::RequestOptions] options
|
812
|
+
# Request-specific options
|
813
|
+
#
|
814
|
+
# @yield [result, err] Result & error if block supplied
|
815
|
+
# @yieldparam result [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig] parsed result object
|
816
|
+
# @yieldparam err [StandardError] error object if request failed
|
817
|
+
#
|
818
|
+
# @return [Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig]
|
819
|
+
#
|
820
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
821
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
822
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
823
|
+
def update_project_location_catalog_conversational_search_customization_config(catalog, google_cloud_retail_v2alpha_conversational_search_customization_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
824
|
+
command = make_simple_command(:patch, 'v2alpha/{+catalog}/conversationalSearchCustomizationConfig', options)
|
825
|
+
command.request_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig::Representation
|
826
|
+
command.request_object = google_cloud_retail_v2alpha_conversational_search_customization_config_object
|
827
|
+
command.response_representation = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig::Representation
|
828
|
+
command.response_class = Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaConversationalSearchCustomizationConfig
|
829
|
+
command.params['catalog'] = catalog unless catalog.nil?
|
830
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
831
|
+
command.query['fields'] = fields unless fields.nil?
|
832
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
833
|
+
execute_or_queue_command(command, &block)
|
834
|
+
end
|
835
|
+
|
766
836
|
# Allows management of individual questions.
|
767
837
|
# @param [String] catalog
|
768
838
|
# 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_v2alpha
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.120.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
@@ -57,7 +57,7 @@ licenses:
|
|
57
57
|
metadata:
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha/CHANGELOG.md
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2alpha/v0.120.0
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2alpha
|
62
62
|
rdoc_options: []
|
63
63
|
require_paths:
|