You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#### 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)
Copy file name to clipboardexpand all lines: docs/dyn/retail_v2.projects.locations.catalogs.controls.html
+6-6
Original file line number
Diff line number
Diff line change
@@ -111,7 +111,7 @@ <h3>Method Details</h3>
111
111
The object takes the form of:
112
112
113
113
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
114
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
115
115
"A String",
116
116
],
117
117
"displayName": "A String", # 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>
199
199
An object of the form:
200
200
201
201
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
202
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
203
203
"A String",
204
204
],
205
205
"displayName": "A String", # 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>
311
311
An object of the form:
312
312
313
313
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
314
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
315
315
"A String",
316
316
],
317
317
"displayName": "A String", # 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>
410
410
{ # Response for ListControls method.
411
411
"controls": [ # All the Controls for a given catalog.
412
412
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
413
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
414
414
"A String",
415
415
],
416
416
"displayName": "A String", # 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>
516
516
The object takes the form of:
517
517
518
518
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
519
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
520
520
"A String",
521
521
],
522
522
"displayName": "A String", # 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>
604
604
An object of the form:
605
605
606
606
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
607
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
608
608
"A String",
609
609
],
610
610
"displayName": "A String", # 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.
Copy file name to clipboardexpand all lines: docs/dyn/retail_v2.projects.locations.catalogs.placements.html
+2-2
Original file line number
Diff line number
Diff line change
@@ -97,7 +97,7 @@ <h3>Method Details</h3>
97
97
<pre>Makes a recommendation prediction.
98
98
99
99
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)
101
101
body: object, The request body.
102
102
The object takes the form of:
103
103
@@ -364,7 +364,7 @@ <h3>Method Details</h3>
364
364
<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.
365
365
366
366
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)
Copy file name to clipboardexpand all lines: docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
+2-2
Original file line number
Diff line number
Diff line change
@@ -572,7 +572,7 @@ <h3>Method Details</h3>
572
572
<pre>Makes a recommendation prediction.
573
573
574
574
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)
576
576
body: object, The request body.
577
577
The object takes the form of:
578
578
@@ -907,7 +907,7 @@ <h3>Method Details</h3>
907
907
<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.
908
908
909
909
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)
<pclass="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>
"visitorId": "A String", # 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'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.
732
732
}
733
733
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.
Copy file name to clipboardexpand all lines: docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html
+6-6
Original file line number
Diff line number
Diff line change
@@ -111,7 +111,7 @@ <h3>Method Details</h3>
111
111
The object takes the form of:
112
112
113
113
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
114
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
115
115
"A String",
116
116
],
117
117
"displayName": "A String", # 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>
230
230
An object of the form:
231
231
232
232
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
233
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
234
234
"A String",
235
235
],
236
236
"displayName": "A String", # 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>
373
373
An object of the form:
374
374
375
375
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
376
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
377
377
"A String",
378
378
],
379
379
"displayName": "A String", # 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>
503
503
{ # Response for ListControls method.
504
504
"controls": [ # All the Controls for a given catalog.
505
505
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
506
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
507
507
"A String",
508
508
],
509
509
"displayName": "A String", # 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>
640
640
The object takes the form of:
641
641
642
642
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
643
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
644
644
"A String",
645
645
],
646
646
"displayName": "A String", # 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>
759
759
An object of the form:
760
760
761
761
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
762
-
"associatedServingConfigIds": [ # 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
+
"associatedServingConfigIds": [ # 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.
763
763
"A String",
764
764
],
765
765
"displayName": "A String", # 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