Vertex AI API (aiplatform:v1)

2024-11-02

6 new methods

Additions

    Methods
  • aiplatform.projects.updateCacheConfig

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/cacheConfig

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Updates a cache config.

  • aiplatform.projects.getCacheConfig

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/cacheConfig

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets a GenAI cache config.

  • aiplatform.projects.locations.endpoints.predictLongRunning

      Path: v1/{+endpoint}:predictLongRunning

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning

      HTTP Method: POST

      Parameters:

        endpoint

          Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: endpoint

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
  • aiplatform.projects.locations.endpoints.fetchPredictOperation

      Path: v1/{+endpoint}:fetchPredictOperation

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation

      HTTP Method: POST

      Parameters:

        endpoint

          Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: endpoint

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description: Fetch an asynchronous online prediction operation.

  • aiplatform.projects.locations.publishers.models.predictLongRunning

      Path: v1/{+endpoint}:predictLongRunning

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning

      HTTP Method: POST

      Parameters:

        endpoint

          Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: endpoint

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
  • aiplatform.projects.locations.publishers.models.fetchPredictOperation

      Path: v1/{+endpoint}:fetchPredictOperation

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation

      HTTP Method: POST

      Parameters:

        endpoint

          Description: Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: endpoint

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description: Fetch an asynchronous online prediction operation.