Documentation Index
Fetch the complete documentation index at: https://docs.getbifrost.ai/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Bifrost Enterprise supports Google Cloud Model Armor as a guardrail provider for LLM request and response traffic. Use it when your safety and data protection policies are managed in Google Cloud and you want Bifrost to enforce those policies inline before prompts reach an LLM and before model responses are returned. Google owns the Model Armor template. Bifrost owns the gateway enforcement path: it selects when to call Model Armor, sends the relevant text to the template, then blocks or rewrites the Bifrost request/response based on the sanitize result.When To Use It
Google Model Armor is useful for:- Blocking prompt injection and jailbreak attempts
- Screening responses for unsafe generated content
- Detecting responsible AI safety categories such as hate speech, harassment, sexually explicit content, and dangerous content
- Detecting malicious URLs in prompts or responses
- Blocking sensitive data with Sensitive Data Protection inspection
- Redacting or replacing sensitive data with Sensitive Data Protection de-identification templates
- Keeping policy configuration in Google Cloud while enforcing it at the Bifrost gateway
Bifrost follows the Model Armor template result. If Model Armor returns a non-mutable match, Bifrost returns
GUARDRAIL_INTERVENED. If Model Armor returns SDP de-identified text, Bifrost applies the transformed text and allows the request or response to continue.Prerequisites
- Bifrost Enterprise with the guardrails plugin enabled
- The Model Armor API enabled in your Google Cloud project
- A Model Armor template in the project and location you want to use
- Network egress from Bifrost to the Model Armor regional endpoint over HTTPS
- A Google principal with
roles/modelarmor.useror a higher Model Armor role on the project or template
Set Up Google Cloud
- In the Google Cloud console, open APIs & Services and enable Model Armor API.
- Open Security > Model Armor.
- Create a template.
- Note the template values Bifrost needs:
- Project ID: for example
my-gcp-project - Location: for example
us,eu, orus-central1 - Template ID: for example
bifrost-prod
- Project ID: for example
- Grant the Bifrost runtime identity
roles/modelarmor.useror higher:- Go to IAM & Admin > IAM.
- Click Grant access.
- Add the service account or user identity Bifrost will use.
- Select Model Armor User.
- Save.
sanitizeUserPrompt and sanitizeModelResponse references.
Authentication
Bifrost supports two OAuth-based Google authentication modes.| Auth mode | Use when | Bifrost config |
|---|---|---|
| Google ADC | Bifrost should use credentials from the runtime environment | auth_type: "default_credential" |
| Service Account Key JSON | You want this profile to carry a specific Google service account key | auth_type: "service_account_json" |
Google ADC
Application Default Credentials (ADC) lets Google client libraries find credentials from the environment. Bifrost uses ADC whenauth_type is default_credential or omitted.
Common ADC sources:
GOOGLE_APPLICATION_CREDENTIALSpointing to a service account key file- Local credentials from
gcloud auth application-default login - An attached service account on Google Cloud compute runtimes
- Workload Identity on GKE or other supported runtimes
With ADC, no key JSON is stored in the Bifrost profile. Grant the identity that ADC resolves to the Model Armor User role or higher.
Service Account Key JSON
Use this mode when the Model Armor profile should authenticate with one specific service account key. To create a key in Google Cloud:- Go to IAM & Admin > Service Accounts.
- Select or create the service account that Bifrost should use.
- Open Keys.
- Click Add key > Create new key.
- Choose JSON and download the file.
- Grant that service account Model Armor User or higher.
How It Works
- Create a Bifrost guardrail provider with
provider_name: "model-armor". - Attach that provider configuration to one or more guardrail rules.
- When an input rule matches, Bifrost sends text to
sanitizeUserPrompt. - When an output rule matches, Bifrost sends text to
sanitizeModelResponse. - If Model Armor returns no match, Bifrost allows the content unchanged.
- If Model Armor returns a blocking match, Bifrost returns
GUARDRAIL_INTERVENED. - If Model Armor returns SDP de-identified text, Bifrost replaces the original text with the transformed text and continues.
API Calls
Bifrost sends text-only Model Armor requests:Bifrost currently sends text content to Model Armor. It does not send file bytes or per-request multi-language detection metadata.
Configuration Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | - | Google Cloud project ID that owns the Model Armor template. Supports env.GCP_PROJECT_ID. |
location | string | Yes | - | Model Armor template location. Supports env.GCP_LOCATION. |
template_id | string | Yes | - | Model Armor template ID. Supports env.GMA_TEMPLATE_ID. |
auth_type | enum | No | default_credential | default_credential or service_account_json. Supports env.*. |
service_account_json | string | Conditional | - | Full service account key JSON or an env.* reference. Required when auth_type is service_account_json. |
base_url | string | No | Regional Model Armor endpoint | Optional custom endpoint or proxy. Usually leave blank. Supports env.*. |
timeout | integer | No | 30 | Provider execution timeout in seconds. |
Configuration
- Web UI
- API
- config.json
- Helm
- Go to Guardrails > Providers.
- Select Google Model Armor.
- Click Add Configuration.

