google-apis-retail_v2beta 0.117.0 → 0.119.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: 5462bde07d57d1923b63dd3fe85d033cf1ae6de70694baddb03c5d06a55cabd9
4
- data.tar.gz: 3ef9a3056f6e43a68410b7fa1af97bbfa212d88a8074c0f5a2d9be7652947fc8
3
+ metadata.gz: 60016698873e772044106c1455e53b7b5ec6f5e281d9d2ba9419c31e6f496fba
4
+ data.tar.gz: b21278b1811258bffd2f25e5b4040e72ab1251470c6a6c1ddda8f185247878dc
5
5
  SHA512:
6
- metadata.gz: 3d9475f6b8609fa6ef7bf97348cf1d6d2fd77c302afa9734fdf929587e25c5af98095ea616dcd3f6552d52af672c28e031e43199db386138d9ec150806209f42
7
- data.tar.gz: 2cfe80ed4f2531634eae12f5f77d30f47d82db5ab1f522b7b587a882a090c6677b1c01be9ce6067b61ee5b46497a5b8ab00eb9d46be9ba1e441c110010dae843
6
+ metadata.gz: 9f4f91edf9ccdf267d2f0a4d78afd6bac08b844929f0bd39e9b4e999844ba2b48c39210262db4136504ff46e67d0780430454ac2e34e2f7df52f28cec3c74ca6
7
+ data.tar.gz: 3512e8f2a1a49a3797fd0d215e14fdda6ae9dd5c1bb49aaab299e78c5ea35d0fb048eba00ff9bb1626e3f6b573bb2677738a1c21915e900a1ebae62d9bf6943c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-retail_v2beta
2
2
 
3
+ ### v0.119.0 (2025-09-21)
4
+
5
+ * Regenerated from discovery document revision 20250911
6
+
7
+ ### v0.118.0 (2025-08-17)
8
+
9
+ * Regenerated from discovery document revision 20250807
10
+
3
11
  ### v0.117.0 (2025-07-27)
4
12
 
5
13
  * Regenerated from discovery document revision 20250717
@@ -3806,11 +3806,6 @@ module Google
3806
3806
  # @return [String]
3807
3807
  attr_accessor :display_name
3808
3808
 
3809
- # A facet specification to perform faceted search.
3810
- # Corresponds to the JSON property `facetSpec`
3811
- # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestFacetSpec]
3812
- attr_accessor :facet_spec
3813
-
3814
3809
  # Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/
3815
3810
  # controls/*`
3816
3811
  # Corresponds to the JSON property `name`
@@ -3848,7 +3843,6 @@ module Google
3848
3843
  def update!(**args)
3849
3844
  @associated_serving_config_ids = args[:associated_serving_config_ids] if args.key?(:associated_serving_config_ids)
3850
3845
  @display_name = args[:display_name] if args.key?(:display_name)
3851
- @facet_spec = args[:facet_spec] if args.key?(:facet_spec)
3852
3846
  @name = args[:name] if args.key?(:name)
3853
3847
  @rule = args[:rule] if args.key?(:rule)
3854
3848
  @search_solution_use_case = args[:search_solution_use_case] if args.key?(:search_solution_use_case)
@@ -3891,6 +3885,414 @@ module Google
3891
3885
  end
3892
3886
  end
3893
3887
 
