Vertex AI API (aiplatform:v1)

Additions

Methods


• ▼ ▲ aiplatform.projects.locations.tuningJobs.list

  Path: v1/{+parent}/tuningJobs

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tuningJobs

  Parameters:

  pageSize

  Description: Optional. The standard list page size.

  Location: query

  Type: integer

  Format: int32

  parent

  Description: Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`

  Required: Yes

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

  Location: path

  Type: string

  filter

  Type: string

  Description: Optional. The standard list filter.

  Location: query

  pageToken

  Location: query

  Type: string

  Description: Optional. The standard list page token. Typically obtained via ListTuningJob.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.

  Description: Lists TuningJobs in a Location.

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

  HTTP Method: GET

  Parameter Order: parent

• ▼ ▲ aiplatform.projects.locations.tuningJobs.cancel

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

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel

  Parameter Order: name

  HTTP Method: POST

  Path: v1/{+name}:cancel

  Parameters:

  name

  Location: path

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

  Required: Yes

  Type: string

  Description: Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`

  Description: Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.

• ▼ ▲ aiplatform.projects.locations.tuningJobs.create

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tuningJobs

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

  Path: v1/{+parent}/tuningJobs

  Description: Creates a TuningJob. A created TuningJob right away will be attempted to be run.

  HTTP Method: POST

  Parameters:

  parent

  Description: Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`

  Type: string

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

  Required: Yes

  Location: path

  Parameter Order: parent

• ▼ ▲ aiplatform.projects.locations.tuningJobs.get

  HTTP Method: GET

  Path: v1/{+name}

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

  Description: Gets a TuningJob.

  Parameters:

  name

  Location: path

  Type: string

  Description: Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`

  Required: Yes

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

  Flat Path: v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}

  Parameter Order: name