- Enter a descriptive Name, such as
model-armor-prod. - Choose an authentication method:
- Google ADC to use credentials available to the Bifrost runtime.
- Service Account Key JSON to paste a key or reference an environment variable containing the full key JSON.
- Enter Project ID, Location, and Template ID.
- Leave Base URL blank unless you are routing through a proxy or custom endpoint.
- Set the timeout and save the configuration.
- Go to Guardrails > Configuration and attach the Google Model Armor profile to an input, output, or both-phase rule.
Policy Outcomes
| Model Armor result | Bifrost behavior |
|---|---|
filterMatchState: "NO_MATCH_FOUND" | Allows original content unchanged. |
| Blocking filter match, such as RAI, prompt injection, CSAM, malicious URI, or SDP inspect-only | Blocks with GUARDRAIL_INTERVENED. |
| SDP de-identify match with transformed text | Allows the request/response and replaces the original text with the transformed text. |
invocationResult: "FAILURE", missing sanitizationResult, timeout, non-2xx response, or malformed response | Treats the provider call as failed. Check Bifrost logs for the exact error. |
- Evaluated text count
- Matched text count
- Transformed text count
- Blocking filter names
- Invocation result values
Blocked Error Response
When Google Model Armor blocks content, Bifrost returns HTTP400 with type: "guardrail_intervention".
Trimmed example:
Model Armor output inspection and de-identification only apply to non-streaming response bodies today. Streaming output mutation is not supported; input guardrails can still run before a streaming request is sent to the LLM.
Troubleshooting
| Symptom | What to check |
|---|---|
failed to load Google default credentials | auth_type is default_credential, but ADC is not available to the Bifrost process. Run gcloud auth application-default login locally, set GOOGLE_APPLICATION_CREDENTIALS, or attach a service account/Workload Identity to the runtime. |
403 Permission denied with modelarmor.templates.useToSanitizeUserPrompt or useToSanitizeModelResponse | Grant the Bifrost principal roles/modelarmor.user or higher on the project or template. |
| SDP template validation fails | Confirm the SDP inspect and de-identify template names are full resource paths and are valid for the Model Armor template location. |
| Direct Google curl works, but Bifrost fails | Bifrost may be using a different identity than your shell. Check whether the profile uses ADC or service account JSON, and check the process environment of the running Bifrost server. |
| Service account JSON fails in a shell | Store it with export GOOGLE_MODEL_ARMOR_SERVICE_ACCOUNT_JSON="$(cat key.json)" or use GOOGLE_APPLICATION_CREDENTIALS=/path/key.json with ADC. |
| Base URL errors | Leave Base URL blank unless you need a proxy. Bifrost derives https://modelarmor.LOCATION.rep.googleapis.com from the configured location. |
| Multiple mutating guardrails match the same request | Bifrost refuses ambiguous transformed output. Use one mutating profile per rule path or make the rules mutually exclusive. |
| Google floor setting blocks or modifies behavior unexpectedly | Check Model Armor floor settings in Google Cloud. Floor settings can establish minimum policy requirements that apply below the template level. |
Google Cloud References
- Model Armor overview
- Sanitize prompts and responses
- Data residency and regional endpoints
- Model Armor IAM roles and permissions
- Application Default Credentials
- Create and delete service account keys
config.json setup, see Guardrails in config.json.


