Vertex AI API (aiplatform:v1beta1)

2024-06-02

7 new methods

Additions

    Methods
  • aiplatform.projects.locations.notebookRuntimeTemplates.patch

      HTTP Method: PATCH

      Parameter Order: name

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

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}

      Parameters:

        updateMask

          Type: string

          Format: google-fieldmask

          Description: Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_filed}"}` Updatable fields: * `encryption_spec.kms_key_name`

          Location: query

        name

          Type: string

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

          Description: The resource name of the NotebookRuntimeTemplate.

          Required: Yes

          Location: path

      Path: v1beta1/{+name}

      Description: Updates a NotebookRuntimeTemplate.

  • aiplatform.projects.locations.cachedContents.patch

      Parameter Order: name

      HTTP Method: PATCH

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

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}

      Path: v1beta1/{+name}

      Description: Updates cached content configurations

      Parameters:

        updateMask

          Type: string

          Location: query

          Format: google-fieldmask

          Description: Required. The list of fields to update.

        name

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

          Type: string

          Description: Immutable. Identifier. The resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}

          Required: Yes

          Location: path

  • aiplatform.projects.locations.cachedContents.create

      Description: Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.

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

      HTTP Method: POST

      Parameters:

        parent

          Type: string

          Location: path

          Required: Yes

          Description: Required. The parent resource where the cached content will be created

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

      Parameter Order: parent

      Path: v1beta1/{+parent}/cachedContents

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

  • aiplatform.projects.locations.cachedContents.list

      HTTP Method: GET

      Parameters:

        pageSize

          Type: integer

          Description: Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Format: int32

          Location: query

        parent

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

          Type: string

          Description: Required. The parent, which owns this collection of cached contents.

          Required: Yes

          Location: path

        pageToken

          Type: string

          Location: query

          Description: Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.

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

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

      Parameter Order: parent

      Description: Lists cached contents in a project

      Path: v1beta1/{+parent}/cachedContents

  • aiplatform.projects.locations.cachedContents.get

      Parameter Order: name

      Parameters:

        name

          Location: path

          Description: Required. The resource name referring to the cached content

          Required: Yes

          Type: string

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

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

      HTTP Method: GET

      Path: v1beta1/{+name}

      Description: Gets cached content configurations

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}

  • aiplatform.projects.locations.cachedContents.delete

      Parameter Order: name

      HTTP Method: DELETE

      Path: v1beta1/{+name}

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}

      Parameters:

        name

          Location: path

          Required: Yes

          Description: Required. The resource name referring to the cached content

          Type: string

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

      Description: Deletes cached content

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

  • aiplatform.projects.locations.notebookExecutionJobs.create

      Parameters:

        parent

          Required: Yes

          Location: path

          Type: string

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

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

        notebookExecutionJobId

          Description: Optional. User specified ID for the NotebookExecutionJob.

          Type: string

          Location: query

      Parameter Order: parent

      Description: Creates a NotebookExecutionJob.

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

      Path: v1beta1/{+parent}/notebookExecutionJobs

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

      HTTP Method: POST