Skip to content

[AIG]Guardrails docs #20098

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 23 commits into from
Feb 26, 2025
Merged

[AIG]Guardrails docs #20098

merged 23 commits into from
Feb 26, 2025

Conversation

@daisyfaithauma
Copy link
Contributor

@daisyfaithauma daisyfaithauma commented Feb 19, 2025

Summary

  • Guardrails documentation

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@daisyfaithauma daisyfaithauma changed the title Guardrails docs [AIG]Guardrails docs Feb 19, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Feb 19, 2025

Howdy and thanks for contributing to our repo. We review internal PRs with 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

@github-actions github-actions bot added size/s product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ labels Feb 19, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Feb 19, 2025 •
edited
Loading

Preview URL: https://8a73f7f3.preview.developers.cloudflare.com
Preview Branch URL: https://aig-guardrails.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/ai-gateway/guardrails/ https://aig-guardrails.preview.developers.cloudflare.com/ai-gateway/guardrails/
https://developers.cloudflare.com/ai-gateway/guardrails/set-up-guardrail/ https://aig-guardrails.preview.developers.cloudflare.com/ai-gateway/guardrails/set-up-guardrail/
https://developers.cloudflare.com/ai-gateway/guardrails/usage-considerations/ https://aig-guardrails.preview.developers.cloudflare.com/ai-gateway/guardrails/usage-considerations/
https://developers.cloudflare.com/ai-gateway/guardrails/supported-model-types/ https://aig-guardrails.preview.developers.cloudflare.com/ai-gateway/guardrails/supported-model-types/

@kathayl
Copy link
Contributor

kathayl commented Feb 20, 2025 •
edited
Loading

  1. will need changelog entry! hoping to go live tuesday, but might be delayed (moved from mon)
  2. Should just be called "Guardrails", not "Guardrails in AI Gateway"

Overview Page
3. can we link "model providers" to our supported providers page
4. looks like the bullets were not formatted correctly. Also. let's use the same ones as the blog so the points match. but can shorten if you think they're too wordy

How Guardrails works Page
5. Curious the thinking behind this page vs how we currently have "Evaluations > Set up Evaluations". The "Set up evaluations" page is much more about the steps to get an eval set up, while this "how guardrails works" page is more high level and just tells you to go to the settings page to configure the three things
6. i feel like the process should be 1) we proxy things 2) we inspect content based on your settings 3) we flag/block
7. "catalogued models" is an internal thing, so we should not use the word "catalog". Perhaps this model-specific behavior shouldn't be in this process explanation.... maybe it's a section on supported model types instead? Need to explain we detect what type of model it is and if text gen then X, if embeddings then Y, if unknown then Z. this would need to merge with the bullet on "model availability"
8. "Leveraging Llama Guard on Workers AI" section - Don't want to make this section about Llama Guard since the model might change. Maybe change title to just be about Workers AI. Can merge the "Workers AI usage" bullet from below into this section. When we launch Guardrails, Workers AI will also make Llama Guard available publicly, so we'll want to switch the links for Llama Guard over to the Workers AI Llama Guard docs page. Need to clarify that Guardrails is just currently using Llama Guard 3 and that the underlying model may be updated in the future. It's not that the "model is continuously updated" because Meta probably won't update Llama Guard 3 much, they would just launch the next version Llama Guard 4.
9. Additional considerations section "Latency impact" would change to "Enabling Guardrails adds some latency. Consider this when balancing safety and speed.

@kathayl
Copy link
Contributor

kathayl commented Feb 20, 2025

Legal team request to add the following onto dev docs page:
Llama Guard is provided as-is without any representations, warranties, or guarantees. Any rules or examples contained in blogs, developer docs, or other reference materials are provided for informational purposes only. You acknowledge and understand that you are responsible for the results and outcomes of your use of AI Gateway.

@github-actions github-actions bot added size/m and removed size/s labels Feb 21, 2025
@kathayl
Copy link
Contributor

kathayl commented Feb 24, 2025 •
edited
Loading

were you planning on having changelog be a separate PR? (the normal short one that is within AI Gateway docs) or should it be part of this PR?

@kathayl
Update index.mdx
04ee357 
updated wording
@kathayl
Copy link
Contributor

