This repository has been archived by the owner on Sep 21, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
/
search_service.py
1243 lines (1108 loc) · 52.4 KB
/
search_service.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from typing import MutableMapping, MutableSequence
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import struct_pb2 # type: ignore
import proto # type: ignore
from google.cloud.retail_v2.types import common
from google.cloud.retail_v2.types import product as gcr_product
__protobuf__ = proto.module(
package="google.cloud.retail.v2",
manifest={
"SearchRequest",
"SearchResponse",
},
)
class SearchRequest(proto.Message):
r"""Request message for
[SearchService.Search][google.cloud.retail.v2.SearchService.Search]
method.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
placement (str):
Required. The resource name of the Retail Search serving
config, such as
``projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config``
or the name of the legacy placement resource, such as
``projects/*/locations/global/catalogs/default_catalog/placements/default_search``.
This field is used to identify the serving config name and
the set of models that will be used to make the search.
branch (str):
The branch resource name, such as
``projects/*/locations/global/catalogs/default_catalog/branches/0``.
Use "default_branch" as the branch ID or leave this field
empty, to search products under the default branch.
query (str):
Raw search query.
If this field is empty, the request is considered a category
browsing request and returned results are based on
[filter][google.cloud.retail.v2.SearchRequest.filter] and
[page_categories][google.cloud.retail.v2.SearchRequest.page_categories].
visitor_id (str):
Required. A unique identifier for tracking visitors. For
example, this could be implemented with an HTTP cookie,
which should be able to uniquely identify a visitor on a
single device. This unique identifier should not change if
the visitor logs in or out of the website.
This should be the same identifier as
[UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_id].
The field must be a UTF-8 encoded string with a length limit
of 128 characters. Otherwise, an INVALID_ARGUMENT error is
returned.
user_info (google.cloud.retail_v2.types.UserInfo):
User information.
page_size (int):
Maximum number of [Product][google.cloud.retail.v2.Product]s
to return. If unspecified, defaults to a reasonable value.
The maximum allowed value is 120. Values above 120 will be
coerced to 120.
If this field is negative, an INVALID_ARGUMENT is returned.
page_token (str):
A page token
[SearchResponse.next_page_token][google.cloud.retail.v2.SearchResponse.next_page_token],
received from a previous
[SearchService.Search][google.cloud.retail.v2.SearchService.Search]
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
[SearchService.Search][google.cloud.retail.v2.SearchService.Search]
must match the call that provided the page token. Otherwise,
an INVALID_ARGUMENT error is returned.
offset (int):
A 0-indexed integer that specifies the current offset (that
is, starting result location, amongst the
[Product][google.cloud.retail.v2.Product]s deemed by the API
as relevant) in search results. This field is only
considered if
[page_token][google.cloud.retail.v2.SearchRequest.page_token]
is unset.
If this field is negative, an INVALID_ARGUMENT is returned.
filter (str):
The filter syntax consists of an expression language for
constructing a predicate from one or more fields of the
products being filtered. Filter expression is
case-sensitive. See more details at this `user
guide <https://cloud.google.com/retail/docs/filter-and-order#filter>`__.
If this field is unrecognizable, an INVALID_ARGUMENT is
returned.
canonical_filter (str):
The default filter that is applied when a user performs a
search without checking any filters on the search page.
The filter applied to every search request when quality
improvement such as query expansion is needed. For example,
if a query does not have enough results, an expanded query
with
[SearchRequest.canonical_filter][google.cloud.retail.v2.SearchRequest.canonical_filter]
will be returned as a supplement of the original query. This
field is strongly recommended to achieve high search
quality.
See
[SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]
for more details about filter syntax.
order_by (str):
The order in which products are returned. Products can be
ordered by a field in an
[Product][google.cloud.retail.v2.Product] object. Leave it
unset if ordered by relevance. OrderBy expression is
case-sensitive. See more details at this `user
guide <https://cloud.google.com/retail/docs/filter-and-order#order>`__.
If this field is unrecognizable, an INVALID_ARGUMENT is
returned.
facet_specs (MutableSequence[google.cloud.retail_v2.types.SearchRequest.FacetSpec]):
Facet specifications for faceted search. If empty, no facets
are returned.
A maximum of 100 values are allowed. Otherwise, an
INVALID_ARGUMENT error is returned.
dynamic_facet_spec (google.cloud.retail_v2.types.SearchRequest.DynamicFacetSpec):
Deprecated. Refer to
https://cloud.google.com/retail/docs/configs#dynamic
to enable dynamic facets. Do not set this field.
The specification for dynamically generated
facets. Notice that only textual facets can be
dynamically generated.
boost_spec (google.cloud.retail_v2.types.SearchRequest.BoostSpec):
Boost specification to boost certain products. See more
details at this `user
guide <https://cloud.google.com/retail/docs/boosting>`__.
Notice that if both
[ServingConfig.boost_control_ids][google.cloud.retail.v2.ServingConfig.boost_control_ids]
and
[SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec]
are set, the boost conditions from both places are
evaluated. If a search request matches multiple boost
conditions, the final boost score is equal to the sum of the
boost scores from all matched boost conditions.
query_expansion_spec (google.cloud.retail_v2.types.SearchRequest.QueryExpansionSpec):
The query expansion specification that specifies the
conditions under which query expansion will occur. See more
details at this `user
guide <https://cloud.google.com/retail/docs/result-size#query_expansion>`__.
variant_rollup_keys (MutableSequence[str]):
The keys to fetch and rollup the matching
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product]s attributes,
[FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo] or
[LocalInventory][google.cloud.retail.v2.LocalInventory]s
attributes. The attributes from all the matching
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product]s or
[LocalInventory][google.cloud.retail.v2.LocalInventory]s are
merged and de-duplicated. Notice that rollup attributes will
lead to extra query latency. Maximum number of keys is 30.
For
[FulfillmentInfo][google.cloud.retail.v2.FulfillmentInfo], a
fulfillment type and a fulfillment ID must be provided in
the format of "fulfillmentType.fulfillmentId". E.g., in
"pickupInStore.store123", "pickupInStore" is fulfillment
type and "store123" is the store ID.
Supported keys are:
- colorFamilies
- price
- originalPrice
- discount
- variantId
- inventory(place_id,price)
- inventory(place_id,original_price)
- inventory(place_id,attributes.key), where key is any key
in the
[Product.local_inventories.attributes][google.cloud.retail.v2.LocalInventory.attributes]
map.
- attributes.key, where key is any key in the
[Product.attributes][google.cloud.retail.v2.Product.attributes]
map.
- pickupInStore.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"pickup-in-store".
- shipToStore.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"ship-to-store".
- sameDayDelivery.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"same-day-delivery".
- nextDayDelivery.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"next-day-delivery".
- customFulfillment1.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"custom-type-1".
- customFulfillment2.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"custom-type-2".
- customFulfillment3.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"custom-type-3".
- customFulfillment4.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"custom-type-4".
- customFulfillment5.id, where id is any
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
for
[FulfillmentInfo.type][google.cloud.retail.v2.FulfillmentInfo.type]
"custom-type-5".
If this field is set to an invalid value other than these,
an INVALID_ARGUMENT error is returned.
page_categories (MutableSequence[str]):
The categories associated with a category page. Required for
category navigation queries to achieve good search quality.
The format should be the same as
[UserEvent.page_categories][google.cloud.retail.v2.UserEvent.page_categories];
To represent full path of category, use '>' sign to separate
different hierarchies. If '>' is part of the category name,
replace it with other character(s).
Category pages include special pages such as sales or
promotions. For instance, a special sale page may have the
category hierarchy: "pageCategories" : ["Sales > 2017 Black
Friday Deals"].
search_mode (google.cloud.retail_v2.types.SearchRequest.SearchMode):
The search mode of the search request. If not
specified, a single search request triggers both
product search and faceted search.
personalization_spec (google.cloud.retail_v2.types.SearchRequest.PersonalizationSpec):
The specification for personalization.
Notice that if both
[ServingConfig.personalization_spec][google.cloud.retail.v2.ServingConfig.personalization_spec]
and
[SearchRequest.personalization_spec][google.cloud.retail.v2.SearchRequest.personalization_spec]
are set.
[SearchRequest.personalization_spec][google.cloud.retail.v2.SearchRequest.personalization_spec]
will override
[ServingConfig.personalization_spec][google.cloud.retail.v2.ServingConfig.personalization_spec].
labels (MutableMapping[str, str]):
The labels applied to a resource must meet the following
requirements:
- Each resource can have multiple labels, up to a maximum
of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum
length of 63 characters and cannot be empty. Values can
be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters,
numeric characters, underscores, and dashes. All
characters must use UTF-8 encoding, and international
characters are allowed.
- The key portion of a label must be unique. However, you
can use the same key with multiple resources.
- Keys must start with a lowercase letter or international
character.
See `Google Cloud
Document <https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements>`__
for more details.
spell_correction_spec (google.cloud.retail_v2.types.SearchRequest.SpellCorrectionSpec):
The spell correction specification that
specifies the mode under which spell correction
will take effect.
This field is a member of `oneof`_ ``_spell_correction_spec``.
"""
class SearchMode(proto.Enum):
r"""The search mode of each search request."""
SEARCH_MODE_UNSPECIFIED = 0
PRODUCT_SEARCH_ONLY = 1
FACETED_SEARCH_ONLY = 2
class FacetSpec(proto.Message):
r"""A facet specification to perform faceted search.
Attributes:
facet_key (google.cloud.retail_v2.types.SearchRequest.FacetSpec.FacetKey):
Required. The facet key specification.
limit (int):
Maximum of facet values that should be returned for this
facet. If unspecified, defaults to 50. The maximum allowed
value is 300. Values above 300 will be coerced to 300.
If this field is negative, an INVALID_ARGUMENT is returned.
excluded_filter_keys (MutableSequence[str]):
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this
field.
Listing a facet key in this field allows its values to
appear as facet results, even when they are filtered out of
search results. Using this field does not affect what search
results are returned.
For example, suppose there are 100 products with the color
facet "Red" and 200 products with the color facet "Blue". A
query containing the filter "colorFamilies:ANY("Red")" and
having "colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
would by default return only "Red" products in the search
results, and also return "Red" with count 100 as the only
color facet. Although there are also blue products
available, "Blue" would not be shown as an available facet
value.
If "colorFamilies" is listed in "excludedFilterKeys", then
the query returns the facet values "Red" with count 100 and
"Blue" with count 200, because the "colorFamilies" key is
now excluded from the filter. Because this field doesn't
affect search results, the search results are still
correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an
INVALID_ARGUMENT error is returned.
enable_dynamic_position (bool):
Enables dynamic position for this facet. If set to true, the
position of this facet among all facets in the response is
determined by Google Retail Search. It will be ordered
together with dynamic facets if dynamic facets is enabled.
If set to false, the position of this facet in the response
will be the same as in the request, and it will be ranked
before the facets with dynamic position enable and all
dynamic facets.
For example, you may always want to have rating facet
returned in the response, but it's not necessarily to always
display the rating facet at the top. In that case, you can
set enable_dynamic_position to true so that the position of
rating facet in response will be determined by Google Retail
Search.
Another example, assuming you have the following facets in
the request:
- "rating", enable_dynamic_position = true
- "price", enable_dynamic_position = false
- "brands", enable_dynamic_position = false
And also you have a dynamic facets enable, which will
generate a facet 'gender'. Then the final order of the
facets in the response can be ("price", "brands", "rating",
"gender") or ("price", "brands", "gender", "rating") depends
on how Google Retail Search orders "gender" and "rating"
facets. However, notice that "price" and "brands" will
always be ranked at 1st and 2nd position since their
enable_dynamic_position are false.
"""
class FacetKey(proto.Message):
r"""Specifies how a facet is computed.
Attributes:
key (str):
Required. Supported textual and numerical facet keys in
[Product][google.cloud.retail.v2.Product] object, over which
the facet values are computed. Facet key is case-sensitive.
Allowed facet keys when
[FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
is not specified:
- textual_field =
- "brands"
- "categories"
- "genders"
- "ageGroups"
- "availability"
- "colorFamilies"
- "colors"
- "sizes"
- "materials"
- "patterns"
- "conditions"
- "attributes.key"
- "pickupInStore"
- "shipToStore"
- "sameDayDelivery"
- "nextDayDelivery"
- "customFulfillment1"
- "customFulfillment2"
- "customFulfillment3"
- "customFulfillment4"
- "customFulfillment5"
- "inventory(place_id,attributes.key)"
- numerical_field =
- "price"
- "discount"
- "rating"
- "ratingCount"
- "attributes.key"
- "inventory(place_id,price)"
- "inventory(place_id,original_price)"
- "inventory(place_id,attributes.key)".
intervals (MutableSequence[google.cloud.retail_v2.types.Interval]):
Set only if values should be bucketized into
intervals. Must be set for facets with numerical
values. Must not be set for facet with text
values. Maximum number of intervals is 30.
restricted_values (MutableSequence[str]):
Only get facet for the given restricted values. For example,
when using "pickupInStore" as key and set restricted values
to ["store123", "store456"], only facets for "store123" and
"store456" are returned. Only supported on predefined
textual fields, custom textual attributes and fulfillments.
Maximum is 20.
Must be set for the fulfillment facet keys:
- pickupInStore
- shipToStore
- sameDayDelivery
- nextDayDelivery
- customFulfillment1
- customFulfillment2
- customFulfillment3
- customFulfillment4
- customFulfillment5
prefixes (MutableSequence[str]):
Only get facet values that start with the
given string prefix. For example, suppose
"categories" has three values "Women > Shoe",
"Women > Dress" and "Men > Shoe". If set
"prefixes" to "Women", the "categories" facet
will give only "Women > Shoe" and "Women >
Dress". Only supported on textual fields.
Maximum is 10.
contains (MutableSequence[str]):
Only get facet values that contains the given
strings. For example, suppose "categories" has
three values "Women > Shoe", "Women > Dress" and
"Men > Shoe". If set "contains" to "Shoe", the
"categories" facet will give only "Women > Shoe"
and "Men > Shoe". Only supported on textual
fields. Maximum is 10.
case_insensitive (bool):
True to make facet keys case insensitive when
getting faceting values with prefixes or
contains; false otherwise.
order_by (str):
The order in which
[SearchResponse.Facet.values][google.cloud.retail.v2.SearchResponse.Facet.values]
are returned.
Allowed values are:
- "count desc", which means order by
[SearchResponse.Facet.values.count][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.count]
descending.
- "value desc", which means order by
[SearchResponse.Facet.values.value][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.value]
descending. Only applies to textual facets.
If not set, textual values are sorted in `natural
order <https://en.wikipedia.org/wiki/Natural_sort_order>`__;
numerical intervals are sorted in the order given by
[FacetSpec.FacetKey.intervals][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.intervals];
[FulfillmentInfo.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]
are sorted in the order given by
[FacetSpec.FacetKey.restricted_values][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.restricted_values].
query (str):
The query that is used to compute facet for the given facet
key. When provided, it will override the default behavior of
facet computation. The query syntax is the same as a filter
expression. See
[SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]
for detail syntax and limitations. Notice that there is no
limitation on
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
when query is specified.
In the response,
[SearchResponse.Facet.values.value][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.value]
will be always "1" and
[SearchResponse.Facet.values.count][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.count]
will be the number of results that match the query.
For example, you can set a customized facet for
"shipToStore", where
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is "customizedShipToStore", and
[FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
is "availability: ANY("IN_STOCK") AND shipToStore:
ANY("123")". Then the facet will count the products that are
both in stock and ship to store "123".
return_min_max (bool):
Returns the min and max value for each
numerical facet intervals. Ignored for textual
facets.
"""
key: str = proto.Field(
proto.STRING,
number=1,
)
intervals: MutableSequence[common.Interval] = proto.RepeatedField(
proto.MESSAGE,
number=2,
message=common.Interval,
)
restricted_values: MutableSequence[str] = proto.RepeatedField(
proto.STRING,
number=3,
)
prefixes: MutableSequence[str] = proto.RepeatedField(
proto.STRING,
number=8,
)
contains: MutableSequence[str] = proto.RepeatedField(
proto.STRING,
number=9,
)
case_insensitive: bool = proto.Field(
proto.BOOL,
number=10,
)
order_by: str = proto.Field(
proto.STRING,
number=4,
)
query: str = proto.Field(
proto.STRING,
number=5,
)
return_min_max: bool = proto.Field(
proto.BOOL,
number=11,
)
facet_key: "SearchRequest.FacetSpec.FacetKey" = proto.Field(
proto.MESSAGE,
number=1,
message="SearchRequest.FacetSpec.FacetKey",
)
limit: int = proto.Field(
proto.INT32,
number=2,
)
excluded_filter_keys: MutableSequence[str] = proto.RepeatedField(
proto.STRING,
number=3,
)
enable_dynamic_position: bool = proto.Field(
proto.BOOL,
number=4,
)
class DynamicFacetSpec(proto.Message):
r"""The specifications of dynamically generated facets.
Attributes:
mode (google.cloud.retail_v2.types.SearchRequest.DynamicFacetSpec.Mode):
Mode of the DynamicFacet feature. Defaults to
[Mode.DISABLED][google.cloud.retail.v2.SearchRequest.DynamicFacetSpec.Mode.DISABLED]
if it's unset.
"""
class Mode(proto.Enum):
r"""Enum to control DynamicFacet mode"""
MODE_UNSPECIFIED = 0
DISABLED = 1
ENABLED = 2
mode: "SearchRequest.DynamicFacetSpec.Mode" = proto.Field(
proto.ENUM,
number=1,
enum="SearchRequest.DynamicFacetSpec.Mode",
)
class BoostSpec(proto.Message):
r"""Boost specification to boost certain items.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
condition_boost_specs (MutableSequence[google.cloud.retail_v2.types.SearchRequest.BoostSpec.ConditionBoostSpec]):
Condition boost specifications. If a product
matches multiple conditions in the
specifictions, boost scores from these
specifications are all applied and combined in a
non-linear way. Maximum number of specifications
is 20.
skip_boost_spec_validation (bool):
Whether to skip boostspec validation. If this field is set
to true, invalid
[BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
will be ignored and valid
[BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
will still be applied.
This field is a member of `oneof`_ ``_skip_boost_spec_validation``.
"""
class ConditionBoostSpec(proto.Message):
r"""Boost applies to products which match a condition.
Attributes:
condition (str):
An expression which specifies a boost condition. The syntax
and supported fields are the same as a filter expression.
See
[SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter]
for detail syntax and limitations.
Examples:
- To boost products with product ID "product_1" or
"product_2", and color "Red" or "Blue":
- (id: ANY("product_1", "product_2")) AND
(colorFamilies: ANY("Red","Blue"))
boost (float):
Strength of the condition boost, which should be in [-1, 1].
Negative boost means demotion. Default is 0.0.
Setting to 1.0 gives the item a big promotion. However, it
does not necessarily mean that the boosted item will be the
top result at all times, nor that other items will be
excluded. Results could still be shown even when none of
them matches the condition. And results that are
significantly more relevant to the search query can still
trump your heavily favored but irrelevant items.
Setting to -1.0 gives the item a big demotion. However,
results that are deeply relevant might still be shown. The
item will have an upstream battle to get a fairly high
ranking, but it is not blocked out completely.
Setting to 0.0 means no boost applied. The boosting
condition is ignored.
"""
condition: str = proto.Field(
proto.STRING,
number=1,
)
boost: float = proto.Field(
proto.FLOAT,
number=2,
)
condition_boost_specs: MutableSequence[
"SearchRequest.BoostSpec.ConditionBoostSpec"
] = proto.RepeatedField(
proto.MESSAGE,
number=1,
message="SearchRequest.BoostSpec.ConditionBoostSpec",
)
skip_boost_spec_validation: bool = proto.Field(
proto.BOOL,
number=2,
optional=True,
)
class QueryExpansionSpec(proto.Message):
r"""Specification to determine under which conditions query
expansion should occur.
Attributes:
condition (google.cloud.retail_v2.types.SearchRequest.QueryExpansionSpec.Condition):
The condition under which query expansion should occur.
Default to
[Condition.DISABLED][google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition.DISABLED].
pin_unexpanded_results (bool):
Whether to pin unexpanded results. If this
field is set to true, unexpanded products are
always at the top of the search results,
followed by the expanded results.
"""
class Condition(proto.Enum):
r"""Enum describing under which condition query expansion should
occur.
"""
CONDITION_UNSPECIFIED = 0
DISABLED = 1
AUTO = 3
condition: "SearchRequest.QueryExpansionSpec.Condition" = proto.Field(
proto.ENUM,
number=1,
enum="SearchRequest.QueryExpansionSpec.Condition",
)
pin_unexpanded_results: bool = proto.Field(
proto.BOOL,
number=2,
)
class PersonalizationSpec(proto.Message):
r"""The specification for personalization.
Attributes:
mode (google.cloud.retail_v2.types.SearchRequest.PersonalizationSpec.Mode):
Defaults to
[Mode.AUTO][google.cloud.retail.v2.SearchRequest.PersonalizationSpec.Mode.AUTO].
"""
class Mode(proto.Enum):
r"""The personalization mode of each search request."""
MODE_UNSPECIFIED = 0
AUTO = 1
DISABLED = 2
mode: "SearchRequest.PersonalizationSpec.Mode" = proto.Field(
proto.ENUM,
number=1,
enum="SearchRequest.PersonalizationSpec.Mode",
)
class SpellCorrectionSpec(proto.Message):
r"""The specification for query spell correction.
Attributes:
mode (google.cloud.retail_v2.types.SearchRequest.SpellCorrectionSpec.Mode):
The mode under which spell correction should take effect to
replace the original search query. Default to
[Mode.AUTO][google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
"""
class Mode(proto.Enum):
r"""Enum describing under which mode spell correction should
occur.
"""
MODE_UNSPECIFIED = 0
SUGGESTION_ONLY = 1
AUTO = 2
mode: "SearchRequest.SpellCorrectionSpec.Mode" = proto.Field(
proto.ENUM,
number=1,
enum="SearchRequest.SpellCorrectionSpec.Mode",
)
placement: str = proto.Field(
proto.STRING,
number=1,
)
branch: str = proto.Field(
proto.STRING,
number=2,
)
query: str = proto.Field(
proto.STRING,
number=3,
)
visitor_id: str = proto.Field(
proto.STRING,
number=4,
)
user_info: common.UserInfo = proto.Field(
proto.MESSAGE,
number=5,
message=common.UserInfo,
)
page_size: int = proto.Field(
proto.INT32,
number=7,
)
page_token: str = proto.Field(
proto.STRING,
number=8,
)
offset: int = proto.Field(
proto.INT32,
number=9,
)
filter: str = proto.Field(
proto.STRING,
number=10,
)
canonical_filter: str = proto.Field(
proto.STRING,
number=28,
)
order_by: str = proto.Field(
proto.STRING,
number=11,
)
facet_specs: MutableSequence[FacetSpec] = proto.RepeatedField(
proto.MESSAGE,
number=12,
message=FacetSpec,
)
dynamic_facet_spec: DynamicFacetSpec = proto.Field(
proto.MESSAGE,
number=21,
message=DynamicFacetSpec,
)
boost_spec: BoostSpec = proto.Field(
proto.MESSAGE,
number=13,
message=BoostSpec,
)
query_expansion_spec: QueryExpansionSpec = proto.Field(
proto.MESSAGE,
number=14,
message=QueryExpansionSpec,
)
variant_rollup_keys: MutableSequence[str] = proto.RepeatedField(
proto.STRING,
number=17,
)
page_categories: MutableSequence[str] = proto.RepeatedField(
proto.STRING,
number=23,
)
search_mode: SearchMode = proto.Field(
proto.ENUM,
number=31,
enum=SearchMode,
)
personalization_spec: PersonalizationSpec = proto.Field(
proto.MESSAGE,
number=32,
message=PersonalizationSpec,
)
labels: MutableMapping[str, str] = proto.MapField(
proto.STRING,
proto.STRING,
number=34,
)
spell_correction_spec: SpellCorrectionSpec = proto.Field(
proto.MESSAGE,
number=35,
optional=True,
message=SpellCorrectionSpec,
)
class SearchResponse(proto.Message):
r"""Response message for
[SearchService.Search][google.cloud.retail.v2.SearchService.Search]
method.
Attributes:
results (MutableSequence[google.cloud.retail_v2.types.SearchResponse.SearchResult]):
A list of matched items. The order represents
the ranking.
facets (MutableSequence[google.cloud.retail_v2.types.SearchResponse.Facet]):
Results of facets requested by user.
total_size (int):
The estimated total count of matched items irrespective of
pagination. The count of
[results][google.cloud.retail.v2.SearchResponse.results]
returned by pagination may be less than the
[total_size][google.cloud.retail.v2.SearchResponse.total_size]
that matches.
corrected_query (str):
Contains the spell corrected query, if found. If the spell
correction type is AUTOMATIC, then the search results are
based on corrected_query. Otherwise the original query is
used for search.
attribution_token (str):
A unique search token. This should be included in the
[UserEvent][google.cloud.retail.v2.UserEvent] logs resulting
from this search, which enables accurate attribution of
search model performance.
next_page_token (str):
A token that can be sent as
[SearchRequest.page_token][google.cloud.retail.v2.SearchRequest.page_token]
to retrieve the next page. If this field is omitted, there
are no subsequent pages.
query_expansion_info (google.cloud.retail_v2.types.SearchResponse.QueryExpansionInfo):
Query expansion information for the returned
results.
redirect_uri (str):
The URI of a customer-defined redirect page. If redirect
action is triggered, no search is performed, and only
[redirect_uri][google.cloud.retail.v2.SearchResponse.redirect_uri]
and
[attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
are set in the response.
applied_controls (MutableSequence[str]):
The fully qualified resource name of applied
`controls <https://cloud.google.com/retail/docs/serving-control-rules>`__.
invalid_condition_boost_specs (MutableSequence[google.cloud.retail_v2.types.SearchRequest.BoostSpec.ConditionBoostSpec]):
The invalid
[SearchRequest.BoostSpec.condition_boost_specs][google.cloud.retail.v2.SearchRequest.BoostSpec.condition_boost_specs]
that are not applied during serving.
"""
class SearchResult(proto.Message):
r"""Represents the search results.
Attributes:
id (str):
[Product.id][google.cloud.retail.v2.Product.id] of the
searched [Product][google.cloud.retail.v2.Product].
product (google.cloud.retail_v2.types.Product):
The product data snippet in the search response. Only
[Product.name][google.cloud.retail.v2.Product.name] is
guaranteed to be populated.
[Product.variants][google.cloud.retail.v2.Product.variants]
contains the product variants that match the search query.
If there are multiple product variants matching the query,
top 5 most relevant product variants are returned and
ordered by relevancy.
If relevancy can be deternmined, use
[matching_variant_fields][google.cloud.retail.v2.SearchResponse.SearchResult.matching_variant_fields]
to look up matched product variants fields. If relevancy
cannot be determined, e.g. when searching "shoe" all
products in a shoe product can be a match, 5 product
variants are returned but order is meaningless.
matching_variant_count (int):
The count of matched
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product]s.
matching_variant_fields (MutableMapping[str, google.protobuf.field_mask_pb2.FieldMask]):
If a [variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product] matches the search
query, this map indicates which
[Product][google.cloud.retail.v2.Product] fields are
matched. The key is the
[Product.name][google.cloud.retail.v2.Product.name], the
value is a field mask of the matched
[Product][google.cloud.retail.v2.Product] fields. If matched
attributes cannot be determined, this map will be empty.
For example, a key "sku1" with field mask
"products.color_info" indicates there is a match between
"sku1" [ColorInfo][google.cloud.retail.v2.ColorInfo] and the
query.
variant_rollup_values (MutableMapping[str, google.protobuf.struct_pb2.Value]):
The rollup matching
[variant][google.cloud.retail.v2.Product.Type.VARIANT]
[Product][google.cloud.retail.v2.Product] attributes. The
key is one of the
[SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
The values are the merged and de-duplicated
[Product][google.cloud.retail.v2.Product] attributes. Notice
that the rollup values are respect filter. For example, when
filtering by "colorFamilies:ANY("red")" and rollup
"colorFamilies", only "red" is returned.