feat(retail): update the api

#### retail:v2 The following keys were added: - schemas.GoogleCloudRetailV2CatalogAttributeFacetConfig.properties.rerankConfig.$ref (Total Keys: 1) - schemas.GoogleCloudRetailV2CatalogAttributeFacetConfigRerankConfig (Total Keys: 5) #### retail:v2alpha The following keys were added: - schemas.GoogleCloudRetailV2alphaCatalogAttributeFacetConfig.properties.rerankConfig.$ref (Total Keys: 1) - schemas.GoogleCloudRetailV2alphaCatalogAttributeFacetConfigRerankConfig (Total Keys: 5) #### retail:v2beta The following keys were added: - schemas.GoogleCloudRetailV2betaCatalogAttributeFacetConfig.properties.rerankConfig.$ref (Total Keys: 1) - schemas.GoogleCloudRetailV2betaCatalogAttributeFacetConfigRerankConfig (Total Keys: 5)
googleapis · Jan 16, 2024 · 7e71044 · 7e71044
1 parent 0c4590d
commit 7e71044
Show file tree

Hide file tree

Showing 9 changed files with 213 additions and 3 deletions.
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html
@@ -126,6 +126,12 @@ <h3>Method Details</h3>
           ],
         },
       ],
+      &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
+        &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
+          &quot;A String&quot;,
+        ],
+        &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
+      },
     },
     &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
     &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
@@ -176,6 +182,12 @@ <h3>Method Details</h3>
             ],
           },
         ],
+        &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
+          &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
+            &quot;A String&quot;,
+          ],
+          &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
+        },
       },
       &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
       &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
@@ -247,6 +259,12 @@ <h3>Method Details</h3>
             ],
           },
         ],
+        &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
+          &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
+            &quot;A String&quot;,
+          ],
+          &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
+        },
       },
       &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
       &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
@@ -299,6 +317,12 @@ <h3>Method Details</h3>
           ],
         },
       ],
+      &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
+        &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
+          &quot;A String&quot;,
+        ],
+        &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
+      },
     },
     &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
     &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
@@ -350,6 +374,12 @@ <h3>Method Details</h3>
             ],
           },
         ],
+        &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
+          &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
+            &quot;A String&quot;,
+          ],
+          &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
+        },
       },
       &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
       &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.html b/docs/dyn/retail_v2.projects.locations.catalogs.html
@@ -252,6 +252,12 @@ <h3>Method Details</h3>
             ],
           },
         ],
+        &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
+          &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
+            &quot;A String&quot;,
+          ],
+          &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
+        },
       },
       &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
       &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
@@ -504,6 +510,12 @@ <h3>Method Details</h3>
             ],
           },
         ],
+        &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
+          &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
+            &quot;A String&quot;,
+          ],
+          &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
+        },
       },
       &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
       &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
@@ -557,6 +569,12 @@ <h3>Method Details</h3>
             ],
           },
         ],
+        &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
+          &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
+            &quot;A String&quot;,
+          ],
+          &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
+        },
       },
       &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
       &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.