Skip to content

docs: docs for singulr ai guardrail provider - #7055

Open
Madhuvod wants to merge 1 commit into
09-08-oss_changes_for_support_for_tool_calls_args_redaction_in_guardrailsfrom
09-10-docs_docs_for_singulr_ai_guardrail_provider
Open

docs: docs for singulr ai guardrail provider#7055
Madhuvod wants to merge 1 commit into
09-08-oss_changes_for_support_for_tool_calls_args_redaction_in_guardrailsfrom
09-10-docs_docs_for_singulr_ai_guardrail_provider

Conversation

@Madhuvod

@Madhuvod Madhuvod commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds Singulr AI as a supported third-party guardrail provider in Bifrost Enterprise. Singulr evaluates LLM prompts and responses against configured policies and returns allow, block, or redact decisions. For redact decisions, Bifrost validates the spans returned by Singulr and applies fixed runtime replacement to the matching text.

Changes

  • Added a new integrations/guardrails/singulr-ai.mdx integration page covering prerequisites, how it works, all configuration fields, and setup examples across Web UI, API, config.json, and Helm.
  • Added Singulr AI tabs to the config.json and Helm guardrails deployment guides with JSON and YAML configuration examples.
  • Registered singulr-ai as a valid provider_name in all provider reference tables across the deployment guides and enterprise overview.
  • Added Singulr AI to the enterprise guardrails overview page with a card entry and updated the Profiles concept table and multi-provider feature descriptions.
  • Updated the redaction documentation to include Singulr AI in the span-based redaction provider list, clarified that Singulr controls the action decision while Bifrost applies the spans, noted the fixed runtime replacement behavior, and added the tool-call limitation (block only, no redaction).
  • Added Singulr AI to the navigation structure in docs.json under both the integrations guardrails section and the sidebar.
  • Added card and nav SVG logo assets for Singulr AI.

Type of change

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Chore/CI

Affected areas

  • Core (Go)
  • Transports (HTTP)
  • Providers/Integrations
  • Plugins
  • UI (React)
  • Docs

How to test

  1. Navigate to the Singulr AI integration page at /integrations/guardrails/singulr-ai and confirm all tabs (Web UI, API, config.json, Helm) render correctly.
  2. Confirm the Singulr AI card appears on the enterprise guardrails overview page.
  3. Confirm singulr-ai appears in the provider_name reference tables in both the config.json and Helm deployment guides.
  4. Confirm the redaction page lists Singulr AI under span-based redaction providers and includes the tool-call limitation note.
  5. Confirm the nav entry resolves correctly in both sidebar navigation locations defined in docs.json.

Breaking changes

  • No

Related issues

Security considerations

  • api_key supports env.SINGULR_API_KEY to avoid embedding credentials in configuration files.
  • base_url supports env.SINGULR_BASE_URL for environment-specific endpoint configuration.
  • Bifrost validates Singulr-returned spans before applying redaction and fails closed on missing or unsafe spans rather than forwarding original content.

Checklist

  • I read docs/contributing/README.md and followed the guidelines
  • I added/updated tests where appropriate
  • I updated documentation where needed
  • I verified builds succeed (Go and UI)
  • I verified the CI pipeline passes locally if applicable

@coderabbitai

coderabbitai Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: 6786614f-29bb-44f9-8992-69f674684b4f

📥 Commits

Reviewing files that changed from the base of the PR and between a964db4 and 28d6914.

📒 Files selected for processing (5)
  • docs/deployment-guides/config-json/guardrails.mdx
  • docs/deployment-guides/helm/guardrails.mdx
  • docs/docs.json
  • docs/enterprise/guardrails.mdx
  • docs/enterprise/guardrails/redaction.mdx

Included review availability: 8 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 10 reviews per hour.


📝 Summary

Summary by CodeRabbit

  • New Integrations

    • Added Singulr AI as a supported guardrail provider.
    • Supports API-key authentication, application and guardrail IDs, optional base URL configuration, and a 30-second timeout.
    • Supports policy-based prompt-injection, PII, and PHI enforcement, including blocking and span-based redaction.
  • Documentation

    • Added setup guidance for Web UI, API, JSON configuration, and Helm deployments.
    • Documented streaming behavior, supported content, limitations, redaction behavior, and configuration fields.
    • Updated navigation and guardrail provider references.

Walkthrough

Added Singulr AI as a documented guardrail provider across integration, enterprise, deployment, and navigation documentation. The documentation covers policy decisions, redaction behavior, configuration fields, API setup, Web UI setup, Helm, and config.json.

Changes

Singulr AI guardrails

Layer / File(s) Summary
Singulr AI integration guide
docs/integrations/guardrails/singulr-ai.mdx, docs/docs.json
Added setup instructions, policy and response behavior, Web UI and API examples, config.json and Helm examples, supported content, limitations, and navigation entries.
Enterprise provider and redaction behavior
docs/enterprise/guardrails.mdx, docs/enterprise/guardrails/redaction.mdx
Added Singulr AI to enterprise provider listings and profile types. Documented policy-controlled allow, block, and redact decisions, fixed replacements, fail-closed span handling, and tool-content limitations.
Deployment configuration references
docs/deployment-guides/config-json/guardrails.mdx, docs/deployment-guides/helm/guardrails.mdx
Added provider tabs and field references for API key, application ID, guardrail ID, base URL, endpoint behavior, and timeout settings.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 28d69

The Singulr AI documentation and navigation updates are ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title is concise, clear, and directly describes the main change: documentation for the Singulr AI guardrail provider.
Description check ✅ Passed The description is complete and aligned with the template. It explains the purpose, changes, change type, affected areas, validation steps, security considerations, and breaking-change status. The emp…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 09-10-docs_docs_for_singulr_ai_guardrail_provider

Comment @coderabbitai help to get the list of available commands.

Madhuvod commented Sep 10, 2026

Copy link
Copy Markdown
Contributor Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@Madhuvod
Madhuvod marked this pull request as ready for review September 10, 2026 14:03
@Madhuvod
Madhuvod force-pushed the 09-10-docs_docs_for_singulr_ai_guardrail_provider branch from a964db4 to 28d6914 Compare September 11, 2026 17:53
@Madhuvod
Madhuvod force-pushed the 09-08-oss_changes_for_support_for_tool_calls_args_redaction_in_guardrails branch from 141d44b to d7e5e39 Compare September 11, 2026 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant