Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit d94dee3

Browse files
committedDec 20, 2022
feat(retail): update the api
#### retail:v2 The following keys were added: - resources.projects.resources.locations.resources.catalogs.resources.userEvents.methods.write.parameters.writeAsync (Total Keys: 2) #### retail:v2alpha The following keys were added: - resources.projects.resources.locations.resources.catalogs.resources.userEvents.methods.write.parameters.writeAsync (Total Keys: 2) #### retail:v2beta The following keys were added: - resources.projects.resources.locations.resources.catalogs.resources.userEvents.methods.write.parameters.writeAsync (Total Keys: 2)
1 parent f732fd3 commit d94dee3

16 files changed

+81
-63
lines changed
 

‎docs/dyn/retail_v2.projects.locations.catalogs.controls.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h3>Method Details</h3>
111111
The object takes the form of:
112112

113113
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
114-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
114+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
115115
&quot;A String&quot;,
116116
],
117117
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -199,7 +199,7 @@ <h3>Method Details</h3>
199199
An object of the form:
200200

201201
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
202-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
202+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
203203
&quot;A String&quot;,
204204
],
205205
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -311,7 +311,7 @@ <h3>Method Details</h3>
311311
An object of the form:
312312

313313
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
314-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
314+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
315315
&quot;A String&quot;,
316316
],
317317
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -410,7 +410,7 @@ <h3>Method Details</h3>
410410
{ # Response for ListControls method.
411411
&quot;controls&quot;: [ # All the Controls for a given catalog.
412412
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
413-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
413+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
414414
&quot;A String&quot;,
415415
],
416416
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -516,7 +516,7 @@ <h3>Method Details</h3>
516516
The object takes the form of:
517517

518518
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
519-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
519+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
520520
&quot;A String&quot;,
521521
],
522522
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -604,7 +604,7 @@ <h3>Method Details</h3>
604604
An object of the form:
605605

606606
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
607-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
607+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
608608
&quot;A String&quot;,
609609
],
610610
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

‎docs/dyn/retail_v2.projects.locations.catalogs.placements.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h3>Method Details</h3>
9797
<pre>Makes a recommendation prediction.
9898

9999
Args:
100-
placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
100+
placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
101101
body: object, The request body.
102102
The object takes the form of:
103103

@@ -364,7 +364,7 @@ <h3>Method Details</h3>
364364
<pre>Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
365365

366366
Args:
367-
placement: string, 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 configuration name and the set of models that will be used to make the search. (required)
367+
placement: string, 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. (required)
368368
body: object, The request body.
369369
The object takes the form of:
370370

‎docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,7 @@ <h3>Method Details</h3>
572572
<pre>Makes a recommendation prediction.
573573

574574
Args:
575-
placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
575+
placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
576576
body: object, The request body.
577577
The object takes the form of:
578578

@@ -907,7 +907,7 @@ <h3>Method Details</h3>
907907
<pre>Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
908908

909909
Args:
910-
placement: string, 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 configuration name and the set of models that will be used to make the search. (required)
910+
placement: string, 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. (required)
911911
body: object, The request body.
912912
The object takes the form of:
913913

‎docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html

+3-2
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ <h2>Instance Methods</h2>
9090
<code><a href="#rejoin">rejoin(parent, body=None, x__xgafv=None)</a></code></p>
9191
<p class="firstline">Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.</p>
9292
<p class="toc_element">
93-
<code><a href="#write">write(parent, body=None, x__xgafv=None)</a></code></p>
93+
<code><a href="#write">write(parent, body=None, writeAsync=None, x__xgafv=None)</a></code></p>
9494
<p class="firstline">Writes a single user event.</p>
9595
<h3>Method Details</h3>
9696
<div class="method">
@@ -502,7 +502,7 @@ <h3>Method Details</h3>
502502
</div>
503503

504504
<div class="method">
505-
<code class="details" id="write">write(parent, body=None, x__xgafv=None)</code>
505+
<code class="details" id="write">write(parent, body=None, writeAsync=None, x__xgafv=None)</code>
506506
<pre>Writes a single user event.
507507

508508
Args:
@@ -731,6 +731,7 @@ <h3>Method Details</h3>
731731
&quot;visitorId&quot;: &quot;A String&quot;, # 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 log in/out of the website. Don&#x27;t set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.
732732
}
733733

734+
writeAsync: boolean, If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.
734735
x__xgafv: string, V1 error format.
735736
Allowed values
736737
1 - v1 error format

‎docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h3>Method Details</h3>
111111
The object takes the form of:
112112

113113
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
114-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
114+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
115115
&quot;A String&quot;,
116116
],
117117
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -230,7 +230,7 @@ <h3>Method Details</h3>
230230
An object of the form:
231231

232232
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
233-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
233+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
234234
&quot;A String&quot;,
235235
],
236236
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -373,7 +373,7 @@ <h3>Method Details</h3>
373373
An object of the form:
374374

375375
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
376-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
376+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
377377
&quot;A String&quot;,
378378
],
379379
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -503,7 +503,7 @@ <h3>Method Details</h3>
503503
{ # Response for ListControls method.
504504
&quot;controls&quot;: [ # All the Controls for a given catalog.
505505
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
506-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
506+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
507507
&quot;A String&quot;,
508508
],
509509
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -640,7 +640,7 @@ <h3>Method Details</h3>
640640
The object takes the form of:
641641

642642
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
643-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
643+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
644644
&quot;A String&quot;,
645645
],
646646
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -759,7 +759,7 @@ <h3>Method Details</h3>
759759
An object of the form:
760760

761761
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
762-
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
762+
&quot;associatedServingConfigIds&quot;: [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
763763
&quot;A String&quot;,
764764
],
765765
&quot;displayName&quot;: &quot;A String&quot;, # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

0 commit comments

Comments
 (0)
Please sign in to comment.