projects

GET /v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}

Gets a SemanticGovernancePolicy.

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required
semanticGovernancePoliciesIdstring required

Response

Successful response

agentstring

Required. The name of the agent in Agent Registry that is affected by this policy. Format: projects/{project}/locations/{location}/agents/{agent}

agentIdentitystring

Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME Example: principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID

createTimestring google-datetime

Output only. Timestamp when this SemanticGovernancePolicy was created.

descriptionstring

Optional. The description of the SemanticGovernancePolicy.

displayNamestring

Optional. The user-defined name of the SemanticGovernancePolicy.

dryRunboolean

Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to false, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field.

etagstring

Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned.

namestring

Identifier. Resource name of the SemanticGovernancePolicy.

naturalLanguageConstraintstring

Required. The natural language constraint of the SemanticGovernancePolicy.

updateTimestring google-datetime

Output only. Timestamp when this SemanticGovernancePolicy was last updated.

Changes

No recorded changes to this operation across all 8 revisions of this API.