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)
googleapis · Dec 20, 2022 · d94dee3 · d94dee3
1 parent f732fd3
commit d94dee3
Show file tree

Hide file tree

Showing 16 changed files with 81 additions and 63 deletions.
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2.projects.locations.catalogs.controls.html
@@ -111,7 +111,7 @@ <h3>Method Details</h3>
     The object takes the form of:
 
 { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-  &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.
+  &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.
     &quot;A String&quot;,
   ],
   &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>
   An object of the form:
 
     { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-  &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.
+  &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.
     &quot;A String&quot;,
   ],
   &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>
   An object of the form:
 
     { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-  &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.
+  &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.
     &quot;A String&quot;,
   ],
   &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>
     { # Response for ListControls method.
   &quot;controls&quot;: [ # All the Controls for a given catalog.
     { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-      &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.
+      &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.
         &quot;A String&quot;,
       ],
       &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>
     The object takes the form of:
 
 { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-  &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.
+  &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.
     &quot;A String&quot;,
   ],
   &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>
   An object of the form:
 
     { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-  &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.
+  &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.
     &quot;A String&quot;,
   ],
   &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.

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html
@@ -97,7 +97,7 @@ <h3>Method Details</h3>
   <pre>Makes a recommendation prediction.
 
 Args:
-  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)
+  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)
   body: object, The request body.
     The object takes the form of:
 
@@ -364,7 +364,7 @@ <h3>Method Details</h3>
   <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.
 
 Args:
-  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)
+  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)
   body: object, The request body.
     The object takes the form of:
 

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
@@ -572,7 +572,7 @@ <h3>Method Details</h3>
   <pre>Makes a recommendation prediction.
 
 Args:
-  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)
+  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)
   body: object, The request body.
     The object takes the form of:
 
@@ -907,7 +907,7 @@ <h3>Method Details</h3>
   <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.
 
 Args:
-  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)
+  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)
   body: object, The request body.
     The object takes the form of:
 

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html
@@ -90,7 +90,7 @@ <h2>Instance Methods</h2>
   <code><a href="#rejoin">rejoin(parent, body=None, x__xgafv=None)</a></code></p>
 <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>
 <p class="toc_element">
-  <code><a href="#write">write(parent, body=None, x__xgafv=None)</a></code></p>
+  <code><a href="#write">write(parent, body=None, writeAsync=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Writes a single user event.</p>
 <h3>Method Details</h3>
 <div class="method">
@@ -502,7 +502,7 @@ <h3>Method Details</h3>
 </div>
 
 <div class="method">
-    <code class="details" id="write">write(parent, body=None, x__xgafv=None)</code>
+    <code class="details" id="write">write(parent, body=None, writeAsync=None, x__xgafv=None)</code>
   <pre>Writes a single user event.
 
 Args:
@@ -731,6 +731,7 @@ <h3>Method Details</h3>
   &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.
 }
 
+  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.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html
@@ -111,7 +111,7 @@ <h3>Method Details</h3>
     The object takes the form of:
 
 { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-  &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.
+  &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.
     &quot;A String&quot;,
   ],
   &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>
   An object of the form:
 
     { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-  &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.
+  &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.
     &quot;A String&quot;,
   ],
   &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>
   An object of the form:
 
     { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-  &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.
+  &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.
     &quot;A String&quot;,
   ],
   &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>
     { # Response for ListControls method.
   &quot;controls&quot;: [ # All the Controls for a given catalog.
     { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-      &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.
+      &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.
         &quot;A String&quot;,
       ],
       &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>
     The object takes the form of:
 
 { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-  &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.
+  &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.
     &quot;A String&quot;,
   ],
   &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>
   An object of the form:
 
     { # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
-  &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.
+  &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.
     &quot;A String&quot;,
   ],
   &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.