2022-03-22
▼ ▲ retail.projects.locations.catalogs.getCompletionConfig
HTTP Method: GET
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionConfig
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Parameters:
name
Location: path
Type: string
Description: Required. Full CompletionConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/completionConfig$
Required: Yes
Path: v2beta/{+name}
Description: Gets a CompletionConfig.
▼ ▲ retail.projects.locations.catalogs.updateCompletionConfig
Parameters:
updateMask
Description: Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.
Location: query
Format: google-fieldmask
Type: string
name
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/completionConfig$
Required: Yes
Type: string
Description: Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig
Location: path
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionConfig
Parameter Order: name
HTTP Method: PATCH
Path: v2beta/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the CompletionConfigs.
▼ ▲ retail.projects.locations.catalogs.servingConfigs.predict
Description: Makes a recommendation prediction.
Parameter Order: placement
Parameters:
placement
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Description: Required. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/placements/*} or {name=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*} The ID of the Recommendations AI placement. Before you can request predictions from your model, you must create at least one placement for it. For more information, see [Managing placements](https://cloud.google.com/retail/recommendations-ai/docs/manage-placements). The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
Type: string
Required: Yes
Location: path
HTTP Method: POST
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:predict
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2beta/{+placement}:predict
▼ ▲ retail.projects.locations.catalogs.servingConfigs.search
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
placement
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$
Location: path
Description: Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving configuration name and the set of models that will be used to make the search.
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:search
Parameter Order: placement
Description: Performs a search. This feature is only available for users who have Retail Search enabled. Please submit a form [here](https://cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.
Path: v2beta/{+placement}:search