Agent Platform API (aiplatform:v1beta1)

2026-05-30

9 new methods | 10 removed methods

Additions

    Methods
  • aiplatform.projects.locations.getSemanticGovernancePolicyEngine

      Path : v1beta1/{+name}

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

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.

  • aiplatform.projects.locations.updateSemanticGovernancePolicyEngine

      Path : v1beta1/{+name}

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

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. Specifies the fields to be overwritten in the SemanticGovernancePolicyEngine resource by the update. The fields specified in the update_mask are relative to the resource itself. If no update_mask is provided, all fields are overwritten.

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.

  • aiplatform.projects.locations.tuningJobs.processData

      Path : v1beta1/{+parent}/tuningJobs:processData

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:processData

      HTTP Method : POST

      Parameters :

        parent

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

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Processes data from a user's Cloud Storage bucket and saves the result to a destination Cloud Storage bucket. This method returns a long-running operation, and the `ProcessDataResponse` will be returned upon completion.

  • aiplatform.projects.locations.semanticGovernancePolicyEngine.deprovision

      Path : v1beta1/{+name}:deprovision

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine:deprovision

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The resource name of the SemanticGovernancePolicyEngine to deprovision. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deprovisions the SemanticGovernancePolicyEngine, tearing down the associated tenant project, GKE cluster, and PSC service attachments. This operation is irreversible. Returns a long-running operation; poll for completion. The response contains the SemanticGovernancePolicyEngine in DEPROVISIONING state.

  • aiplatform.projects.locations.semanticGovernancePolicies.create

      Path : v1beta1/{+parent}/semanticGovernancePolicies

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

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the Location into which to create the SemanticGovernancePolicy. Format: `projects/{project}/locations/{location}`

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

          Location : path

          Required : Yes

          Type : string

        semanticGovernancePolicyId

          Description : Required. The ID to use for the SemanticGovernancePolicy, which will become the final component of the SemanticGovernancePolicy's resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character cannot be a number or hyphen. The last character must be a letter or a number.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Creates a SemanticGovernancePolicy.

  • aiplatform.projects.locations.semanticGovernancePolicies.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the SemanticGovernancePolicy resource. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets a SemanticGovernancePolicy.

  • aiplatform.projects.locations.semanticGovernancePolicies.list

      Path : v1beta1/{+parent}/semanticGovernancePolicies

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

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The resource name of the Location from which to list the SemanticGovernancePolicies. Format: `projects/{project}/locations/{location}`

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

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Optional. The list page size. If zero, a default page size of 10 is used.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : Optional. The standard list page token.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Lists SemanticGovernancePolicies in a given location.

  • aiplatform.projects.locations.semanticGovernancePolicies.patch

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. Resource name of the SemanticGovernancePolicy.

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

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. `update_mask` is used to specify the fields to be overwritten in the SemanticGovernancePolicy resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the mask is not present, then all fields that are populated in the request message will be overwritten. Set the `update_mask` to `*` to override all fields.

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates a SemanticGovernancePolicy.

  • aiplatform.projects.locations.semanticGovernancePolicies.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the SemanticGovernancePolicy resource to be deleted. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`

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

          Location : path

          Required : Yes

          Type : string

        etag

          Description : Optional. The etag of the SemanticGovernancePolicy. If an etag is provided and does not match the current etag of the SemanticGovernancePolicy, deletion will be blocked and an ABORTED error will be returned.

          Location : query

          Type : string

      Parameter Order : name

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

      Description : Deletes a SemanticGovernancePolicy.

Deletions

    Methods
  • aiplatform.semanticGovernancePolicyEngine.operations.list

      Path : v1beta1/{+name}/operations

      Flat Path : v1beta1/semanticGovernancePolicyEngine/operations

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation's parent resource.

          Pattern : ^semanticGovernancePolicyEngine$

          Location : path

          Required : Yes

          Type : string

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

        returnPartialSuccess

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Location : query

          Type : boolean

      Parameter Order : name

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

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • aiplatform.semanticGovernancePolicyEngine.operations.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation resource.

          Pattern : ^semanticGovernancePolicyEngine/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

  • aiplatform.semanticGovernancePolicyEngine.operations.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : The name of the operation resource to be deleted.

          Pattern : ^semanticGovernancePolicyEngine/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

  • aiplatform.semanticGovernancePolicyEngine.operations.cancel

      Path : v1beta1/{+name}:cancel

      Flat Path : v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}:cancel

      HTTP Method : POST

      Parameters :

        name

          Description : The name of the operation resource to be cancelled.

          Pattern : ^semanticGovernancePolicyEngine/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

  • aiplatform.semanticGovernancePolicyEngine.operations.wait

      Path : v1beta1/{+name}:wait

      Flat Path : v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}:wait

      HTTP Method : POST

      Parameters :

        name

          Description : The name of the operation resource to wait on.

          Pattern : ^semanticGovernancePolicyEngine/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        timeout

          Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

          Location : query

          Type : string

          Format : google-duration

      Parameter Order : name

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

      Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

  • aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.list

      Path : v1beta1/{+name}/operations

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation's parent resource.

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

          Location : path

          Required : Yes

          Type : string

        filter

          Description : The standard list filter.

          Location : query

          Type : string

        pageSize

          Description : The standard list page size.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

        returnPartialSuccess

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Location : query

          Type : boolean

      Parameter Order : name

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

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.get

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}

      HTTP Method : GET

      Parameters :

        name

          Description : The name of the operation resource.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

  • aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.delete

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : The name of the operation resource to be deleted.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

  • aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.cancel

      Path : v1beta1/{+name}:cancel

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}:cancel

      HTTP Method : POST

      Parameters :

        name

          Description : The name of the operation resource to be cancelled.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

  • aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.wait

      Path : v1beta1/{+name}:wait

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}:wait

      HTTP Method : POST

      Parameters :

        name

          Description : The name of the operation resource to wait on.

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

          Location : path

          Required : Yes

          Type : string

        timeout

          Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.

          Location : query

          Type : string

          Format : google-duration

      Parameter Order : name

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

      Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.