Skip to content

Commit cb637a6

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Keep the API doc up-to-date
feat: update grpc service config settings to reflect correct API deadlines chore: remove relative private links from search service comments to prevent crashing client lib generation tool PiperOrigin-RevId: 392712211
1 parent 2760083 commit cb637a6

9 files changed

Lines changed: 175 additions & 59 deletions

‎google/cloud/retail/v2/product.proto‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,9 @@ message Product {
200200
// This field must be a UTF-8 encoded string with a length limit of 128
201201
// characters. Otherwise, an INVALID_ARGUMENT error is returned.
202202
//
203+
// This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is
204+
// returned.
205+
//
203206
// Google Merchant Center property
204207
// [gtin](https://support.google.com/merchants/answer/6324461).
205208
// Schema.org property
@@ -434,7 +437,7 @@ message Product {
434437
// The pattern or graphic print of the product. For example, "striped", "polka
435438
// dot", "paisley".
436439
//
437-
// A maximum of 5 values are allowed per
440+
// A maximum of 20 values are allowed per
438441
// [Product][google.cloud.retail.v2.Product]. Each value must be a UTF-8
439442
// encoded string with a length limit of 128 characters. Otherwise, an
440443
// INVALID_ARGUMENT error is returned.

‎google/cloud/retail/v2/retail_grpc_service_config.json‎

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,57 @@
33
"name": [
44
{ "service": "google.cloud.retail.v2.CatalogService" },
55
{ "service": "google.cloud.retail.v2.CompletionService" },
6-
{ "service": "google.cloud.retail.v2.ProductService" },
76
{ "service": "google.cloud.retail.v2.UserEventService" },
87
{ "service": "google.cloud.retail.v2.PredictionService" },
98
{ "service": "google.cloud.retail.v2.SearchService" }
109
],
11-
"timeout": "60s",
10+
"timeout": "5s",
11+
"retryPolicy": {
12+
"initialBackoff": "0.100s",
13+
"maxBackoff": "5s",
14+
"backoffMultiplier": 1.3,
15+
"retryableStatusCodes": [
16+
"UNAVAILABLE",
17+
"DEADLINE_EXCEEDED"
18+
]
19+
}
20+
}, {
21+
"name": [
22+
{ "service": "google.cloud.retail.v2.ProductService" },
23+
{
24+
"service": "google.cloud.retail.v2.UserEventService",
25+
"method": "PurgeUserEvents"
26+
}
27+
],
28+
"timeout": "30s",
29+
"retryPolicy": {
30+
"initialBackoff": "0.100s",
31+
"maxBackoff": "30s",
32+
"backoffMultiplier": 1.3,
33+
"retryableStatusCodes": [
34+
"UNAVAILABLE",
35+
"DEADLINE_EXCEEDED"
36+
]
37+
}
38+
}, {
39+
"name": [
40+
{
41+
"service": "google.longrunning.Operations",
42+
"method": "ListOperations"
43+
},
44+
{
45+
"service": "google.cloud.retail.v2.ProductService",
46+
"method": "ImportProducts"
47+
},
48+
{
49+
"service": "google.cloud.retail.v2.UserEventService",
50+
"method": "ImportUserEvents"
51+
}
52+
],
53+
"timeout": "300s",
1254
"retryPolicy": {
1355
"initialBackoff": "0.100s",
14-
"maxBackoff": "60s",
56+
"maxBackoff": "300s",
1557
"backoffMultiplier": 1.3,
1658
"retryableStatusCodes": [
1759
"UNAVAILABLE",

‎google/cloud/retail/v2/search_service.proto‎

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -289,10 +289,9 @@ message SearchRequest {
289289
//
290290
// * To boost products with product ID "product_1" or "product_2", and
291291
// color
292-
// "Red" or "Blue":<br>
293-
// *(id: ANY("product_1", "product_2"))<br>*
294-
// *AND<br>*
295-
// *(colorFamilies: ANY("Red", "Blue"))<br>*
292+
// "Red" or "Blue":
293+
// * (id: ANY("product_1", "product_2")) AND (colorFamilies:
294+
// ANY("Red","Blue"))
296295
string condition = 1;
297296

298297
// Strength of the condition boost, which should be in [-1, 1]. Negative
@@ -414,8 +413,7 @@ message SearchRequest {
414413

415414
// The filter syntax consists of an expression language for constructing a
416415
// predicate from one or more fields of the products being filtered. Filter
417-
// expression is case-sensitive. See more details at this [user
418-
// guide](/retail/private/docs/filter-and-order#filter).
416+
// expression is case-sensitive.
419417
//
420418
// If this field is unrecognizable, an INVALID_ARGUMENT is returned.
421419
string filter = 10;
@@ -433,9 +431,7 @@ message SearchRequest {
433431

434432
// The order in which products are returned. Products can be ordered by
435433
// a field in an [Product][google.cloud.retail.v2.Product] object. Leave it
436-
// unset if ordered by relevance. OrderBy expression is case-sensitive. See
437-
// more details at this [user
438-
// guide](/retail/private/docs/filter-and-order#order).
434+
// unset if ordered by relevance. OrderBy expression is case-sensitive.
439435
//
440436
// If this field is unrecognizable, an INVALID_ARGUMENT is returned.
441437
string order_by = 11;
@@ -453,13 +449,11 @@ message SearchRequest {
453449
// support team if you are interested in using dynamic facet feature.
454450
DynamicFacetSpec dynamic_facet_spec = 21;
455451

456-
// Boost specification to boost certain products. See more details at this
457-
// [user guide](/retail/private/docs/boosting).
452+
// Boost specification to boost certain products.
458453
BoostSpec boost_spec = 13;
459454

460455
// The query expansion specification that specifies the conditions under which
461-
// query expansion will occur. See more details at this [user
462-
// guide](/retail/private/docs/result-size#query_expansion).
456+
// query expansion will occur.
463457
QueryExpansionSpec query_expansion_spec = 14;
464458

465459
// The keys to fetch and rollup the matching

‎google/cloud/retail/v2alpha/product.proto‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,9 @@ message Product {
204204
// This field must be a UTF-8 encoded string with a length limit of 128
205205
// characters. Otherwise, an INVALID_ARGUMENT error is returned.
206206
//
207+
// This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is
208+
// returned.
209+
//
207210
// Google Merchant Center property
208211
// [gtin](https://support.google.com/merchants/answer/6324461).
209212
// Schema.org property
@@ -440,7 +443,7 @@ message Product {
440443
// The pattern or graphic print of the product. For example, "striped", "polka
441444
// dot", "paisley".
442445
//
443-
// A maximum of 5 values are allowed per
446+
// A maximum of 20 values are allowed per
444447
// [Product][google.cloud.retail.v2alpha.Product]. Each value must be a UTF-8
445448
// encoded string with a length limit of 128 characters. Otherwise, an
446449
// INVALID_ARGUMENT error is returned.

‎google/cloud/retail/v2alpha/retail_grpc_service_config.json‎

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,57 @@
33
"name": [
44
{ "service": "google.cloud.retail.v2alpha.CatalogService" },
55
{ "service": "google.cloud.retail.v2alpha.CompletionService" },
6-
{ "service": "google.cloud.retail.v2alpha.ProductService" },
76
{ "service": "google.cloud.retail.v2alpha.UserEventService" },
87
{ "service": "google.cloud.retail.v2alpha.PredictionService" },
98
{ "service": "google.cloud.retail.v2alpha.SearchService" }
109
],
11-
"timeout": "60s",
10+
"timeout": "5s",
11+
"retryPolicy": {
12+
"initialBackoff": "0.100s",
13+
"maxBackoff": "5s",
14+
"backoffMultiplier": 1.3,
15+
"retryableStatusCodes": [
16+
"UNAVAILABLE",
17+
"DEADLINE_EXCEEDED"
18+
]
19+
}
20+
}, {
21+
"name": [
22+
{ "service": "google.cloud.retail.v2alpha.ProductService" },
23+
{
24+
"service": "google.cloud.retail.v2alpha.UserEventService",
25+
"method": "PurgeUserEvents"
26+
}
27+
],
28+
"timeout": "30s",
29+
"retryPolicy": {
30+
"initialBackoff": "0.100s",
31+
"maxBackoff": "30s",
32+
"backoffMultiplier": 1.3,
33+
"retryableStatusCodes": [
34+
"UNAVAILABLE",
35+
"DEADLINE_EXCEEDED"
36+
]
37+
}
38+
}, {
39+
"name": [
40+
{
41+
"service": "google.longrunning.Operations",
42+
"method": "ListOperations"
43+
},
44+
{
45+
"service": "google.cloud.retail.v2alpha.ProductService",
46+
"method": "ImportProducts"
47+
},
48+
{
49+
"service": "google.cloud.retail.v2alpha.UserEventService",
50+
"method": "ImportUserEvents"
51+
}
52+
],
53+
"timeout": "300s",
1254
"retryPolicy": {
1355
"initialBackoff": "0.100s",
14-
"maxBackoff": "60s",
56+
"maxBackoff": "300s",
1557
"backoffMultiplier": 1.3,
1658
"retryableStatusCodes": [
1759
"UNAVAILABLE",

‎google/cloud/retail/v2alpha/search_service.proto‎

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ message SearchRequest {
6868
// Specifies how a facet is computed.
6969
message FacetKey {
7070
// Required. Supported textual and numerical facet keys in
71-
// [Product][google.cloud.retail.v2.Product] object, over which the facet
72-
// values are computed. Facet key is case-sensitive.
71+
// [Product][google.cloud.retail.v2alpha.Product] object, over which the
72+
// facet values are computed. Facet key is case-sensitive.
7373
//
7474
// Allowed facet keys when
75-
// [FacetKey.query][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.query]
75+
// [FacetKey.query][google.cloud.retail.v2alpha.SearchRequest.FacetSpec.FacetKey.query]
7676
// is not specified:
7777
//
7878
// * textual_field =
@@ -291,10 +291,9 @@ message SearchRequest {
291291
//
292292
// * To boost products with product ID "product_1" or "product_2", and
293293
// color
294-
// "Red" or "Blue":<br>
295-
// *(id: ANY("product_1", "product_2"))<br>*
296-
// *AND<br>*
297-
// *(colorFamilies: ANY("Red", "Blue"))<br>*
294+
// "Red" or "Blue":
295+
// * (id: ANY("product_1", "product_2")) AND (colorFamilies:
296+
// ANY("Red","Blue"))
298297
string condition = 1;
299298

300299
// Strength of the condition boost, which should be in [-1, 1]. Negative
@@ -438,8 +437,7 @@ message SearchRequest {
438437

439438
// The filter syntax consists of an expression language for constructing a
440439
// predicate from one or more fields of the products being filtered. Filter
441-
// expression is case-sensitive. See more details at this [user
442-
// guide](/retail/private/docs/filter-and-order#filter).
440+
// expression is case-sensitive.
443441
//
444442
// If this field is unrecognizable, an INVALID_ARGUMENT is returned.
445443
string filter = 10;
@@ -458,9 +456,7 @@ message SearchRequest {
458456

459457
// The order in which products are returned. Products can be ordered by
460458
// a field in an [Product][google.cloud.retail.v2alpha.Product] object. Leave
461-
// it unset if ordered by relevance. OrderBy expression is case-sensitive. See
462-
// more details at this [user
463-
// guide](/retail/private/docs/filter-and-order#order).
459+
// it unset if ordered by relevance. OrderBy expression is case-sensitive.
464460
//
465461
// If this field is unrecognizable, an INVALID_ARGUMENT is returned.
466462
string order_by = 11;
@@ -478,22 +474,19 @@ message SearchRequest {
478474
// support team if you are interested in using dynamic facet feature.
479475
DynamicFacetSpec dynamic_facet_spec = 21;
480476

481-
// Boost specification to boost certain products. See more details at this
482-
// [user guide](/retail/private/docs/boosting).
477+
// Boost specification to boost certain products.
483478
BoostSpec boost_spec = 13;
484479

485480
// The query expansion specification that specifies the conditions under which
486-
// query expansion will occur. See more details at this [user
487-
// guide](/retail/private/docs/result-size#query_expansion).
481+
// query expansion will occur..
488482
QueryExpansionSpec query_expansion_spec = 14;
489483

490484
// The relevance threshold of the search results.
491485
//
492486
// Defaults to
493487
// [RelevanceThreshold.HIGH][google.cloud.retail.v2alpha.SearchRequest.RelevanceThreshold.HIGH],
494488
// which means only the most relevant results are shown, and the least number
495-
// of results are returned. See more details at this [user
496-
// guide](/retail/private/docs/result-size#relevance_thresholding).
489+
// of results are returned.
497490
RelevanceThreshold relevance_threshold = 15;
498491

499492
// The keys to fetch and rollup the matching

‎google/cloud/retail/v2beta/product.proto‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,9 @@ message Product {
203203
// This field must be a UTF-8 encoded string with a length limit of 128
204204
// characters. Otherwise, an INVALID_ARGUMENT error is returned.
205205
//
206+
// This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is
207+
// returned.
208+
//
206209
// Google Merchant Center property
207210
// [gtin](https://support.google.com/merchants/answer/6324461).
208211
// Schema.org property
@@ -439,7 +442,7 @@ message Product {
439442
// The pattern or graphic print of the product. For example, "striped", "polka
440443
// dot", "paisley".
441444
//
442-
// A maximum of 5 values are allowed per
445+
// A maximum of 20 values are allowed per
443446
// [Product][google.cloud.retail.v2beta.Product]. Each value must be a UTF-8
444447
// encoded string with a length limit of 128 characters. Otherwise, an
445448
// INVALID_ARGUMENT error is returned.

‎google/cloud/retail/v2beta/retail_grpc_service_config.json‎

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,57 @@
33
"name": [
44
{ "service": "google.cloud.retail.v2beta.CatalogService" },
55
{ "service": "google.cloud.retail.v2beta.CompletionService" },
6-
{ "service": "google.cloud.retail.v2beta.ProductService" },
76
{ "service": "google.cloud.retail.v2beta.UserEventService" },
87
{ "service": "google.cloud.retail.v2beta.PredictionService" },
98
{ "service": "google.cloud.retail.v2beta.SearchService" }
109
],
11-
"timeout": "60s",
10+
"timeout": "5s",
11+
"retryPolicy": {
12+
"initialBackoff": "0.100s",
13+
"maxBackoff": "5s",
14+
"backoffMultiplier": 1.3,
15+
"retryableStatusCodes": [
16+
"UNAVAILABLE",
17+
"DEADLINE_EXCEEDED"
18+
]
19+
}
20+
}, {
21+
"name": [
22+
{ "service": "google.cloud.retail.v2beta.ProductService" },
23+
{
24+
"service": "google.cloud.retail.v2beta.UserEventService",
25+
"method": "PurgeUserEvents"
26+
}
27+
],
28+
"timeout": "30s",
29+
"retryPolicy": {
30+
"initialBackoff": "0.100s",
31+
"maxBackoff": "30s",
32+
"backoffMultiplier": 1.3,
33+
"retryableStatusCodes": [
34+
"UNAVAILABLE",
35+
"DEADLINE_EXCEEDED"
36+
]
37+
}
38+
}, {
39+
"name": [
40+
{
41+
"service": "google.longrunning.Operations",
42+
"method": "ListOperations"
43+
},
44+
{
45+
"service": "google.cloud.retail.v2beta.ProductService",
46+
"method": "ImportProducts"
47+
},
48+
{
49+
"service": "google.cloud.retail.v2beta.UserEventService",
50+
"method": "ImportUserEvents"
51+
}
52+
],
53+
"timeout": "300s",
1254
"retryPolicy": {
1355
"initialBackoff": "0.100s",
14-
"maxBackoff": "60s",
56+
"maxBackoff": "300s",
1557
"backoffMultiplier": 1.3,
1658
"retryableStatusCodes": [
1759
"UNAVAILABLE",

0 commit comments

Comments
 (0)