3888
+ # Request message for ConversationalSearchService.ConversationalSearch method.
3889
+ class GoogleCloudRetailV2betaConversationalSearchRequest
3890
+ include Google::Apis::Core::Hashable
3891
+
3892
+ # Required. The branch resource name, such as `projects/*/locations/global/
3893
+ # catalogs/default_catalog/branches/0`. Use "default_branch" as the branch ID or
3894
+ # leave this field empty, to search products under the default branch.
3895
+ # Corresponds to the JSON property `branch`
3896
+ # @return [String]
3897
+ attr_accessor :branch
3898
+
3899
+ # Optional. This field specifies the conversation id, which maintains the state
3900
+ # of the conversation between client side and server side. Use the value from
3901
+ # the previous ConversationalSearchResponse.conversation_id. For the initial
3902
+ # request, this should be empty.
3903
+ # Corresponds to the JSON property `conversationId`
3904
+ # @return [String]
3905
+ attr_accessor :conversation_id
3906
+
3907
+ # This field specifies all conversational filtering related parameters addition
3908
+ # to conversational retail search.
3909
+ # Corresponds to the JSON property `conversationalFilteringSpec`
3910
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec]
3911
+ attr_accessor :conversational_filtering_spec
3912
+
3913
+ # Optional. The categories associated with a category page. Must be set for
3914
+ # category navigation queries to achieve good search quality. The format should
3915
+ # be the same as UserEvent.page_categories; To represent full path of category,
3916
+ # use '>' sign to separate different hierarchies. If '>' is part of the category
3917
+ # name, replace it with other character(s). Category pages include special pages
3918
+ # such as sales or promotions. For instance, a special sale page may have the
3919
+ # category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
3920
+ # Corresponds to the JSON property `pageCategories`
3921
+ # @return [Array<String>]
3922
+ attr_accessor :page_categories
3923
+
3924
+ # Optional. Raw search query to be searched for. If this field is empty, the
3925
+ # request is considered a category browsing request.
3926
+ # Corresponds to the JSON property `query`
3927
+ # @return [String]
3928
+ attr_accessor :query
3929
+
3930
+ # Optional. The safety settings to be applied to the generated content.
3931
+ # Corresponds to the JSON property `safetySettings`
3932
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSafetySetting>]
3933
+ attr_accessor :safety_settings
3934
+
3935
+ # Search parameters.
3936
+ # Corresponds to the JSON property `searchParams`
3937
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestSearchParams]
3938
+ attr_accessor :search_params
3939
+
3940
+ # Information of an end user.
3941
+ # Corresponds to the JSON property `userInfo`
3942
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo]
3943
+ attr_accessor :user_info
3944
+
3945
+ # Optional. The user labels applied to a resource must meet the following
3946
+ # requirements: * Each resource can have multiple labels, up to a maximum of 64.
3947
+ # * Each label must be a key-value pair. * Keys have a minimum length of 1
3948
+ # character and a maximum length of 63 characters and cannot be empty. Values
3949
+ # can be empty and have a maximum length of 63 characters. * Keys and values can
3950
+ # contain only lowercase letters, numeric characters, underscores, and dashes.
3951
+ # All characters must use UTF-8 encoding, and international characters are
3952
+ # allowed. * The key portion of a label must be unique. However, you can use the
3953
+ # same key with multiple resources. * Keys must start with a lowercase letter or
3954
+ # international character. See [Google Cloud Document](https://cloud.google.com/
3955
+ # resource-manager/docs/creating-managing-labels#requirements) for more details.
3956
+ # Corresponds to the JSON property `userLabels`
3957
+ # @return [Hash<String,String>]
3958
+ attr_accessor :user_labels
3959
+
3960
+ # Required. A unique identifier for tracking visitors. For example, this could
3961
+ # be implemented with an HTTP cookie, which should be able to uniquely identify
3962
+ # a visitor on a single device. This unique identifier should not change if the
3963
+ # visitor logs in or out of the website. This should be the same identifier as
3964
+ # UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length
3965
+ # limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
3966
+ # Corresponds to the JSON property `visitorId`
3967
+ # @return [String]
3968
+ attr_accessor :visitor_id
3969
+
3970
+ def initialize(**args)
3971
+ update!(**args)
3972
+ end
3973
+
3974
+ # Update properties of this object
3975
+ def update!(**args)
3976
+ @branch = args[:branch] if args.key?(:branch)
3977
+ @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
3978
+ @conversational_filtering_spec = args[:conversational_filtering_spec] if args.key?(:conversational_filtering_spec)
3979
+ @page_categories = args[:page_categories] if args.key?(:page_categories)
3980
+ @query = args[:query] if args.key?(:query)
3981
+ @safety_settings = args[:safety_settings] if args.key?(:safety_settings)
3982
+ @search_params = args[:search_params] if args.key?(:search_params)
3983
+ @user_info = args[:user_info] if args.key?(:user_info)
3984
+ @user_labels = args[:user_labels] if args.key?(:user_labels)
3985
+ @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
3986
+ end
3987
+ end
3988
+
3989
+ # This field specifies all conversational filtering related parameters addition
3990
+ # to conversational retail search.
3991
+ class GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec
3992
+ include Google::Apis::Core::Hashable
3993
+
3994
+ # Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED
3995
+ # if it's unset.
3996
+ # Corresponds to the JSON property `conversationalFilteringMode`
3997
+ # @return [String]
3998
+ attr_accessor :conversational_filtering_mode
3999
+
4000
+ # Optional. This field is deprecated. Please use ConversationalFilteringSpec.
4001
+ # conversational_filtering_mode instead.
4002
+ # Corresponds to the JSON property `enableConversationalFiltering`
4003
+ # @return [Boolean]
4004
+ attr_accessor :enable_conversational_filtering
4005
+ alias_method :enable_conversational_filtering?, :enable_conversational_filtering
4006
+
4007
+ # This field specifies the current user answer during the conversational
4008
+ # filtering search. This can be either user selected from suggested answers or
4009
+ # user input plain text.
4010
+ # Corresponds to the JSON property `userAnswer`
4011
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer]
4012
+ attr_accessor :user_answer
4013
+
4014
+ def initialize(**args)
4015
+ update!(**args)
4016
+ end
4017
+
4018
+ # Update properties of this object
4019
+ def update!(**args)
4020
+ @conversational_filtering_mode = args[:conversational_filtering_mode] if args.key?(:conversational_filtering_mode)
4021
+ @enable_conversational_filtering = args[:enable_conversational_filtering] if args.key?(:enable_conversational_filtering)
4022
+ @user_answer = args[:user_answer] if args.key?(:user_answer)
4023
+ end
4024
+ end
4025
+
4026
+ # Search parameters.
4027
+ class GoogleCloudRetailV2betaConversationalSearchRequestSearchParams
4028
+ include Google::Apis::Core::Hashable
4029
+
4030
+ # Boost specification to boost certain items.
4031
+ # Corresponds to the JSON property `boostSpec`
4032
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpec]
4033
+ attr_accessor :boost_spec
4034
+
4035
+ # Optional. The canonical filter string to restrict search results. The syntax
4036
+ # of the canonical filter string is the same as SearchRequest.canonical_filter.
4037
+ # Corresponds to the JSON property `canonicalFilter`
4038
+ # @return [String]
4039
+ attr_accessor :canonical_filter
4040
+
4041
+ # Optional. The filter string to restrict search results. The syntax of the
4042
+ # filter string is the same as SearchRequest.filter.
4043
+ # Corresponds to the JSON property `filter`
4044
+ # @return [String]
4045
+ attr_accessor :filter
4046
+
4047
+ # Optional. The sort string to specify the sorting of search results. The syntax
4048
+ # of the sort string is the same as SearchRequest.sort.
4049
+ # Corresponds to the JSON property `sortBy`
4050
+ # @return [String]
4051
+ attr_accessor :sort_by
4052
+
4053
+ def initialize(**args)
4054
+ update!(**args)
4055
+ end
4056
+
4057
+ # Update properties of this object
4058
+ def update!(**args)
4059
+ @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
4060
+ @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
4061
+ @filter = args[:filter] if args.key?(:filter)
4062
+ @sort_by = args[:sort_by] if args.key?(:sort_by)
4063
+ end
4064
+ end
4065
+
4066
+ # This field specifies the current user answer during the conversational
4067
+ # filtering search. This can be either user selected from suggested answers or
4068
+ # user input plain text.
4069
+ class GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer
4070
+ include Google::Apis::Core::Hashable
4071
+
4072
+ # This field specifies the selected answers during the conversational search.
4073
+ # Corresponds to the JSON property `selectedAnswer`
4074
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer]
4075
+ attr_accessor :selected_answer
4076
+
4077
+ # This field specifies the incremental input text from the user during the
4078
+ # conversational search.
4079
+ # Corresponds to the JSON property `textAnswer`
4080
+ # @return [String]
4081
+ attr_accessor :text_answer
4082
+
4083
+ def initialize(**args)
4084
+ update!(**args)
4085
+ end
4086
+
4087
+ # Update properties of this object
4088
+ def update!(**args)
4089
+ @selected_answer = args[:selected_answer] if args.key?(:selected_answer)
4090
+ @text_answer = args[:text_answer] if args.key?(:text_answer)
4091
+ end
4092
+ end
4093
+
4094
+ # This field specifies the selected answers during the conversational search.
4095
+ class GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer
4096
+ include Google::Apis::Core::Hashable
4097
+
4098
+ # Product attribute which structured by an attribute name and value. This
4099
+ # structure is used in conversational search filters and answers. For example,
4100
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
4101
+ # Corresponds to the JSON property `productAttributeValue`
4102
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductAttributeValue]
4103
+ attr_accessor :product_attribute_value
4104
+
4105
+ def initialize(**args)
4106
+ update!(**args)
4107
+ end
4108
+
4109
+ # Update properties of this object
4110
+ def update!(**args)
4111
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
4112
+ end
4113
+ end
4114
+
4115
+ # Response message for ConversationalSearchService.ConversationalSearch method.
4116
+ class GoogleCloudRetailV2betaConversationalSearchResponse
4117
+ include Google::Apis::Core::Hashable
4118
+
4119
+ # Conversation UUID. This field will be stored in client side storage to
4120
+ # maintain the conversation session with server and will be used for next search
4121
+ # request's ConversationalSearchRequest.conversation_id to restore conversation
4122
+ # state in server.
4123
+ # Corresponds to the JSON property `conversationId`
4124
+ # @return [String]
4125
+ attr_accessor :conversation_id
4126
+
4127
+ # This field specifies all related information that is needed on client side for
4128
+ # UI rendering of conversational filtering search.
4129
+ # Corresponds to the JSON property `conversationalFilteringResult`
4130
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult]
4131
+ attr_accessor :conversational_filtering_result
4132
+
4133
+ # The conversational answer-based text response generated by the Server.
4134
+ # Corresponds to the JSON property `conversationalTextResponse`
4135
+ # @return [String]
4136
+ attr_accessor :conversational_text_response
4137
+
4138
+ # The conversational followup question generated for Intent refinement.
4139
+ # Corresponds to the JSON property `followupQuestion`
4140
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion]
4141
+ attr_accessor :followup_question
4142
+
4143
+ # The proposed refined search queries. They can be used to fetch the relevant
4144
+ # search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query
4145
+ # from search response will be populated here.
4146
+ # Corresponds to the JSON property `refinedSearch`
4147
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch>]
4148
+ attr_accessor :refined_search
4149
+
4150
+ # Output only. The state of the response generation.
4151
+ # Corresponds to the JSON property `state`
4152
+ # @return [String]
4153
+ attr_accessor :state
4154
+
4155
+ # The types Retail classifies the search query as. Supported values are: - "
4156
+ # ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "
4157
+ # PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "
4158
+ # STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "
4159
+ # DISABLED"
4160
+ # Corresponds to the JSON property `userQueryTypes`
4161
+ # @return [Array<String>]
4162
+ attr_accessor :user_query_types
4163
+
4164
+ def initialize(**args)
4165
+ update!(**args)
4166
+ end
4167
+
4168
+ # Update properties of this object
4169
+ def update!(**args)
4170
+ @conversation_id = args[:conversation_id] if args.key?(:conversation_id)
4171
+ @conversational_filtering_result = args[:conversational_filtering_result] if args.key?(:conversational_filtering_result)
4172
+ @conversational_text_response = args[:conversational_text_response] if args.key?(:conversational_text_response)
4173
+ @followup_question = args[:followup_question] if args.key?(:followup_question)
4174
+ @refined_search = args[:refined_search] if args.key?(:refined_search)
4175
+ @state = args[:state] if args.key?(:state)
4176
+ @user_query_types = args[:user_query_types] if args.key?(:user_query_types)
4177
+ end
4178
+ end
4179
+
4180
+ # This field specifies all related information that is needed on client side for
4181
+ # UI rendering of conversational filtering search.
4182
+ class GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult
4183
+ include Google::Apis::Core::Hashable
4184
+
4185
+ # Additional filter that client side need to apply.
4186
+ # Corresponds to the JSON property `additionalFilter`
4187
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter]
4188
+ attr_accessor :additional_filter
4189
+
4190
+ # The conversational followup question generated for Intent refinement.
4191
+ # Corresponds to the JSON property `followupQuestion`
4192
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion]
4193
+ attr_accessor :followup_question
4194
+
4195
+ def initialize(**args)
4196
+ update!(**args)
4197
+ end
4198
+
4199
+ # Update properties of this object
4200
+ def update!(**args)
4201
+ @additional_filter = args[:additional_filter] if args.key?(:additional_filter)
4202
+ @followup_question = args[:followup_question] if args.key?(:followup_question)
4203
+ end
4204
+ end
4205
+
4206
+ # Additional filter that client side need to apply.
4207
+ class GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter
4208
+ include Google::Apis::Core::Hashable
4209
+
4210
+ # Product attribute which structured by an attribute name and value. This
4211
+ # structure is used in conversational search filters and answers. For example,
4212
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
4213
+ # Corresponds to the JSON property `productAttributeValue`
4214
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductAttributeValue]
4215
+ attr_accessor :product_attribute_value
4216
+
4217
+ def initialize(**args)
4218
+ update!(**args)
4219
+ end
4220
+
4221
+ # Update properties of this object
4222
+ def update!(**args)
4223
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
4224
+ end
4225
+ end
4226
+
4227
+ # The conversational followup question generated for Intent refinement.
4228
+ class GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion
4229
+ include Google::Apis::Core::Hashable
4230
+
4231
+ # The conversational followup question generated for Intent refinement.
4232
+ # Corresponds to the JSON property `followupQuestion`
4233
+ # @return [String]
4234
+ attr_accessor :followup_question
4235
+
4236
+ # The answer options provided to client for the follow-up question.
4237
+ # Corresponds to the JSON property `suggestedAnswers`
4238
+ # @return [Array<Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer>]
4239
+ attr_accessor :suggested_answers
4240
+
4241
+ def initialize(**args)
4242
+ update!(**args)
4243
+ end
4244
+
4245
+ # Update properties of this object
4246
+ def update!(**args)
4247
+ @followup_question = args[:followup_question] if args.key?(:followup_question)
4248
+ @suggested_answers = args[:suggested_answers] if args.key?(:suggested_answers)
4249
+ end
4250
+ end
4251
+
4252
+ # Suggested answers to the follow-up question. If it's numerical attribute, only
4253
+ # ProductAttributeInterval will be set. If it's textual attribute, only
4254
+ # productAttributeValue will be set.
4255
+ class GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer
4256
+ include Google::Apis::Core::Hashable
4257
+
4258
+ # Product attribute which structured by an attribute name and value. This
4259
+ # structure is used in conversational search filters and answers. For example,
4260
+ # if we have `name=color` and `value=red`, this means that the color is `red`.
4261
+ # Corresponds to the JSON property `productAttributeValue`
4262
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductAttributeValue]
4263
+ attr_accessor :product_attribute_value
4264
+
4265
+ def initialize(**args)
4266
+ update!(**args)
4267
+ end
4268
+
4269
+ # Update properties of this object
4270
+ def update!(**args)
4271
+ @product_attribute_value = args[:product_attribute_value] if args.key?(:product_attribute_value)
4272
+ end
4273
+ end
4274
+
4275
+ # The proposed refined search for intent-refinement/bundled shopping
4276
+ # conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query
4277
+ # from search response will be populated here.
4278
+ class GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch
4279
+ include Google::Apis::Core::Hashable
4280
+
4281
+ # The query to be used for search.
4282
+ # Corresponds to the JSON property `query`
4283
+ # @return [String]
4284
+ attr_accessor :query
4285
+
4286
+ def initialize(**args)
4287
+ update!(**args)
4288
+ end
4289
+
4290
+ # Update properties of this object
4291
+ def update!(**args)
4292
+ @query = args[:query] if args.key?(:query)
4293
+ end
4294
+ end
4295
+
3894
4296
  # Metadata associated with a create operation.
