2026-06-27
▼ ▲ aiplatform.semanticGovernancePolicies.operations.get
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.
HTTP Method : GET
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : The name of the operation resource.
Pattern : ^semanticGovernancePolicies/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
Flat Path : v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}
▼ ▲ aiplatform.semanticGovernancePolicies.operations.list
Flat Path : v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations
Parameters :
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
name
Required : Yes
Location : path
Description : The name of the operation's parent resource.
Pattern : ^semanticGovernancePolicies/[^/]+$
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : The standard list page size.
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}/operations
HTTP Method : GET
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ aiplatform.semanticGovernancePolicies.operations.cancel
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`.
Path : v1/{+name}:cancel
HTTP Method : POST
Parameters :
name
Location : path
Required : Yes
Type : string
Description : The name of the operation resource to be cancelled.
Pattern : ^semanticGovernancePolicies/[^/]+/operations/[^/]+$
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.semanticGovernancePolicies.operations.wait
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.
HTTP Method : POST
Path : v1/{+name}:wait
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Description : The name of the operation resource to wait on.
Pattern : ^semanticGovernancePolicies/[^/]+/operations/[^/]+$
Location : path
Required : Yes
timeout
Location : query
Type : string
Format : google-duration
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.
Parameter Order : name
Flat Path : v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait
▼ ▲ aiplatform.semanticGovernancePolicies.operations.delete
Path : v1/{+name}
HTTP Method : DELETE
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`.
Flat Path : v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}
Parameters :
name
Type : string
Description : The name of the operation resource to be deleted.
Pattern : ^semanticGovernancePolicies/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Parameter Order : name
▼ ▲ aiplatform.projects.locations.getSemanticGovernancePolicyEngine
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine
Parameters :
name
Description : Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine
Pattern : ^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$
Type : string
Required : Yes
Location : path
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
HTTP Method : GET
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
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine
Parameters :
name
Location : path
Required : Yes
Type : string
Description : Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine
Pattern : ^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$
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
Path : v1/{+name}
HTTP Method : PATCH
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.agents.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agents
Parameters :
pageToken
Description : Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page.
Location : query
Type : string
pageSize
Description : Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10.
Location : query
Type : integer
Format : int32
parent
Description : Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Location : path
orderBy
Description : Optional. A comma-separated list of fields to order by. Supported fields: * `created` * `updated` Use `desc` after a field name for descending order. Example: `created desc`.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/agents
HTTP Method : GET
Description : Lists agents in a location.
▼ ▲ aiplatform.projects.locations.agents.create
HTTP Method : POST
Path : v1/{+parent}/agents
Description : Creates an agent.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agents
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Required : Yes
Location : path
Description : Required. The resource name of the location to create the agent in. Format: `projects/{project}/locations/{location}`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Parameter Order : parent
▼ ▲ aiplatform.projects.locations.agents.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Location : path
Description : Required. The resource name of the agent to retrieve. Format: `projects/{project}/locations/{location}/agents/{agent}`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}
Description : Retrieves an agent.
HTTP Method : GET
Path : v1/{+name}
▼ ▲ aiplatform.projects.locations.agents.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
updateMask
Description : Optional. The list of fields to update. If not present, all fields are updated.
Location : query
Type : string
Format : google-fieldmask
name
Required : Yes
Location : path
Description : Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Type : string
Parameter Order : name
HTTP Method : PATCH
Path : v1/{+name}
Description : Updates an agent.
▼ ▲ aiplatform.projects.locations.agents.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}
Parameters :
name
Location : path
Required : Yes
Type : string
Description : Required. The resource name of the agent to delete. Format: `projects/{project}/locations/{location}/agents/{agent}`.
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+$
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+name}
HTTP Method : DELETE
Description : Deletes an agent.
▼ ▲ aiplatform.projects.locations.reasoningEngines.memories.ingestEvents
HTTP Method : POST
Path : v1/{+parent}/memories:ingestEvents
Description : Ingests events for a Memory Bank.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:ingestEvents
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Type : string
Description : Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$
Location : path
Required : Yes
Parameter Order : parent
▼ ▲ aiplatform.projects.locations.semanticGovernancePolicyEngine.deprovision
Parameters :
name
Description : Required. The resource name of the SemanticGovernancePolicyEngine to deprovision. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine
Pattern : ^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$
Type : string
Required : Yes
Location : path
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine:deprovision
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.
Path : v1/{+name}:deprovision
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.semanticGovernancePolicies.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies
Parameters :
parent
Location : path
Required : Yes
Type : string
Description : Required. The resource name of the Location into which to create the SemanticGovernancePolicy. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
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
Path : v1/{+parent}/semanticGovernancePolicies
HTTP Method : POST
Description : Creates a SemanticGovernancePolicy.
▼ ▲ aiplatform.projects.locations.semanticGovernancePolicies.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Description : Required. The name of the SemanticGovernancePolicy resource. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`
Pattern : ^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}
Description : Gets a SemanticGovernancePolicy.
HTTP Method : GET
Path : v1/{+name}
▼ ▲ aiplatform.projects.locations.semanticGovernancePolicies.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies
Parameters :
pageToken
Description : Optional. The standard list page token.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. The list page size. If zero, a default page size of 10 is used.
parent
Description : Required. The resource name of the Location from which to list the SemanticGovernancePolicies. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1/{+parent}/semanticGovernancePolicies
HTTP Method : GET
Description : Lists SemanticGovernancePolicies in a given location.
▼ ▲ aiplatform.projects.locations.semanticGovernancePolicies.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/[^/]+$
Type : string
Required : Yes
Location : path
etag
Location : query
Type : string
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.
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}
Description : Deletes a SemanticGovernancePolicy.
Path : v1/{+name}
HTTP Method : DELETE
▼ ▲ aiplatform.projects.locations.semanticGovernancePolicies.patch
Description : Updates a SemanticGovernancePolicy.
HTTP Method : PATCH
Path : v1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
updateMask
Location : query
Type : string
Format : google-fieldmask
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.
name
Type : string
Description : Identifier. Resource name of the SemanticGovernancePolicy.
Pattern : ^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$
Location : path
Required : Yes
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}
▼ ▲ aiplatform.projects.locations.semanticGovernancePolicies.operations.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Required : Yes
Location : path
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$
Type : string
Parameter Order : name
HTTP Method : DELETE
Path : v1/{+name}
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.semanticGovernancePolicies.operations.wait
Path : v1/{+name}:wait
HTTP Method : POST
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.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait
Parameters :
name
Location : path
Required : Yes
Type : string
Description : The name of the operation resource to wait on.
Pattern : ^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$
timeout
Location : query
Type : string
Format : google-duration
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.
Parameter Order : name
▼ ▲ aiplatform.projects.locations.semanticGovernancePolicies.operations.cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Parameter Order : name
HTTP Method : POST
Path : v1/{+name}:cancel
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.semanticGovernancePolicies.operations.list
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
HTTP Method : GET
Path : v1/{+name}/operations
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
returnPartialSuccess
Location : query
Type : boolean
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.
name
Location : path
Required : Yes
Type : string
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : The standard list page size.
pageToken
Description : The standard list page token.
Location : query
Type : string
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations
▼ ▲ aiplatform.projects.locations.semanticGovernancePolicies.operations.get
HTTP Method : GET
Path : v1/{+name}
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.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Type : string
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Parameter Order : name