Retail API (retail:v2)

Additions

Methods


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

  Parameter Order: name

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

  Parameters:

  name

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

  Location: path

  Required: Yes

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

  Type: string

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

  Description: Pauses the training of an existing model.

  HTTP Method: POST

  Path: v2/{+name}:pause

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

  HTTP Method: DELETE

  Description: Deletes an existing model.

  Parameters:

  name

  Required: Yes

  Location: path

  Type: string

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

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

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

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

  Parameter Order: name

  Path: v2/{+name}

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

  Path: v2/{+parent}/models

  Parameter Order: parent

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

  HTTP Method: GET

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

  Parameters:

  pageToken

  Location: query

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

  Type: string

  parent

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

  Type: string

  Required: Yes

  Location: path

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

  pageSize

  Location: query

  Format: int32

  Type: integer

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

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

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

  Parameters:

  name

  Location: path

  Required: Yes

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

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

  Type: string

  Description: Resumes the training of an existing model.

  Parameter Order: name

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

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

  HTTP Method: POST

  Path: v2/{+name}:resume

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

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

  Parameters:

  name

  Location: path

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

  Required: Yes

  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}`

  HTTP Method: POST

  Description: Tunes an existing model.

  Parameter Order: name

  Path: v2/{+name}:tune

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

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

  Parameters:

  name

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

  Required: Yes

  Type: string

  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

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

  Type: string

  Location: query

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

  Parameter Order: name

  HTTP Method: PATCH

  Path: v2/{+name}

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

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

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

  Description: Creates a new model.

  Parameter Order: parent

  Path: v2/{+parent}/models

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

  HTTP Method: POST

  Parameters:

  dryRun

  Location: query

  Type: boolean

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

  parent

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

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

  Location: path

  Type: string

  Required: Yes

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