3895
4297
  class GoogleCloudRetailV2betaCreateModelMetadata
3896
4298
  include Google::Apis::Core::Hashable
@@ -7703,6 +8105,38 @@ module Google
7703
8105
  end
7704
8106
  end
7705
8107
 
8108
+ # Safety settings.
8109
+ class GoogleCloudRetailV2betaSafetySetting
8110
+ include Google::Apis::Core::Hashable
8111
+
8112
+ # Harm category.
8113
+ # Corresponds to the JSON property `category`
8114
+ # @return [String]
8115
+ attr_accessor :category
8116
+
8117
+ # Optional. Specify if the threshold is used for probability or severity score.
8118
+ # If not specified, the threshold is used for probability score.
8119
+ # Corresponds to the JSON property `method`
8120
+ # @return [String]
8121
+ attr_accessor :method_prop
8122
+
8123
+ # The harm block threshold.
8124
+ # Corresponds to the JSON property `threshold`
8125
+ # @return [String]
8126
+ attr_accessor :threshold
8127
+
8128
+ def initialize(**args)
8129
+ update!(**args)
8130
+ end
8131
+
8132
+ # Update properties of this object
8133
+ def update!(**args)
8134
+ @category = args[:category] if args.key?(:category)
8135
+ @method_prop = args[:method_prop] if args.key?(:method_prop)
8136
+ @threshold = args[:threshold] if args.key?(:threshold)
8137
+ end
8138
+ end
8139
+
7706
8140
  # Request message for SearchService.Search method.
