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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.html">collections</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.html">engines</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.engines.controls.html">controls</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, controlId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Control.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all Controls by their parent DataStore.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, controlId=None, x__xgafv=None)</code>
<pre>Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.
Args:
parent: string, Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.
"associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
"A String",
],
"boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control
"boost": 3.14, # Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
"fixedBoost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"interpolationBoostSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
"attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
"controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
{ # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
"attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
"boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
},
],
"fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
"interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
},
},
"conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
{ # Defines circumstances to be checked before allowing a behavior
"activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges.
{ # Used for time-dependent conditions.
"endTime": "A String", # End of time range. Range is inclusive. Must be in the future.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
{ # Matcher for search request query
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
"value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.
},
],
},
],
"displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
"filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation
"dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`
"promoteAction": { # Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store. # Promote certain links based on predefined trigger queries.
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
"imageUri": "A String", # Optional. The promotion thumbnail image url.
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
},
},
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
"redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
"synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.
"A String",
],
},
"useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.
"A String",
],
}
controlId: string, Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.
"associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
"A String",
],
"boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control
"boost": 3.14, # Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
"fixedBoost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"interpolationBoostSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
"attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
"controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
{ # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
"attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
"boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
},
],
"fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
"interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
},
},
"conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
{ # Defines circumstances to be checked before allowing a behavior
"activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges.
{ # Used for time-dependent conditions.
"endTime": "A String", # End of time range. Range is inclusive. Must be in the future.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
{ # Matcher for search request query
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
"value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.
},
],
},
],
"displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
"filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation
"dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`
"promoteAction": { # Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store. # Promote certain links based on predefined trigger queries.
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
"imageUri": "A String", # Optional. The promotion thumbnail image url.
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
},
},
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
"redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
"synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.
"A String",
],
},
"useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
Args:
name: string, Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a Control.
Args:
name: string, Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.
"associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
"A String",
],
"boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control
"boost": 3.14, # Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
"fixedBoost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"interpolationBoostSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
"attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
"controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
{ # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
"attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
"boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
},
],
"fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
"interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
},
},
"conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
{ # Defines circumstances to be checked before allowing a behavior
"activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges.
{ # Used for time-dependent conditions.
"endTime": "A String", # End of time range. Range is inclusive. Must be in the future.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
{ # Matcher for search request query
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
"value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.
},
],
},
],
"displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
"filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation
"dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`
"promoteAction": { # Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store. # Promote certain links based on predefined trigger queries.
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
"imageUri": "A String", # Optional. The promotion thumbnail image url.
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
},
},
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
"redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
"synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.
"A String",
],
},
"useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all Controls by their parent DataStore.
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. (required)
filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported.
pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListControls method.
"controls": [ # All the Controls for a given data store.
{ # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.
"associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
"A String",
],
"boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control
"boost": 3.14, # Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
"fixedBoost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"interpolationBoostSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
"attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
"controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
{ # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
"attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
"boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
},
],
"fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
"interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
},
},
"conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
{ # Defines circumstances to be checked before allowing a behavior
"activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges.
{ # Used for time-dependent conditions.
"endTime": "A String", # End of time range. Range is inclusive. Must be in the future.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
{ # Matcher for search request query
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
"value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.
},
],
},
],
"displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
"filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation
"dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`
"promoteAction": { # Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store. # Promote certain links based on predefined trigger queries.
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
"imageUri": "A String", # Optional. The promotion thumbnail image url.
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
},
},
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
"redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
"synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.
"A String",
],
},
"useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.
"A String",
],
},
],
"nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
Args:
name: string, Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` (required)
body: object, The request body.
The object takes the form of:
{ # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.
"associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
"A String",
],
"boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control
"boost": 3.14, # Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
"fixedBoost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"interpolationBoostSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
"attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
"controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
{ # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
"attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
"boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
},
],
"fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
"interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
},
},
"conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
{ # Defines circumstances to be checked before allowing a behavior
"activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges.
{ # Used for time-dependent conditions.
"endTime": "A String", # End of time range. Range is inclusive. Must be in the future.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
{ # Matcher for search request query
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
"value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.
},
],
},
],
"displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
"filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation
"dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`
"promoteAction": { # Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store. # Promote certain links based on predefined trigger queries.
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
"imageUri": "A String", # Optional. The promotion thumbnail image url.
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
},
},
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
"redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
"synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.
"A String",
],
},
"useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.
"A String",
],
}
updateMask: string, Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.
"associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
"A String",
],
"boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control
"boost": 3.14, # Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
"fixedBoost": 3.14, # Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
"interpolationBoostSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Optional. Complex specification for custom ranking based on customer defined attribute value.
"attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
"controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
{ # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
"attributeValue": "A String", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
"boostAmount": 3.14, # Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
},
],
"fieldName": "A String", # Optional. The name of the field whose value will be used to determine the boost amount.
"interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below.
},
},
"conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
{ # Defines circumstances to be checked before allowing a behavior
"activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges.
{ # Used for time-dependent conditions.
"endTime": "A String", # End of time range. Range is inclusive. Must be in the future.
"startTime": "A String", # Start of time range. Range is inclusive.
},
],
"queryRegex": "A String", # Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. Only supported for Basic Site Search promotion serving controls.
"queryTerms": [ # Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.
{ # Matcher for search request query
"fullMatch": True or False, # Whether the search query needs to exactly match the query term.
"value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.
},
],
},
],
"displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
"filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation
"dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
"filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`
"promoteAction": { # Promote certain links based on some trigger queries. Example: Promote shoe store link when searching for `shoe` keyword. The link can be outside of associated data store. # Promote certain links based on predefined trigger queries.
"dataStore": "A String", # Required. Data store with which this promotion is attached to.
"searchLinkPromotion": { # Promotion proto includes uri and other helping information to display the promotion. # Required. Promotion attached to this action.
"description": "A String", # Optional. The Promotion description. Maximum length: 200 characters.
"document": "A String", # Optional. The Document the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
"enabled": True or False, # Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only.
"imageUri": "A String", # Optional. The promotion thumbnail image url.
"title": "A String", # Required. The title of the promotion. Maximum length: 160 characters.
"uri": "A String", # Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
},
},
"redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control.
"redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.
},
"solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
"synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another.
"synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.
"A String",
],
},
"useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.
"A String",
],
}</pre>
</div>
</body></html>
|
