Vertex AI Search for Retail API (retail:v2alpha)

Additions

Methods


• ▼ ▲ retail.projects.locations.catalogs.models.resume

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

  Description : Resumes the training of an existing model.

  Parameters :

  name

  Required : Yes

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

  Description : Required. The name of the model to resume. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

  Type : string

  Location : path

  HTTP Method : POST

  Path : v2alpha/{+name}:resume

  Parameter Order : name

  Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:resume

• ▼ ▲ retail.projects.locations.catalogs.models.delete

  Parameter Order : name

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

  HTTP Method : DELETE

  Path : v2alpha/{+name}

  Description : Deletes an existing model.

  Parameters :

  name

  Location : path

  Description : Required. The resource name of the [Model] to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

  Type : string

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

  Required : Yes

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

• ▼ ▲ retail.projects.locations.catalogs.models.tune

  HTTP Method : POST

  Parameter Order : name

  Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:tune

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

  Description : Tunes an existing model.

  Path : v2alpha/{+name}:tune

  Parameters :

  name

  Type : string

  Description : Required. The resource name of the model to tune. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

  Location : path

  Required : Yes

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

• ▼ ▲ retail.projects.locations.catalogs.models.create

  Description : Creates a new model.

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

  Parameters :

  parent

  Description : Required. The parent resource under which to create the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

  Location : path

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

  Required : Yes

  Type : string

  dryRun

  Description : Optional. Whether to run a dry_run to validate the request (without actually creating the model).

  Type : boolean

  Location : query

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

  Path : v2alpha/{+parent}/models

  HTTP Method : POST

  Parameter Order : parent

• ▼ ▲ retail.projects.locations.catalogs.models.patch

  HTTP Method : PATCH

  Parameter Order : name

  Parameters :

  name

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

  Type : string

  Required : Yes

  Location : path

  Description : Required. The fully qualified resource name of the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} catalog_id has char limit of 50. recommendation_model_id has char limit of 40.

  updateMask

  Format : google-fieldmask

  Type : string

  Description : Optional. Indicates which fields in the provided 'model' to update. If not set, will by default update all fields.

  Location : query

  Path : v2alpha/{+name}

  Description : Update of model metadata. Only fields that currently can be updated are: filtering_option, periodic_tuning_state. If other values are provided, this API method will ignore them.

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

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

• ▼ ▲ retail.projects.locations.catalogs.models.pause

  Path : v2alpha/{+name}:pause

  Parameters :

  name

  Location : path

  Type : string

  Description : Required. The name of the model to pause. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

  Required : Yes

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

  Description : Pauses the training of an existing model.

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

  Flat Path : v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:pause

  Parameter Order : name

  HTTP Method : POST

• ▼ ▲ retail.projects.locations.catalogs.models.list

  Parameters :

  parent

  Description : Required. The parent for which to list models. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

  Required : Yes

  Location : path

  Type : string

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

  pageToken

  Description : Optional. A page token, received from a previous `ListModels` call. Provide this to retrieve the subsequent page.

  Location : query

  Type : string

  pageSize

  Type : integer

  Description : Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

  Location : query

  Format : int32

  HTTP Method : GET

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

  Parameter Order : parent

  Path : v2alpha/{+parent}/models

  Description : Lists all the models linked to this event store.

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