kathayl commented Feb 24, 2025

image
the note is not showing up correctly

@kathayl
Update index.mdx
842d0d3 
deleted extra sentence
kodster28
kodster28 reviewed Feb 24, 2025
View reviewed changes
src/content/docs/ai-gateway/guardrails/set-up-guardrail.mdx Outdated

Llama Guard is provided as-is without any representations, warranties, or guarantees. Any rules or examples contained in blogs, developer docs, or other reference materials are provided for informational purposes only. You acknowledge and understand that you are responsible for the results and outcomes of your use of AI Gateway.

## :::
Copy link
Collaborator

@kodster28 kodster28 Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think from here until the end is just a duplication of the existing content?

Copy link
Collaborator

@kodster28 kodster28 Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can avoid this by previewing your build locally || looking at the preview links once you push it up.

kodster28
kodster28 reviewed Feb 24, 2025
View reviewed changes
src/content/docs/ai-gateway/guardrails/set-up-guardrail.mdx Outdated
order: 3
---

AI Gateway inspects all interactions in real time by evaluating content against predefined safety parameters. Below a breakdown of the process:
Copy link
Collaborator

@kodster28 kodster28 Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should delete this entire page and instead move the different sub-groups of information to other pages (noting below)

src/content/docs/ai-gateway/guardrails/set-up-guardrail.mdx Outdated

Llama Guard is provided as-is without any representations, warranties, or guarantees. Any rules or examples contained in blogs, developer docs, or other reference materials are provided for informational purposes only. You acknowledge and understand that you are responsible for the results and outcomes of your use of AI Gateway.

## :::
Copy link
Collaborator

@kodster28 kodster28 Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can avoid this by previewing your build locally || looking at the preview links once you push it up.

@kathayl
Update set-up-guardrail.mdx
0f907b4 
updated wording in supported model types section
@daisyfaithauma
Copy link
Contributor Author

daisyfaithauma commented Feb 24, 2025

were you planning on having changelog be a separate PR? (the normal short one that is within AI Gateway docs) or should it be part of this PR?

Separate PR depending on when it goes live

@github-actions github-actions bot added size/s and removed size/m labels Feb 25, 2025
daisyfaithauma and others added 2 commits February 25, 2025 12:15
@daisyfaithauma
moved details
ba3ab97
@kathayl
Update set-up-guardrail.mdx
c1378e9 
3 changes
1) moved configuration first, before supported model types
2) moved note about llamaguard to llamaguard section
3) added link to workers ai dashboard
@kathayl
Copy link
Contributor

kathayl commented Feb 25, 2025

should we rename the second page, since the "how guardrails works" section is in the overview page now? --> Set up Guardrails?

@github-actions github-actions bot added size/m and removed size/s labels Feb 25, 2025
@github-actions github-actions bot added size/s and removed size/m labels Feb 25, 2025
daisyfaithauma and others added 2 commits February 25, 2025 22:20
@daisyfaithauma
Update supported-model-types.mdx
bf61f4b 
Removed heading
@kathayl
Update usage-considerations.mdx
22eeb30 
added info on what happens if Workers AI is down
kathayl
kathayl reviewed Feb 25, 2025
View reviewed changes
Maddy-Cloudflare
Maddy-Cloudflare approved these changes Feb 26, 2025
View reviewed changes
kodster28
kodster28 reviewed Feb 26, 2025
View reviewed changes
@daisyfaithauma daisyfaithauma enabled auto-merge (squash) February 26, 2025 13:39
@daisyfaithauma daisyfaithauma merged commit e73b6e6 into production Feb 26, 2025
11 checks passed
@daisyfaithauma daisyfaithauma deleted the aig-guardrails branch February 26, 2025 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kodster28 kodster28 kodster28 left review comments

@kathayl kathayl kathayl approved these changes

@Maddy-Cloudflare Maddy-Cloudflare Maddy-Cloudflare approved these changes

@G4brym G4brym Awaiting requested review from G4brym

@mchenco mchenco Awaiting requested review from mchenco mchenco is a code owner

Assignees

@G4brym G4brym

@mchenco mchenco

@kathayl kathayl

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@daisyfaithauma @kathayl @kodster28 @Maddy-Cloudflare @G4brym @mchenco