7707
8141
  class GoogleCloudRetailV2betaSearchRequest
7708
8142
  include Google::Apis::Core::Hashable
@@ -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.117.0"
19
+ GEM_VERSION = "0.119.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 = "20250717"
25
+ REVISION = "20250911"
26
26
  end
27
27
  end
28
28
  end
@@ -790,6 +790,72 @@ module Google
790
790
  include Google::Apis::Core::JsonObjectSupport
791
791
  end
792
792
 
793
+ class GoogleCloudRetailV2betaConversationalSearchRequest
794
+ class Representation < Google::Apis::Core::JsonRepresentation; end
795
+
796
+ include Google::Apis::Core::JsonObjectSupport
797
+ end
798
+
799
+ class GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec
800
+ class Representation < Google::Apis::Core::JsonRepresentation; end
801
+
802
+ include Google::Apis::Core::JsonObjectSupport
803
+ end
804
+
805
+ class GoogleCloudRetailV2betaConversationalSearchRequestSearchParams
806
+ class Representation < Google::Apis::Core::JsonRepresentation; end
807
+
808
+ include Google::Apis::Core::JsonObjectSupport
809
+ end
810
+
811
+ class GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer
812
+ class Representation < Google::Apis::Core::JsonRepresentation; end
813
+
814
+ include Google::Apis::Core::JsonObjectSupport
815
+ end
816
+
817
+ class GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer
818
+ class Representation < Google::Apis::Core::JsonRepresentation; end
819
+
820
+ include Google::Apis::Core::JsonObjectSupport
821
+ end
822
+
823
+ class GoogleCloudRetailV2betaConversationalSearchResponse
824
+ class Representation < Google::Apis::Core::JsonRepresentation; end
825
+
826
+ include Google::Apis::Core::JsonObjectSupport
827
+ end
828
+
829
+ class GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult
830
+ class Representation < Google::Apis::Core::JsonRepresentation; end
831
+
832
+ include Google::Apis::Core::JsonObjectSupport
833
+ end
834
+
835
+ class GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter
836
+ class Representation < Google::Apis::Core::JsonRepresentation; end
837
+
838
+ include Google::Apis::Core::JsonObjectSupport
839
+ end
840
+
841
+ class GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion
842
+ class Representation < Google::Apis::Core::JsonRepresentation; end
843
+
844
+ include Google::Apis::Core::JsonObjectSupport
845
+ end
846
+
847
+ class GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer
848
+ class Representation < Google::Apis::Core::JsonRepresentation; end
849
+
850
+ include Google::Apis::Core::JsonObjectSupport
851
+ end
852
+
853
+ class GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch
854
+ class Representation < Google::Apis::Core::JsonRepresentation; end
855
+
856
+ include Google::Apis::Core::JsonObjectSupport
857
+ end
858
+
793
859
  class GoogleCloudRetailV2betaCreateModelMetadata
