Vertex AI API (aiplatform:v1beta1)

2024-05-10

5 new methods

Additions

    Methods
  • aiplatform.projects.locations.datasets.datasetVersions.patch

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

      HTTP Method : PATCH

      Path : v1beta1/{+name}

      Parameters :

        name

          Description : Output only. The resource name of the DatasetVersion.

          Type : string

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

          Location : path

          Required : Yes

        updateMask

          Type : string

          Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`

          Location : query

          Format : google-fieldmask

      Description : Updates a DatasetVersion.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}

      Parameter Order : name

  • aiplatform.projects.locations.tuningJobs.list

      Path : v1beta1/{+parent}/tuningJobs

      Parameter Order : parent

      HTTP Method : GET

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

      Description : Lists TuningJobs in a Location.

      Parameters :

        filter

          Description : Optional. The standard list filter.

          Type : string

          Location : query

        pageSize

          Format : int32

          Type : integer

          Description : Optional. The standard list page size.

          Location : query

        parent

          Required : Yes

          Location : path

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

          Type : string

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

        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.

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

  • aiplatform.projects.locations.tuningJobs.cancel

      Parameters :

        name

          Location : path

          Required : Yes

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

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

          Type : string

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

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

      Parameter Order : name

      Path : v1beta1/{+name}:cancel

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

      HTTP Method : POST

  • aiplatform.projects.locations.tuningJobs.create

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

      Parameters :

        parent

          Location : path

          Required : Yes

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

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

          Type : string

      Path : v1beta1/{+parent}/tuningJobs

      HTTP Method : POST

      Parameter Order : parent

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

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

  • aiplatform.projects.locations.tuningJobs.get

      Path : v1beta1/{+name}

      Parameters :

        name

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

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

          Required : Yes

          Location : path

          Type : string

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

      Description : Gets a TuningJob.

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

      Parameter Order : name

      HTTP Method : GET