Retail API (retail:v2alpha)

2022-03-22

4 new methods

Additions

    Methods
  • retail.projects.locations.catalogs.getCompletionConfig

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionConfig

      Path: v2alpha/{+name}

      Description: Gets a CompletionConfig.

      HTTP Method: GET

      Parameter Order: name

      Parameters:

        name

          Description: Required. Full CompletionConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/completionConfig$

          Type: string

          Location: path

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • retail.projects.locations.catalogs.updateCompletionConfig

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Parameters:

        updateMask

          Type: string

          Location: query

          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.

          Format: google-fieldmask

        name

          Type: string

          Required: Yes

          Location: path

          Description: Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

          Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/completionConfig$

      HTTP Method: PATCH

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/completionConfig

      Description: Updates the CompletionConfigs.

      Path: v2alpha/{+name}

  • retail.projects.locations.catalogs.servingConfigs.predict

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:predict

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v2alpha/{+placement}:predict

      HTTP Method: POST

      Parameter Order: placement

      Parameters:

        placement

          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

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$

          Type: string

          Location: path

      Description: Makes a recommendation prediction.

  • retail.projects.locations.catalogs.servingConfigs.search

      HTTP Method: POST

      Parameter Order: placement

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v2alpha/{+placement}:search

      Parameters:

        placement

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$

          Type: string

          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.

      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.

      Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:search