2024-03-27
▼ ▲ discoveryengine.projects.locations.collections.engines.pause
Path: v1beta/{+name}:pause
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:pause
HTTP Method: POST
Parameters:
name
Description: Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
▼ ▲ discoveryengine.projects.locations.collections.engines.resume
Path: v1beta/{+name}:resume
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:resume
HTTP Method: POST
Parameters:
name
Description: Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
▼ ▲ discoveryengine.projects.locations.collections.engines.tune
Path: v1beta/{+name}:tune
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}:tune
HTTP Method: POST
Parameters:
name
Description: Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
▼ ▲ discoveryengine.projects.locations.rankingConfigs.rank
Path: v1beta/{+rankingConfig}:rank
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/rankingConfigs/{rankingConfigsId}:rank
HTTP Method: POST
Parameters:
rankingConfig
Description: Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
Pattern: ^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: rankingConfig
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Ranks a list of text records based on the given input query.