Vertex AI Search for Retail API (retail:v2)

2022-06-14

2 new methods

Additions

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

      Parameter Order : placement

      Path : v2/{+placement}:search

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

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

      Parameters :

        placement

          Description : 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.

          Type : string

          Required : Yes

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

          Location : path

      Description : Performs a search. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

      HTTP Method : POST

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

      Parameters :

        placement

          Type : string

          Description : 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 : Yes

          Location : path

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

      Path : v2/{+placement}:predict

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

      HTTP Method : POST

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

      Parameter Order : placement

      Description : Makes a recommendation prediction.