Vertex AI API (aiplatform:v1)

2023-12-23

4 new methods | 2 removed methods

Additions

    Methods
  • aiplatform.projects.locations.tensorboards.experiments.batchCreate

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate

      Parameter Order : parent

      Path : v1/{+parent}:batchCreate

      Description : Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

      Parameters :

        parent

          Description : Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.

          Location : path

          Required : Yes

          Type : string

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

      HTTP Method : POST

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

  • aiplatform.projects.locations.tensorboards.batchRead

      Parameters :

        tensorboard

          Description : Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.

          Required : Yes

          Type : string

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

          Location : path

        timeSeries

          Location : query

          Description : Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`

          Repeated : Yes

          Type : string

      Description : Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead

      Path : v1/{+tensorboard}:batchRead

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

      Parameter Order : tensorboard

  • aiplatform.projects.locations.publishers.models.streamGenerateContent

      Parameters :

        model

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

          Type : string

          Required : Yes

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

          Location : path

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

      Description : Generate content with multimodal inputs with streaming support.

      HTTP Method : POST

      Path : v1/{+model}:streamGenerateContent

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

      Parameter Order : model

  • aiplatform.projects.locations.endpoints.streamGenerateContent

      Path : v1/{+model}:streamGenerateContent

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

      HTTP Method : POST

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

      Parameter Order : model

      Parameters :

        model

          Type : string

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

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

          Required : Yes

          Location : path

      Description : Generate content with multimodal inputs with streaming support.

Deletions

    Methods
  • aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.batchCreate

      Path : v1/{+parent}/runs/{runsId}/timeSeries:batchCreate

      Parameter Order :

    • parent
    • runsId
    • Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries:batchCreate

      Parameters :

        runsId

          Location : path

          Required : Yes

          Type : string

        parent

          Required : Yes

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

          Type : string

          Description : Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.

          Location : path

      Description : Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

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

      HTTP Method : POST

  • aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.batchRead

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries:batchRead

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

      Path : v1/{+tensorboard}/experiments/{experimentsId}/runs/{runsId}/timeSeries:batchRead

      HTTP Method : GET

      Parameters :

        timeSeries

          Location : query

          Repeated : Yes

          Type : string

          Description : Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`

        experimentsId

          Location : path

          Type : string

          Required : Yes

        runsId

          Type : string

          Required : Yes

          Location : path

        tensorboard

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

          Required : Yes

          Description : Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.

          Type : string

          Location : path

      Parameter Order :

    • tensorboard
    • experimentsId
    • runsId
    • Description : Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.