Vertex AI API (aiplatform:v1beta1)

2023-12-23

2 new methods | 2 removed methods

Additions

    Methods

  • ▼ ▲ aiplatform.projects.locations.tensorboards.experiments.batchCreate

      Parameter Order : parent

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

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

      Path : v1beta1/{+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.

          Type : string

          Location : path

          Required : Yes

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

      HTTP Method : POST

  • ▼ ▲ aiplatform.projects.locations.tensorboards.batchRead

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

      Parameter Order : tensorboard

      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.

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

      Parameters :

        timeSeries

          Repeated : Yes

          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}`

          Type : string

        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

          Location : path

          Type : string

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

      HTTP Method : GET

      Path : v1beta1/{+tensorboard}:batchRead

Deletions

    Methods

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

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

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

      HTTP Method : GET

      Parameters :

        experimentsId

          Location : path

          Type : string

          Required : Yes

        timeSeries

          Repeated : Yes

          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}`

          Type : string

        runsId

          Location : path

          Type : string

          Required : Yes

        tensorboard

          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.

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

          Type : string

          Location : path

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

      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.

      Parameter Order :

    • tensorboard
    • experimentsId
    • runsId

  • ▼ ▲ aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.batchCreate

      Description : Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

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

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

      Parameter Order :

    • parent
    • runsId

      • HTTP Method : POST

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

      Parameters :

        runsId

          Type : string

          Required : Yes

          Location : path

        parent

          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

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

          Required : Yes