Vertex AI API (aiplatform:v1beta1)

2025-08-19

6 new methods | 1 updated method

Additions

    Methods
  • aiplatform.projects.locations.generateSyntheticData

      Path : v1beta1/{+location}:generateSyntheticData

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

      HTTP Method : POST

      Parameters :

        location

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : location

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

      Description : Generates synthetic data based on the provided configuration.

  • aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create

      Path : v1beta1/{+parent}/sandboxEnvironments

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Creates a SandboxEnvironment in a given reasoning engine.

  • aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets details of the specific SandboxEnvironment.

  • aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list

      Path : v1beta1/{+parent}/sandboxEnvironments

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`

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

          Location : path

          Required : Yes

          Type : string

        filter

          Description : Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).

          Location : query

          Type : string

        pageSize

          Description : Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Lists SandboxEnvironments in a given reasoning engine.

  • aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deletes the specific SandboxEnvironment.

  • aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute

      Path : v1beta1/{+name}:execute

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Executes using a sandbox environment.

Updates

    Methods
  • aiplatform.projects.locations.ragCorpora.ragFiles.delete

      Parameters :

        forceDelete

          Description : Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false.

          Location : query

          Type : boolean