794
860
  class Representation < Google::Apis::Core::JsonRepresentation; end
795
861
 
@@ -1402,6 +1468,12 @@ module Google
1402
1468
  include Google::Apis::Core::JsonObjectSupport
1403
1469
  end
1404
1470
 
1471
+ class GoogleCloudRetailV2betaSafetySetting
1472
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1473
+
1474
+ include Google::Apis::Core::JsonObjectSupport
1475
+ end
1476
+
1405
1477
  class GoogleCloudRetailV2betaSearchRequest
1406
1478
  class Representation < Google::Apis::Core::JsonRepresentation; end
1407
1479
 
@@ -2753,8 +2825,6 @@ module Google
2753
2825
  class Representation < Google::Apis::Core::JsonRepresentation
2754
2826
  collection :associated_serving_config_ids, as: 'associatedServingConfigIds'
2755
2827
  property :display_name, as: 'displayName'
2756
- property :facet_spec, as: 'facetSpec', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestFacetSpec, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestFacetSpec::Representation
2757
-
2758
2828
  property :name, as: 'name'
2759
2829
  property :rule, as: 'rule', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaRule::Representation
2760
2830
 
@@ -2773,6 +2843,122 @@ module Google
2773
2843
  end
2774
2844
  end
2775
2845
 
2846
+ class GoogleCloudRetailV2betaConversationalSearchRequest
2847
+ # @private
2848
+ class Representation < Google::Apis::Core::JsonRepresentation
2849
+ property :branch, as: 'branch'
2850
+ property :conversation_id, as: 'conversationId'
2851
+ property :conversational_filtering_spec, as: 'conversationalFilteringSpec', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec::Representation
2852
+
2853
+ collection :page_categories, as: 'pageCategories'
2854
+ property :query, as: 'query'
2855
+ collection :safety_settings, as: 'safetySettings', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSafetySetting, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSafetySetting::Representation
2856
+
2857
+ property :search_params, as: 'searchParams', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestSearchParams, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestSearchParams::Representation
2858
+
2859
+ property :user_info, as: 'userInfo', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaUserInfo::Representation
2860
+
2861
+ hash :user_labels, as: 'userLabels'
2862
+ property :visitor_id, as: 'visitorId'
2863
+ end
2864
+ end
2865
+
2866
+ class GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec
2867
+ # @private
2868
+ class Representation < Google::Apis::Core::JsonRepresentation
2869
+ property :conversational_filtering_mode, as: 'conversationalFilteringMode'
2870
+ property :enable_conversational_filtering, as: 'enableConversationalFiltering'
2871
+ property :user_answer, as: 'userAnswer', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer::Representation
2872
+
2873
+ end
2874
+ end
2875
+
2876
+ class GoogleCloudRetailV2betaConversationalSearchRequestSearchParams
2877
+ # @private
2878
+ class Representation < Google::Apis::Core::JsonRepresentation
2879
+ property :boost_spec, as: 'boostSpec', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpec, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaSearchRequestBoostSpec::Representation
2880
+
2881
+ property :canonical_filter, as: 'canonicalFilter'
2882
+ property :filter, as: 'filter'
2883
+ property :sort_by, as: 'sortBy'
2884
+ end
2885
+ end
2886
+
2887
+ class GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer
2888
+ # @private
2889
+ class Representation < Google::Apis::Core::JsonRepresentation
2890
+ property :selected_answer, as: 'selectedAnswer', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer::Representation
2891
+
2892
+ property :text_answer, as: 'textAnswer'
2893
+ end
2894
+ end
2895
+
2896
+ class GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer
2897
+ # @private
2898
+ class Representation < Google::Apis::Core::JsonRepresentation
2899
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductAttributeValue, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductAttributeValue::Representation
2900
+
2901
+ end
2902
+ end
2903
+
2904
+ class GoogleCloudRetailV2betaConversationalSearchResponse
2905
+ # @private
2906
+ class Representation < Google::Apis::Core::JsonRepresentation
2907
+ property :conversation_id, as: 'conversationId'
2908
+ property :conversational_filtering_result, as: 'conversationalFilteringResult', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult::Representation
2909
+
2910
+ property :conversational_text_response, as: 'conversationalTextResponse'
2911
+ property :followup_question, as: 'followupQuestion', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion::Representation
2912
+
2913
+ collection :refined_search, as: 'refinedSearch', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch::Representation
2914
+
2915
+ property :state, as: 'state'
2916
+ collection :user_query_types, as: 'userQueryTypes'
2917
+ end
2918
+ end
2919
+
2920
+ class GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult
2921
+ # @private
2922
+ class Representation < Google::Apis::Core::JsonRepresentation
2923
+ property :additional_filter, as: 'additionalFilter', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter::Representation
2924
+
2925
+ property :followup_question, as: 'followupQuestion', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion::Representation
2926
+
2927
+ end
2928
+ end
2929
+
2930
+ class GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter
2931
+ # @private
2932
+ class Representation < Google::Apis::Core::JsonRepresentation
2933
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductAttributeValue, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductAttributeValue::Representation
2934
+
2935
+ end
2936
+ end
2937
+
2938
+ class GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion
2939
+ # @private
2940
+ class Representation < Google::Apis::Core::JsonRepresentation
2941
+ property :followup_question, as: 'followupQuestion'
2942
+ collection :suggested_answers, as: 'suggestedAnswers', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer::Representation
2943
+
2944
+ end
2945
+ end
2946
+
2947
+ class GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer
2948
+ # @private
2949
+ class Representation < Google::Apis::Core::JsonRepresentation
2950
+ property :product_attribute_value, as: 'productAttributeValue', class: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductAttributeValue, decorator: Google::Apis::RetailV2beta::GoogleCloudRetailV2betaProductAttributeValue::Representation
2951
+
2952
+ end
2953
+ end
2954
+
2955
+ class GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch
2956
+ # @private
2957
+ class Representation < Google::Apis::Core::JsonRepresentation
2958
+ property :query, as: 'query'
2959
+ end
2960
+ end
2961
+
2776
2962
  class GoogleCloudRetailV2betaCreateModelMetadata
