google-cloud-retail-v2 0.9.0 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/retail/v2/completion_service/client.rb +3 -0
- data/lib/google/cloud/retail/v2/prediction_service/client.rb +28 -13
- data/lib/google/cloud/retail/v2/prediction_service_pb.rb +1 -0
- data/lib/google/cloud/retail/v2/product_service/client.rb +45 -30
- data/lib/google/cloud/retail/v2/product_service_services_pb.rb +32 -23
- data/lib/google/cloud/retail/v2/search_service/client.rb +3 -1
- data/lib/google/cloud/retail/v2/search_service_pb.rb +4 -0
- data/lib/google/cloud/retail/v2/version.rb +1 -1
- data/proto_docs/google/cloud/retail/v2/completion_service.rb +7 -3
- data/proto_docs/google/cloud/retail/v2/prediction_service.rb +27 -12
- data/proto_docs/google/cloud/retail/v2/product_service.rb +49 -21
- data/proto_docs/google/cloud/retail/v2/search_service.rb +43 -11
- data/proto_docs/google/protobuf/empty.rb +0 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4d1c1b9f050a34949ddbbf2216e42a2fcede56547eb053e243c0f4b398798951
|
4
|
+
data.tar.gz: d5748a0e343c717fb44675eb87e4d80ae5afba3e6a222250eca1fc1303d33dea
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 910e5dc16ed89bd22106fe89d5a48baac5fc4d8d9cc8204485a36adc00effcf1c47702de41b457d3ff89cc2c0b609cb7882389800ee8a6e208caa6699b5851bb
|
7
|
+
data.tar.gz: fa5329eb5145faf2d00bd0117077d8bd297d05bfd98f429302202470b89693ed0813bcbcfe1d871842de50f403ab35524db49bf80a065f558fddb3859314a2d9
|
@@ -204,6 +204,9 @@ module Google
|
|
204
204
|
# The field must be a UTF-8 encoded string with a length limit of 128
|
205
205
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
206
206
|
# @param language_codes [::Array<::String>]
|
207
|
+
# Note that this field applies for `user-data` dataset only. For requests
|
208
|
+
# with `cloud-retail` dataset, setting this field has no effect.
|
209
|
+
#
|
207
210
|
# The language filters applied to the output suggestions. If set, it should
|
208
211
|
# contain the language of the query. If not set, suggestions are returned
|
209
212
|
# without considering language restrictions. This is the BCP-47 language
|
@@ -169,14 +169,19 @@ module Google
|
|
169
169
|
#
|
170
170
|
# @param placement [::String]
|
171
171
|
# Required. Full resource name of the format:
|
172
|
-
#
|
173
|
-
#
|
174
|
-
#
|
175
|
-
#
|
176
|
-
#
|
177
|
-
#
|
178
|
-
#
|
179
|
-
#
|
172
|
+
# `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}`
|
173
|
+
# or
|
174
|
+
# `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`.
|
175
|
+
# We recommend using the `servingConfigs` resource. `placements` is a legacy
|
176
|
+
# resource.
|
177
|
+
# The ID of the Recommendations AI serving config or placement.
|
178
|
+
# Before you can request predictions from your model, you must create at
|
179
|
+
# least one serving config or placement for it. For more information, see
|
180
|
+
# [Managing serving configurations]
|
181
|
+
# (https://cloud.google.com/retail/docs/manage-configs).
|
182
|
+
#
|
183
|
+
# The full list of available serving configs can be seen at
|
184
|
+
# https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
|
180
185
|
# @param user_event [::Google::Cloud::Retail::V2::UserEvent, ::Hash]
|
181
186
|
# Required. Context about the user, what they are looking at and what action
|
182
187
|
# they took to trigger the predict request. Note that this user event detail
|
@@ -193,12 +198,12 @@ module Google
|
|
193
198
|
# random unique ID and leave
|
194
199
|
# {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} unset.
|
195
200
|
# @param page_size [::Integer]
|
196
|
-
# Maximum number of results to return
|
197
|
-
#
|
198
|
-
#
|
199
|
-
#
|
201
|
+
# Maximum number of results to return. Set this property to the number of
|
202
|
+
# prediction results needed. If zero, the service will choose a reasonable
|
203
|
+
# default. The maximum allowed value is 100. Values above 100 will be coerced
|
204
|
+
# to 100.
|
200
205
|
# @param page_token [::String]
|
201
|
-
#
|
206
|
+
# This field is not used; leave it unset.
|
202
207
|
# @param filter [::String]
|
203
208
|
# Filter for restricting prediction results with a length limit of 5,000
|
204
209
|
# characters. Accepts values for tags and the `filterOutOfStockItems` flag.
|
@@ -229,6 +234,14 @@ module Google
|
|
229
234
|
# receive empty results instead.
|
230
235
|
# Note that the API will never return items with storageStatus of "EXPIRED"
|
231
236
|
# or "DELETED" regardless of filter choices.
|
237
|
+
#
|
238
|
+
# If `filterSyntaxV2` is set to true under the `params` field, then
|
239
|
+
# attribute-based expressions are expected instead of the above described
|
240
|
+
# tag-based syntax. Examples:
|
241
|
+
#
|
242
|
+
# * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
|
243
|
+
# * (availability: ANY("IN_STOCK")) AND
|
244
|
+
# (colors: ANY("Red") OR categories: ANY("Phones"))
|
232
245
|
# @param validate_only [::Boolean]
|
233
246
|
# Use validate only mode for this prediction query. If set to true, a
|
234
247
|
# dummy model will be used that returns arbitrary products.
|
@@ -260,6 +273,8 @@ module Google
|
|
260
273
|
# 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
|
261
274
|
# request-level control and adjusts prediction results based on product
|
262
275
|
# category.
|
276
|
+
# * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
|
277
|
+
# field is interpreteted according to the new, attribute-based syntax.
|
263
278
|
# @param labels [::Hash{::String => ::String}]
|
264
279
|
# The labels applied to a resource must meet the following requirements:
|
265
280
|
#
|
@@ -889,18 +889,21 @@ module Google
|
|
889
889
|
# enqueued and processed downstream. As a consequence, when a response is
|
890
890
|
# returned, updates are not immediately manifested in the
|
891
891
|
# {::Google::Cloud::Retail::V2::Product Product} queried by
|
892
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct}
|
893
|
-
#
|
892
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
893
|
+
# or
|
894
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
894
895
|
#
|
895
896
|
# When inventory is updated with
|
896
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct}
|
897
|
-
#
|
898
|
-
#
|
897
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
|
898
|
+
# and
|
899
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct},
|
900
|
+
# the specified inventory field value(s) will overwrite any existing value(s)
|
899
901
|
# while ignoring the last update time for this field. Furthermore, the last
|
900
902
|
# update time for the specified inventory fields will be overwritten to the
|
901
903
|
# time of the
|
902
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct}
|
903
|
-
#
|
904
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
|
905
|
+
# or
|
906
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
|
904
907
|
# request.
|
905
908
|
#
|
906
909
|
# If no inventory fields are set in
|
@@ -912,10 +915,10 @@ module Google
|
|
912
915
|
# then any existing inventory information will be preserved.
|
913
916
|
#
|
914
917
|
# Pre-existing inventory information can only be updated with
|
915
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory SetInventory},
|
918
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory},
|
916
919
|
# {::Google::Cloud::Retail::V2::ProductService::Client#add_fulfillment_places ProductService.AddFulfillmentPlaces},
|
917
920
|
# and
|
918
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places RemoveFulfillmentPlaces}.
|
921
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}.
|
919
922
|
#
|
920
923
|
# This feature is only available for users who have Retail Search enabled.
|
921
924
|
# Please enable Retail Search on Cloud Console before using this feature.
|
@@ -938,6 +941,7 @@ module Google
|
|
938
941
|
# @param inventory [::Google::Cloud::Retail::V2::Product, ::Hash]
|
939
942
|
# Required. The inventory information to update. The allowable fields to
|
940
943
|
# update are:
|
944
|
+
#
|
941
945
|
# * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
|
942
946
|
# * {::Google::Cloud::Retail::V2::Product#availability Product.availability}
|
943
947
|
# * {::Google::Cloud::Retail::V2::Product#available_quantity Product.available_quantity}
|
@@ -945,8 +949,9 @@ module Google
|
|
945
949
|
# The updated inventory fields must be specified in
|
946
950
|
# {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}.
|
947
951
|
#
|
948
|
-
# If
|
949
|
-
#
|
952
|
+
# If
|
953
|
+
# {::Google::Cloud::Retail::V2::Product#name SetInventoryRequest.inventory.name}
|
954
|
+
# is empty or invalid, an INVALID_ARGUMENT error is returned.
|
950
955
|
#
|
951
956
|
# If the caller does not have permission to update the
|
952
957
|
# {::Google::Cloud::Retail::V2::Product Product} named in
|
@@ -969,7 +974,8 @@ module Google
|
|
969
974
|
# * Adds "fulfillment_info" in
|
970
975
|
# {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
|
971
976
|
# * Specifies only the desired fulfillment types and corresponding place IDs
|
972
|
-
# to update in
|
977
|
+
# to update in
|
978
|
+
# {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
|
973
979
|
#
|
974
980
|
# The caller can clear all place IDs from a subset of fulfillment types in
|
975
981
|
# the following ways:
|
@@ -977,9 +983,9 @@ module Google
|
|
977
983
|
# * Adds "fulfillment_info" in
|
978
984
|
# {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
|
979
985
|
# * Specifies only the desired fulfillment types to clear in
|
980
|
-
#
|
986
|
+
# {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
|
981
987
|
# * Checks that only the desired fulfillment info types have empty
|
982
|
-
#
|
988
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids SetInventoryRequest.inventory.fulfillment_info.place_ids}
|
983
989
|
#
|
984
990
|
# The last update time is recorded for the following inventory fields:
|
985
991
|
# * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
|
@@ -988,7 +994,9 @@ module Google
|
|
988
994
|
# * {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info}
|
989
995
|
#
|
990
996
|
# If a full overwrite of inventory information while ignoring timestamps is
|
991
|
-
# needed,
|
997
|
+
# needed,
|
998
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
|
999
|
+
# should be invoked instead.
|
992
1000
|
# @param set_mask [::Google::Protobuf::FieldMask, ::Hash]
|
993
1001
|
# Indicates which inventory fields in the provided
|
994
1002
|
# {::Google::Cloud::Retail::V2::Product Product} to update.
|
@@ -1091,8 +1099,9 @@ module Google
|
|
1091
1099
|
# enqueued and processed downstream. As a consequence, when a response is
|
1092
1100
|
# returned, the added place IDs are not immediately manifested in the
|
1093
1101
|
# {::Google::Cloud::Retail::V2::Product Product} queried by
|
1094
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct}
|
1095
|
-
#
|
1102
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
1103
|
+
# or
|
1104
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
1096
1105
|
#
|
1097
1106
|
# This feature is only available for users who have Retail Search enabled.
|
1098
1107
|
# Please enable Retail Search on Cloud Console before using this feature.
|
@@ -1139,7 +1148,8 @@ module Google
|
|
1139
1148
|
# If this field is set to an invalid value other than these, an
|
1140
1149
|
# INVALID_ARGUMENT error is returned.
|
1141
1150
|
#
|
1142
|
-
# This field directly corresponds to
|
1151
|
+
# This field directly corresponds to
|
1152
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#type Product.fulfillment_info.type}.
|
1143
1153
|
# @param place_ids [::Array<::String>]
|
1144
1154
|
# Required. The IDs for this
|
1145
1155
|
# {::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest#type type}, such as
|
@@ -1250,8 +1260,9 @@ module Google
|
|
1250
1260
|
# enqueued and processed downstream. As a consequence, when a response is
|
1251
1261
|
# returned, the removed place IDs are not immediately manifested in the
|
1252
1262
|
# {::Google::Cloud::Retail::V2::Product Product} queried by
|
1253
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct}
|
1254
|
-
#
|
1263
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
1264
|
+
# or
|
1265
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
1255
1266
|
#
|
1256
1267
|
# This feature is only available for users who have Retail Search enabled.
|
1257
1268
|
# Please enable Retail Search on Cloud Console before using this feature.
|
@@ -1406,13 +1417,15 @@ module Google
|
|
1406
1417
|
# and processed downstream. As a consequence, when a response is returned,
|
1407
1418
|
# updates are not immediately manifested in the
|
1408
1419
|
# {::Google::Cloud::Retail::V2::Product Product} queried by
|
1409
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct}
|
1410
|
-
#
|
1420
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
1421
|
+
# or
|
1422
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
1411
1423
|
#
|
1412
1424
|
# Local inventory information can only be modified using this method.
|
1413
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct}
|
1414
|
-
#
|
1415
|
-
#
|
1425
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
|
1426
|
+
# and
|
1427
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
|
1428
|
+
# has no effect on local inventories.
|
1416
1429
|
#
|
1417
1430
|
# This feature is only available for users who have Retail Search enabled.
|
1418
1431
|
# Please enable Retail Search on Cloud Console before using this feature.
|
@@ -1552,13 +1565,15 @@ module Google
|
|
1552
1565
|
# enqueued and processed downstream. As a consequence, when a response is
|
1553
1566
|
# returned, removals are not immediately manifested in the
|
1554
1567
|
# {::Google::Cloud::Retail::V2::Product Product} queried by
|
1555
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product GetProduct}
|
1556
|
-
#
|
1568
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
1569
|
+
# or
|
1570
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
|
1557
1571
|
#
|
1558
1572
|
# Local inventory information can only be removed using this method.
|
1559
|
-
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product CreateProduct}
|
1560
|
-
#
|
1561
|
-
#
|
1573
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
|
1574
|
+
# and
|
1575
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
|
1576
|
+
# has no effect on local inventories.
|
1562
1577
|
#
|
1563
1578
|
# This feature is only available for users who have Retail Search enabled.
|
1564
1579
|
# Please enable Retail Search on Cloud Console before using this feature.
|
@@ -62,18 +62,21 @@ module Google
|
|
62
62
|
# enqueued and processed downstream. As a consequence, when a response is
|
63
63
|
# returned, updates are not immediately manifested in the
|
64
64
|
# [Product][google.cloud.retail.v2.Product] queried by
|
65
|
-
# [GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
|
66
|
-
#
|
65
|
+
# [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
|
66
|
+
# or
|
67
|
+
# [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
|
67
68
|
#
|
68
69
|
# When inventory is updated with
|
69
|
-
# [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
|
70
|
-
#
|
71
|
-
#
|
70
|
+
# [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
|
71
|
+
# and
|
72
|
+
# [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct],
|
73
|
+
# the specified inventory field value(s) will overwrite any existing value(s)
|
72
74
|
# while ignoring the last update time for this field. Furthermore, the last
|
73
75
|
# update time for the specified inventory fields will be overwritten to the
|
74
76
|
# time of the
|
75
|
-
# [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
|
76
|
-
#
|
77
|
+
# [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
|
78
|
+
# or
|
79
|
+
# [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
|
77
80
|
# request.
|
78
81
|
#
|
79
82
|
# If no inventory fields are set in
|
@@ -85,10 +88,10 @@ module Google
|
|
85
88
|
# then any existing inventory information will be preserved.
|
86
89
|
#
|
87
90
|
# Pre-existing inventory information can only be updated with
|
88
|
-
# [SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
|
91
|
+
# [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
|
89
92
|
# [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces],
|
90
93
|
# and
|
91
|
-
# [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
|
94
|
+
# [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
|
92
95
|
#
|
93
96
|
# This feature is only available for users who have Retail Search enabled.
|
94
97
|
# Please enable Retail Search on Cloud Console before using this feature.
|
@@ -102,8 +105,9 @@ module Google
|
|
102
105
|
# enqueued and processed downstream. As a consequence, when a response is
|
103
106
|
# returned, the added place IDs are not immediately manifested in the
|
104
107
|
# [Product][google.cloud.retail.v2.Product] queried by
|
105
|
-
# [GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
|
106
|
-
#
|
108
|
+
# [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
|
109
|
+
# or
|
110
|
+
# [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
|
107
111
|
#
|
108
112
|
# This feature is only available for users who have Retail Search enabled.
|
109
113
|
# Please enable Retail Search on Cloud Console before using this feature.
|
@@ -117,8 +121,9 @@ module Google
|
|
117
121
|
# enqueued and processed downstream. As a consequence, when a response is
|
118
122
|
# returned, the removed place IDs are not immediately manifested in the
|
119
123
|
# [Product][google.cloud.retail.v2.Product] queried by
|
120
|
-
# [GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
|
121
|
-
#
|
124
|
+
# [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
|
125
|
+
# or
|
126
|
+
# [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
|
122
127
|
#
|
123
128
|
# This feature is only available for users who have Retail Search enabled.
|
124
129
|
# Please enable Retail Search on Cloud Console before using this feature.
|
@@ -133,13 +138,15 @@ module Google
|
|
133
138
|
# and processed downstream. As a consequence, when a response is returned,
|
134
139
|
# updates are not immediately manifested in the
|
135
140
|
# [Product][google.cloud.retail.v2.Product] queried by
|
136
|
-
# [GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
|
137
|
-
#
|
141
|
+
# [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
|
142
|
+
# or
|
143
|
+
# [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
|
138
144
|
#
|
139
145
|
# Local inventory information can only be modified using this method.
|
140
|
-
# [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
|
141
|
-
#
|
142
|
-
#
|
146
|
+
# [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
|
147
|
+
# and
|
148
|
+
# [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
|
149
|
+
# has no effect on local inventories.
|
143
150
|
#
|
144
151
|
# This feature is only available for users who have Retail Search enabled.
|
145
152
|
# Please enable Retail Search on Cloud Console before using this feature.
|
@@ -152,13 +159,15 @@ module Google
|
|
152
159
|
# enqueued and processed downstream. As a consequence, when a response is
|
153
160
|
# returned, removals are not immediately manifested in the
|
154
161
|
# [Product][google.cloud.retail.v2.Product] queried by
|
155
|
-
# [GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
|
156
|
-
#
|
162
|
+
# [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
|
163
|
+
# or
|
164
|
+
# [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
|
157
165
|
#
|
158
166
|
# Local inventory information can only be removed using this method.
|
159
|
-
# [CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
|
160
|
-
#
|
161
|
-
#
|
167
|
+
# [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
|
168
|
+
# and
|
169
|
+
# [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
|
170
|
+
# has no effect on local inventories.
|
162
171
|
#
|
163
172
|
# This feature is only available for users who have Retail Search enabled.
|
164
173
|
# Please enable Retail Search on Cloud Console before using this feature.
|
@@ -174,7 +174,9 @@ module Google
|
|
174
174
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
175
175
|
#
|
176
176
|
# @param placement [::String]
|
177
|
-
# Required. The resource name of the
|
177
|
+
# Required. The resource name of the Retail Search serving config, such as
|
178
|
+
# `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
|
179
|
+
# or the name of the legacy placement resource, such as
|
178
180
|
# `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
|
179
181
|
# This field is used to identify the serving configuration name and the set
|
180
182
|
# of models that will be used to make the search.
|
@@ -49,8 +49,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
49
49
|
repeated :restricted_values, :string, 3
|
50
50
|
repeated :prefixes, :string, 8
|
51
51
|
repeated :contains, :string, 9
|
52
|
+
optional :case_insensitive, :bool, 10
|
52
53
|
optional :order_by, :string, 4
|
53
54
|
optional :query, :string, 5
|
55
|
+
optional :return_min_max, :bool, 11
|
54
56
|
end
|
55
57
|
add_message "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec" do
|
56
58
|
optional :mode, :enum, 1, "google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode"
|
@@ -124,6 +126,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
124
126
|
end
|
125
127
|
add_message "google.cloud.retail.v2.SearchResponse.Facet.FacetValue" do
|
126
128
|
optional :count, :int64, 3
|
129
|
+
optional :min_value, :double, 5
|
130
|
+
optional :max_value, :double, 6
|
127
131
|
oneof :facet_value do
|
128
132
|
optional :value, :string, 1
|
129
133
|
optional :interval, :message, 2, "google.cloud.retail.v2.Interval"
|
@@ -44,6 +44,9 @@ module Google
|
|
44
44
|
# characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
45
45
|
# @!attribute [rw] language_codes
|
46
46
|
# @return [::Array<::String>]
|
47
|
+
# Note that this field applies for `user-data` dataset only. For requests
|
48
|
+
# with `cloud-retail` dataset, setting this field has no effect.
|
49
|
+
#
|
47
50
|
# The language filters applied to the output suggestions. If set, it should
|
48
51
|
# contain the language of the query. If not set, suggestions are returned
|
49
52
|
# without considering language restrictions. This is the BCP-47 language
|
@@ -121,7 +124,7 @@ module Google
|
|
121
124
|
# {::Google::Cloud::Retail::V2::CompleteQueryRequest#query CompleteQueryRequest.query}
|
122
125
|
# case insensitively.
|
123
126
|
#
|
124
|
-
# * They are transformed to lower
|
127
|
+
# * They are transformed to lower case.
|
125
128
|
#
|
126
129
|
# * They are UTF-8 safe.
|
127
130
|
#
|
@@ -143,8 +146,9 @@ module Google
|
|
143
146
|
# ingested through BigQuery.
|
144
147
|
#
|
145
148
|
# * For "cloud-retail", the attributes are product attributes generated
|
146
|
-
# by Cloud Retail.
|
147
|
-
#
|
149
|
+
# by Cloud Retail. It requires
|
150
|
+
# {::Google::Cloud::Retail::V2::UserEvent#product_details UserEvent.product_details}
|
151
|
+
# is imported properly.
|
148
152
|
class CompletionResult
|
149
153
|
include ::Google::Protobuf::MessageExts
|
150
154
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -25,14 +25,19 @@ module Google
|
|
25
25
|
# @!attribute [rw] placement
|
26
26
|
# @return [::String]
|
27
27
|
# Required. Full resource name of the format:
|
28
|
-
#
|
29
|
-
#
|
30
|
-
#
|
31
|
-
#
|
32
|
-
#
|
28
|
+
# `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}`
|
29
|
+
# or
|
30
|
+
# `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`.
|
31
|
+
# We recommend using the `servingConfigs` resource. `placements` is a legacy
|
32
|
+
# resource.
|
33
|
+
# The ID of the Recommendations AI serving config or placement.
|
34
|
+
# Before you can request predictions from your model, you must create at
|
35
|
+
# least one serving config or placement for it. For more information, see
|
36
|
+
# [Managing serving configurations]
|
37
|
+
# (https://cloud.google.com/retail/docs/manage-configs).
|
33
38
|
#
|
34
|
-
# The full list of available
|
35
|
-
# https://console.cloud.google.com/
|
39
|
+
# The full list of available serving configs can be seen at
|
40
|
+
# https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
|
36
41
|
# @!attribute [rw] user_event
|
37
42
|
# @return [::Google::Cloud::Retail::V2::UserEvent]
|
38
43
|
# Required. Context about the user, what they are looking at and what action
|
@@ -51,13 +56,13 @@ module Google
|
|
51
56
|
# {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} unset.
|
52
57
|
# @!attribute [rw] page_size
|
53
58
|
# @return [::Integer]
|
54
|
-
# Maximum number of results to return
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
59
|
+
# Maximum number of results to return. Set this property to the number of
|
60
|
+
# prediction results needed. If zero, the service will choose a reasonable
|
61
|
+
# default. The maximum allowed value is 100. Values above 100 will be coerced
|
62
|
+
# to 100.
|
58
63
|
# @!attribute [rw] page_token
|
59
64
|
# @return [::String]
|
60
|
-
#
|
65
|
+
# This field is not used; leave it unset.
|
61
66
|
# @!attribute [rw] filter
|
62
67
|
# @return [::String]
|
63
68
|
# Filter for restricting prediction results with a length limit of 5,000
|
@@ -89,6 +94,14 @@ module Google
|
|
89
94
|
# receive empty results instead.
|
90
95
|
# Note that the API will never return items with storageStatus of "EXPIRED"
|
91
96
|
# or "DELETED" regardless of filter choices.
|
97
|
+
#
|
98
|
+
# If `filterSyntaxV2` is set to true under the `params` field, then
|
99
|
+
# attribute-based expressions are expected instead of the above described
|
100
|
+
# tag-based syntax. Examples:
|
101
|
+
#
|
102
|
+
# * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
|
103
|
+
# * (availability: ANY("IN_STOCK")) AND
|
104
|
+
# (colors: ANY("Red") OR categories: ANY("Phones"))
|
92
105
|
# @!attribute [rw] validate_only
|
93
106
|
# @return [::Boolean]
|
94
107
|
# Use validate only mode for this prediction query. If set to true, a
|
@@ -122,6 +135,8 @@ module Google
|
|
122
135
|
# 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
|
123
136
|
# request-level control and adjusts prediction results based on product
|
124
137
|
# category.
|
138
|
+
# * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
|
139
|
+
# field is interpreteted according to the new, attribute-based syntax.
|
125
140
|
# @!attribute [rw] labels
|
126
141
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
127
142
|
# The labels applied to a resource must meet the following requirements:
|
@@ -21,7 +21,9 @@ module Google
|
|
21
21
|
module Cloud
|
22
22
|
module Retail
|
23
23
|
module V2
|
24
|
-
# Request message for
|
24
|
+
# Request message for
|
25
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
|
26
|
+
# method.
|
25
27
|
# @!attribute [rw] parent
|
26
28
|
# @return [::String]
|
27
29
|
# Required. The parent catalog resource name, such as
|
@@ -51,7 +53,9 @@ module Google
|
|
51
53
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
52
54
|
end
|
53
55
|
|
54
|
-
# Request message for
|
56
|
+
# Request message for
|
57
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
|
58
|
+
# method.
|
55
59
|
# @!attribute [rw] name
|
56
60
|
# @return [::String]
|
57
61
|
# Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
|
@@ -69,7 +73,9 @@ module Google
|
|
69
73
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
70
74
|
end
|
71
75
|
|
72
|
-
# Request message for
|
76
|
+
# Request message for
|
77
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
|
78
|
+
# method.
|
73
79
|
# @!attribute [rw] product
|
74
80
|
# @return [::Google::Cloud::Retail::V2::Product]
|
75
81
|
# Required. The product to update/create.
|
@@ -106,7 +112,9 @@ module Google
|
|
106
112
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
107
113
|
end
|
108
114
|
|
109
|
-
# Request message for
|
115
|
+
# Request message for
|
116
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#delete_product ProductService.DeleteProduct}
|
117
|
+
# method.
|
110
118
|
# @!attribute [rw] name
|
111
119
|
# @return [::String]
|
112
120
|
# Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
|
@@ -238,11 +246,14 @@ module Google
|
|
238
246
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
239
247
|
end
|
240
248
|
|
241
|
-
# Request message for
|
249
|
+
# Request message for
|
250
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory}
|
251
|
+
# method.
|
242
252
|
# @!attribute [rw] inventory
|
243
253
|
# @return [::Google::Cloud::Retail::V2::Product]
|
244
254
|
# Required. The inventory information to update. The allowable fields to
|
245
255
|
# update are:
|
256
|
+
#
|
246
257
|
# * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
|
247
258
|
# * {::Google::Cloud::Retail::V2::Product#availability Product.availability}
|
248
259
|
# * {::Google::Cloud::Retail::V2::Product#available_quantity Product.available_quantity}
|
@@ -250,8 +261,9 @@ module Google
|
|
250
261
|
# The updated inventory fields must be specified in
|
251
262
|
# {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}.
|
252
263
|
#
|
253
|
-
# If
|
254
|
-
#
|
264
|
+
# If
|
265
|
+
# {::Google::Cloud::Retail::V2::Product#name SetInventoryRequest.inventory.name}
|
266
|
+
# is empty or invalid, an INVALID_ARGUMENT error is returned.
|
255
267
|
#
|
256
268
|
# If the caller does not have permission to update the
|
257
269
|
# {::Google::Cloud::Retail::V2::Product Product} named in
|
@@ -274,7 +286,8 @@ module Google
|
|
274
286
|
# * Adds "fulfillment_info" in
|
275
287
|
# {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
|
276
288
|
# * Specifies only the desired fulfillment types and corresponding place IDs
|
277
|
-
# to update in
|
289
|
+
# to update in
|
290
|
+
# {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
|
278
291
|
#
|
279
292
|
# The caller can clear all place IDs from a subset of fulfillment types in
|
280
293
|
# the following ways:
|
@@ -282,9 +295,9 @@ module Google
|
|
282
295
|
# * Adds "fulfillment_info" in
|
283
296
|
# {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask}
|
284
297
|
# * Specifies only the desired fulfillment types to clear in
|
285
|
-
#
|
298
|
+
# {::Google::Cloud::Retail::V2::Product#fulfillment_info SetInventoryRequest.inventory.fulfillment_info}
|
286
299
|
# * Checks that only the desired fulfillment info types have empty
|
287
|
-
#
|
300
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids SetInventoryRequest.inventory.fulfillment_info.place_ids}
|
288
301
|
#
|
289
302
|
# The last update time is recorded for the following inventory fields:
|
290
303
|
# * {::Google::Cloud::Retail::V2::Product#price_info Product.price_info}
|
@@ -293,7 +306,9 @@ module Google
|
|
293
306
|
# * {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info}
|
294
307
|
#
|
295
308
|
# If a full overwrite of inventory information while ignoring timestamps is
|
296
|
-
# needed,
|
309
|
+
# needed,
|
310
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
|
311
|
+
# should be invoked instead.
|
297
312
|
# @!attribute [rw] set_mask
|
298
313
|
# @return [::Google::Protobuf::FieldMask]
|
299
314
|
# Indicates which inventory fields in the provided
|
@@ -323,14 +338,16 @@ module Google
|
|
323
338
|
|
324
339
|
# Metadata related to the progress of the SetInventory operation.
|
325
340
|
# Currently empty because there is no meaningful metadata populated from the
|
326
|
-
#
|
341
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory}
|
342
|
+
# method.
|
327
343
|
class SetInventoryMetadata
|
328
344
|
include ::Google::Protobuf::MessageExts
|
329
345
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
330
346
|
end
|
331
347
|
|
332
348
|
# Response of the SetInventoryRequest. Currently empty because
|
333
|
-
# there is no meaningful response populated from the
|
349
|
+
# there is no meaningful response populated from the
|
350
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory}
|
334
351
|
# method.
|
335
352
|
class SetInventoryResponse
|
336
353
|
include ::Google::Protobuf::MessageExts
|
@@ -369,7 +386,8 @@ module Google
|
|
369
386
|
# If this field is set to an invalid value other than these, an
|
370
387
|
# INVALID_ARGUMENT error is returned.
|
371
388
|
#
|
372
|
-
# This field directly corresponds to
|
389
|
+
# This field directly corresponds to
|
390
|
+
# {::Google::Cloud::Retail::V2::FulfillmentInfo#type Product.fulfillment_info.type}.
|
373
391
|
# @!attribute [rw] place_ids
|
374
392
|
# @return [::Array<::String>]
|
375
393
|
# Required. The IDs for this
|
@@ -494,7 +512,9 @@ module Google
|
|
494
512
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
495
513
|
end
|
496
514
|
|
497
|
-
# Request message for
|
515
|
+
# Request message for
|
516
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
|
517
|
+
# method.
|
498
518
|
# @!attribute [rw] product
|
499
519
|
# @return [::String]
|
500
520
|
# Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
|
@@ -528,21 +548,27 @@ module Google
|
|
528
548
|
|
529
549
|
# Metadata related to the progress of the RemoveLocalInventories operation.
|
530
550
|
# Currently empty because there is no meaningful metadata populated from the
|
531
|
-
#
|
551
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
|
552
|
+
# method.
|
532
553
|
class RemoveLocalInventoriesMetadata
|
533
554
|
include ::Google::Protobuf::MessageExts
|
534
555
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
535
556
|
end
|
536
557
|
|
537
|
-
# Response of the
|
538
|
-
#
|
558
|
+
# Response of the
|
559
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
|
560
|
+
# API. Currently empty because there is no meaningful response populated from
|
561
|
+
# the
|
562
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
|
539
563
|
# method.
|
540
564
|
class RemoveLocalInventoriesResponse
|
541
565
|
include ::Google::Protobuf::MessageExts
|
542
566
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
543
567
|
end
|
544
568
|
|
545
|
-
# Request message for
|
569
|
+
# Request message for
|
570
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}
|
571
|
+
# method.
|
546
572
|
# @!attribute [rw] product
|
547
573
|
# @return [::String]
|
548
574
|
# Required. Full resource name of {::Google::Cloud::Retail::V2::Product Product},
|
@@ -606,14 +632,16 @@ module Google
|
|
606
632
|
|
607
633
|
# Metadata related to the progress of the RemoveFulfillmentPlaces operation.
|
608
634
|
# Currently empty because there is no meaningful metadata populated from the
|
609
|
-
#
|
635
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}
|
636
|
+
# method.
|
610
637
|
class RemoveFulfillmentPlacesMetadata
|
611
638
|
include ::Google::Protobuf::MessageExts
|
612
639
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
613
640
|
end
|
614
641
|
|
615
642
|
# Response of the RemoveFulfillmentPlacesRequest. Currently empty because there
|
616
|
-
# is no meaningful response populated from the
|
643
|
+
# is no meaningful response populated from the
|
644
|
+
# {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}
|
617
645
|
# method.
|
618
646
|
class RemoveFulfillmentPlacesResponse
|
619
647
|
include ::Google::Protobuf::MessageExts
|
@@ -25,7 +25,9 @@ module Google
|
|
25
25
|
# {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search} method.
|
26
26
|
# @!attribute [rw] placement
|
27
27
|
# @return [::String]
|
28
|
-
# Required. The resource name of the
|
28
|
+
# Required. The resource name of the Retail Search serving config, such as
|
29
|
+
# `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
|
30
|
+
# or the name of the legacy placement resource, such as
|
29
31
|
# `projects/*/locations/global/catalogs/default_catalog/placements/default_search`.
|
30
32
|
# This field is used to identify the serving configuration name and the set
|
31
33
|
# of models that will be used to make the search.
|
@@ -431,16 +433,24 @@ module Google
|
|
431
433
|
# "Women > Dress" and "Men > Shoe". If set "contains" to "Shoe", the
|
432
434
|
# "categories" facet will give only "Women > Shoe" and "Men > Shoe".
|
433
435
|
# Only supported on textual fields. Maximum is 10.
|
436
|
+
# @!attribute [rw] case_insensitive
|
437
|
+
# @return [::Boolean]
|
438
|
+
# True to make facet keys case insensitive when getting faceting
|
439
|
+
# values with prefixes or contains; false otherwise.
|
434
440
|
# @!attribute [rw] order_by
|
435
441
|
# @return [::String]
|
436
|
-
# The order in which
|
442
|
+
# The order in which
|
443
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::Facet#values SearchResponse.Facet.values}
|
444
|
+
# are returned.
|
437
445
|
#
|
438
446
|
# Allowed values are:
|
439
447
|
#
|
440
|
-
# * "count desc", which means order by
|
448
|
+
# * "count desc", which means order by
|
449
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
|
441
450
|
# descending.
|
442
451
|
#
|
443
|
-
# * "value desc", which means order by
|
452
|
+
# * "value desc", which means order by
|
453
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
|
444
454
|
# descending.
|
445
455
|
# Only applies to textual facets.
|
446
456
|
#
|
@@ -461,9 +471,11 @@ module Google
|
|
461
471
|
# {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#key FacetKey.key}
|
462
472
|
# when query is specified.
|
463
473
|
#
|
464
|
-
# In the response,
|
465
|
-
#
|
466
|
-
#
|
474
|
+
# In the response,
|
475
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#value SearchResponse.Facet.values.value}
|
476
|
+
# will be always "1" and
|
477
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#count SearchResponse.Facet.values.count}
|
478
|
+
# will be the number of results that match the query.
|
467
479
|
#
|
468
480
|
# For example, you can set a customized facet for "shipToStore",
|
469
481
|
# where
|
@@ -473,6 +485,10 @@ module Google
|
|
473
485
|
# is "availability: ANY(\"IN_STOCK\") AND shipToStore: ANY(\"123\")".
|
474
486
|
# Then the facet will count the products that are both in stock and ship
|
475
487
|
# to store "123".
|
488
|
+
# @!attribute [rw] return_min_max
|
489
|
+
# @return [::Boolean]
|
490
|
+
# Returns the min and max value for each numerical facet intervals.
|
491
|
+
# Ignored for textual facets.
|
476
492
|
class FacetKey
|
477
493
|
include ::Google::Protobuf::MessageExts
|
478
494
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -579,7 +595,8 @@ module Google
|
|
579
595
|
|
580
596
|
# Enum describing under which condition query expansion should occur.
|
581
597
|
module Condition
|
582
|
-
# Unspecified query expansion condition.
|
598
|
+
# Unspecified query expansion condition. In this case, server behavior
|
599
|
+
# defaults to
|
583
600
|
# {::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec::Condition::DISABLED Condition.DISABLED}.
|
584
601
|
CONDITION_UNSPECIFIED = 0
|
585
602
|
|
@@ -604,7 +621,7 @@ module Google
|
|
604
621
|
|
605
622
|
# The personalization mode of each search request.
|
606
623
|
module Mode
|
607
|
-
# Default value.
|
624
|
+
# Default value. In this case, server behavior defaults to
|
608
625
|
# {::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec::Mode::AUTO Mode.AUTO}.
|
609
626
|
MODE_UNSPECIFIED = 0
|
610
627
|
|
@@ -628,7 +645,8 @@ module Google
|
|
628
645
|
|
629
646
|
# Enum describing under which mode spell correction should occur.
|
630
647
|
module Mode
|
631
|
-
# Unspecified spell correction mode.
|
648
|
+
# Unspecified spell correction mode. In this case, server behavior
|
649
|
+
# defaults to
|
632
650
|
# {::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
|
633
651
|
MODE_UNSPECIFIED = 0
|
634
652
|
|
@@ -704,7 +722,7 @@ module Google
|
|
704
722
|
# @return [::String]
|
705
723
|
# Contains the spell corrected query, if found. If the spell correction type
|
706
724
|
# is AUTOMATIC, then the search results are based on corrected_query.
|
707
|
-
# Otherwise the original query
|
725
|
+
# Otherwise the original query is used for search.
|
708
726
|
# @!attribute [rw] attribution_token
|
709
727
|
# @return [::String]
|
710
728
|
# A unique search token. This should be included in the
|
@@ -859,6 +877,20 @@ module Google
|
|
859
877
|
# @!attribute [rw] count
|
860
878
|
# @return [::Integer]
|
861
879
|
# Number of items that have this facet value.
|
880
|
+
# @!attribute [rw] min_value
|
881
|
+
# @return [::Float]
|
882
|
+
# The minimum value in the
|
883
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#interval FacetValue.interval}.
|
884
|
+
# Only supported on numerical facets and returned if
|
885
|
+
# {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#return_min_max SearchRequest.FacetSpec.FacetKey.return_min_max}
|
886
|
+
# is true.
|
887
|
+
# @!attribute [rw] max_value
|
888
|
+
# @return [::Float]
|
889
|
+
# The maximum value in the
|
890
|
+
# {::Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue#interval FacetValue.interval}.
|
891
|
+
# Only supported on numerical facets and returned if
|
892
|
+
# {::Google::Cloud::Retail::V2::SearchRequest::FacetSpec::FacetKey#return_min_max SearchRequest.FacetSpec.FacetKey.return_min_max}
|
893
|
+
# is true.
|
862
894
|
class FacetValue
|
863
895
|
include ::Google::Protobuf::MessageExts
|
864
896
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -26,8 +26,6 @@ module Google
|
|
26
26
|
# service Foo {
|
27
27
|
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
28
28
|
# }
|
29
|
-
#
|
30
|
-
# The JSON representation for `Empty` is empty JSON object `{}`.
|
31
29
|
class Empty
|
32
30
|
include ::Google::Protobuf::MessageExts
|
33
31
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-retail-v2
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.10.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-08-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|