Vertex AI API (aiplatform:v1)

2023-11-18

5 new methods

Additions

    Methods
  • aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels

      Path : v1/{+deploymentResourcePool}:queryDeployedModels

      Description : List DeployedModels that have been deployed on this DeploymentResourcePool.

      HTTP Method : GET

      Parameter Order : deploymentResourcePool

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels

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

      Parameters :

        pageSize

          Location : query

          Format : int32

          Type : integer

          Description : The maximum number of DeployedModels to return. The service may return fewer than this value.

        pageToken

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

          Type : string

          Location : query

        deploymentResourcePool

          Description : Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`

          Required : Yes

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

          Type : string

          Location : path

  • aiplatform.projects.locations.deploymentResourcePools.create

      Parameter Order : parent

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

      Parameters :

        parent

          Location : path

          Type : string

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

          Required : Yes

          Description : Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`

      HTTP Method : POST

      Description : Create a DeploymentResourcePool.

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

      Path : v1/{+parent}/deploymentResourcePools

  • aiplatform.projects.locations.deploymentResourcePools.list

      Parameter Order : parent

      Path : v1/{+parent}/deploymentResourcePools

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

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`

          Required : Yes

          Location : path

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

          Type : string

        pageSize

          Type : integer

          Description : The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.

          Location : query

          Format : int32

        pageToken

          Type : string

          Location : query

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

      Description : List DeploymentResourcePools in a location.

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

  • aiplatform.projects.locations.deploymentResourcePools.get

      Description : Get a DeploymentResourcePool.

      HTTP Method : GET

      Parameters :

        name

          Location : path

          Description : Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`

          Type : string

          Required : Yes

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}

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

      Path : v1/{+name}

      Parameter Order : name

  • aiplatform.projects.locations.deploymentResourcePools.delete

      HTTP Method : DELETE

      Parameters :

        name

          Required : Yes

          Location : path

          Type : string

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

          Description : Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`

      Parameter Order : name

      Description : Delete a DeploymentResourcePool.

      Path : v1/{+name}

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

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}