2777
2963
  # @private
2778
2964
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3749,6 +3935,15 @@ module Google
3749
3935
  end
3750
3936
  end
3751
3937
 
3938
+ class GoogleCloudRetailV2betaSafetySetting
3939
+ # @private
3940
+ class Representation < Google::Apis::Core::JsonRepresentation
3941
+ property :category, as: 'category'
3942
+ property :method_prop, as: 'method'
3943
+ property :threshold, as: 'threshold'
3944
+ end
3945
+ end
3946
+
3752
3947
  class GoogleCloudRetailV2betaSearchRequest
3753
3948
  # @private
3754
3949
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2151,6 +2151,44 @@ module Google
2151
2151
  execute_or_queue_command(command, &block)
2152
2152
  end
2153
2153
 
2154
+ # Performs a conversational search. This feature is only available for users who
2155
+ # have Conversational Search enabled.
2156
+ # @param [String] placement
2157
+ # Required. The resource name of the search engine placement, such as `projects/*
2158
+ # /locations/global/catalogs/default_catalog/placements/default_search` or `
2159
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
2160
+ # default_serving_config` This field is used to identify the serving config name
2161
+ # and the set of models that will be used to make the search.
2162
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequest] google_cloud_retail_v2beta_conversational_search_request_object
2163
+ # @param [String] fields
2164
+ # Selector specifying which fields to include in a partial response.
2165
+ # @param [String] quota_user
2166
+ # Available to use for quota purposes for server-side applications. Can be any
2167
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2168
+ # @param [Google::Apis::RequestOptions] options
2169
+ # Request-specific options
2170
+ #
2171
+ # @yield [result, err] Result & error if block supplied
2172
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponse] parsed result object
2173
+ # @yieldparam err [StandardError] error object if request failed
2174
+ #
2175
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponse]
2176
+ #
2177
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2178
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2179
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2180
+ def conversational_project_location_catalog_placement_search(placement, google_cloud_retail_v2beta_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2181
+ command = make_simple_command(:post, 'v2beta/{+placement}:conversationalSearch', options)
2182
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequest::Representation
2183
+ command.request_object = google_cloud_retail_v2beta_conversational_search_request_object
2184
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponse::Representation
2185
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponse
2186
+ command.params['placement'] = placement unless placement.nil?
2187
+ command.query['fields'] = fields unless fields.nil?
2188
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2189
+ execute_or_queue_command(command, &block)
2190
+ end
2191
+
2154
2192
  # Makes a recommendation prediction.
2155
2193
  # @param [String] placement
2156
2194
  # Required. Full resource name of the format: ``placement=projects/*/locations/
@@ -2273,6 +2311,44 @@ module Google
2273
2311
  execute_or_queue_command(command, &block)
2274
2312
  end
2275
2313
 
2314
+ # Performs a conversational search. This feature is only available for users who
2315
+ # have Conversational Search enabled.
2316
+ # @param [String] placement
2317
+ # Required. The resource name of the search engine placement, such as `projects/*
2318
+ # /locations/global/catalogs/default_catalog/placements/default_search` or `
2319
+ # projects/*/locations/global/catalogs/default_catalog/servingConfigs/
2320
+ # default_serving_config` This field is used to identify the serving config name
2321
+ # and the set of models that will be used to make the search.
2322
+ # @param [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequest] google_cloud_retail_v2beta_conversational_search_request_object
2323
+ # @param [String] fields
2324
+ # Selector specifying which fields to include in a partial response.
2325
+ # @param [String] quota_user
2326
+ # Available to use for quota purposes for server-side applications. Can be any
2327
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
2328
+ # @param [Google::Apis::RequestOptions] options
2329
+ # Request-specific options
2330
+ #
2331
+ # @yield [result, err] Result & error if block supplied
2332
+ # @yieldparam result [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponse] parsed result object
2333
+ # @yieldparam err [StandardError] error object if request failed
2334
+ #
2335
+ # @return [Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponse]
2336
+ #
2337
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
2338
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
2339
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
2340
+ def conversational_project_location_catalog_serving_config_search(placement, google_cloud_retail_v2beta_conversational_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
2341
+ command = make_simple_command(:post, 'v2beta/{+placement}:conversationalSearch', options)
2342
+ command.request_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchRequest::Representation
2343
+ command.request_object = google_cloud_retail_v2beta_conversational_search_request_object
2344
+ command.response_representation = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponse::Representation
2345
+ command.response_class = Google::Apis::RetailV2beta::GoogleCloudRetailV2betaConversationalSearchResponse
2346
+ command.params['placement'] = placement unless placement.nil?
2347
+ command.query['fields'] = fields unless fields.nil?
2348
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
2349
+ execute_or_queue_command(command, &block)
2350
+ end
2351
+
2276
2352
  # Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a
2277
2353
  # Catalog, otherwise a FAILED_PRECONDITION error is returned.
2278
2354
  # @param [String] parent
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.117.0
4
+ version: 0.119.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.117.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2beta/v0.119.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: