Vertex AI API (aiplatform:v1)

2023-09-27

5 new methods

Additions

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

      Description: Create a version from a Dataset.

      Path: v1/{+parent}/datasetVersions

      Parameter Order: parent

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

      HTTP Method: POST

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

      Parameters:

        parent

          Description: Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`

          Type: string

          Location: path

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

          Required: Yes

  • aiplatform.projects.locations.datasets.datasetVersions.restore

      HTTP Method: GET

      Path: v1/{+name}:restore

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

      Description: Restores a dataset version.

      Parameters:

        name

          Description: Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`

          Type: string

          Required: Yes

          Location: path

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

      Parameter Order: name

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

  • aiplatform.projects.locations.datasets.datasetVersions.delete

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

      Parameters:

        name

          Required: Yes

          Description: Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`

          Type: string

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

          Location: path

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

      HTTP Method: DELETE

      Description: Deletes a Dataset version.

      Path: v1/{+name}

      Parameter Order: name

  • aiplatform.projects.locations.datasets.datasetVersions.get

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

      Parameter Order: name

      HTTP Method: GET

      Path: v1/{+name}

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

      Parameters:

        readMask

          Description: Mask specifying which fields to read.

          Format: google-fieldmask

          Location: query

          Type: string

        name

          Type: string

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

          Location: path

          Required: Yes

          Description: Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`

      Description: Gets a Dataset version.

  • aiplatform.projects.locations.datasets.datasetVersions.list

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

      HTTP Method: GET

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

      Description: Lists DatasetVersions in a Dataset.

      Path: v1/{+parent}/datasetVersions

      Parameter Order: parent

      Parameters:

        orderBy

          Description: Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.

          Type: string

          Location: query

        filter

          Description: Optional. The standard list filter.

          Location: query

          Type: string

        pageSize

          Type: integer

          Format: int32

          Description: Optional. The standard list page size.

          Location: query

        parent

          Description: Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`

          Location: path

          Type: string

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

          Required: Yes

        readMask

          Format: google-fieldmask

          Location: query

          Description: Optional. Mask specifying which fields to read.

          Type: string

        pageToken

          Location: query

          Type: string

          Description: Optional. The standard list page token.