2022-08-23
▼ ▲ retail.projects.locations.catalogs.models.pause
Parameters:
name
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$
Required: Yes
Description: Required. The name of the model to pause. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
Parameter Order: name
Path: v2beta/{+name}:pause
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Pauses the training of an existing model.
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:pause
▼ ▲ retail.projects.locations.catalogs.models.list
Path: v2beta/{+parent}/models
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models
Description: Lists all the models linked to this event store.
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Description: Required. The parent for which to list models. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Location: path
Required: Yes
pageToken
Description: Optional. A page token, received from a previous `ListModels` call. Provide this to retrieve the subsequent page.
Type: string
Location: query
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.
Parameter Order: parent
▼ ▲ retail.projects.locations.catalogs.models.tune
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:tune
Path: v2beta/{+name}:tune
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Tunes an existing model.
Parameters:
name
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
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$
Required: Yes
Type: string
Parameter Order: name
▼ ▲ retail.projects.locations.catalogs.models.resume
Path: v2beta/{+name}:resume
HTTP Method: POST
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}:resume
Parameter Order: name
Description: Resumes the training of an existing model.
Parameters:
name
Type: string
Location: path
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}`
Required: Yes
▼ ▲ retail.projects.locations.catalogs.models.patch
Path: v2beta/{+name}
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.
HTTP Method: PATCH
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
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
Location: query
Description: Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.
Type: string
▼ ▲ retail.projects.locations.catalogs.models.create
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$
Description: Required. The parent resource under which to create the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
Required: Yes
dryRun
Description: Optional. Whether to run a dry run to validate the request (without actually creating the model).
Location: query
Type: boolean
Description: Creates a new model.
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models
Parameter Order: parent
Path: v2beta/{+parent}/models
▼ ▲ retail.projects.locations.catalogs.models.delete
Parameter Order: name
Path: v2beta/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/models/[^/]+$
Required: Yes
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}`
Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/models/{modelsId}
Description: Deletes an existing model.