Skip to content

[AI Gateway] Clarify Guardrails streaming evaluation behavior - #32964

Open
superhighfives wants to merge 6 commits into
productionfrom
fix/ai-gateway-guardrails-streaming-docs
Open

[AI Gateway] Clarify Guardrails streaming evaluation behavior#32964
superhighfives wants to merge 6 commits into
productionfrom
fix/ai-gateway-guardrails-streaming-docs

Conversation

@superhighfives

Copy link
Copy Markdown
Contributor

Summary

Replaces two inaccurate statements about Guardrails and streaming with precise, behavior-matched documentation. Behavior confirmed by the AI Gateway team from source code review.

What was wrong:

  • usage-considerations.mdx: "Streaming is not supported when using Guardrails" — misleading because prompt evaluation still runs and the transport still streams.
  • supported-model-types.mdx: "Guardrails does not yet support streaming responses" — same problem, plus an ambiguous "planned for a future update" phrase.

What is true:

Mode Prompt evaluation Response evaluation
stream: false Runs Runs
stream: true Runs Skipped

Changes:

  1. usage-considerations.mdx: Removes the streaming bullet from the "Additional considerations" list and replaces it with a dedicated ### Streaming behavior subsection containing the table above.
  2. supported-model-types.mdx: Replaces the note with accurate text; removes redundant [Note] label; fixes a pre-existing subject–verb agreement error ("bypass" → "bypasses").

Documentation checklist

@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Review

✅ No issues found in commit 2d4d035.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

No code review issues found.

Conventions

No convention issues found.

Style Guide Review

No style-guide issues found.

Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.
/rebase Rebases the PR branch against production. On conflict, attempts to resolve automatically using AI. Stops with an explanation if confidence is not high enough.

@github-actions github-actions Bot added product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ size/s labels Aug 24, 2026
@superhighfives
superhighfives force-pushed the fix/ai-gateway-guardrails-streaming-docs branch from 148148a to a58b9b4 Compare August 24, 2026 17:52
@github-actions

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/ai-gateway/ @abhishekkankani, @palashgo, @thebongy, @roerohan, @kathayl, @mchenco, @zeke, @superhighfives, @shridhar-cf, @adriandlam, @mattrothenberg, @ethulia, @aninibread, @kflansburg, @cloudflare/product-owners

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 24, 2026

Copy link
Copy Markdown

🚀 Deploying Preview to Cloudflare 🚀

Preview URL: https://fix-ai-gateway-guardrails-streaming-docs.previews.developers.cloudflare.com (commit 2d4d035)

This URL reflects your latest Preview deployment

Preview Deployments by commit

Status Deployment URL Commit Updated (UTC) See this deployment's details
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://6bd18a4b.previews.developers.cloudflare.com 2d4d035 2026-08-27T05:00:31.523Z Visit the dashboard ↗
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://6a6c61b9.previews.developers.cloudflare.com b4e939f 2026-08-27T03:02:01.029Z Visit the dashboard ↗
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://41dd6664.previews.developers.cloudflare.com d1bdcd8 2026-08-27T01:29:12.240Z Visit the dashboard ↗
  • Build: In progress 🔵

View logs ↗
f7b696a 2026-08-27T01:06:50.551Z View logs ↗
  • Build: Success ✅
  • Deployment: Success ✅

View logs ↗
https://e8aee267.previews.developers.cloudflare.com, https://e8aee267-cloudflare-docs.cloudflare-docs.workers.dev 2cafbff 2026-08-24T19:02:38.817Z Visit the dashboard ↗
  • Build: In progress 🔵

View logs ↗
a58b9b4 2026-08-24T17:53:15.485Z View logs ↗

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.