-
Notifications
You must be signed in to change notification settings - Fork 2
Add concepts doc for Intelligent Assessment control. #360
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.
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
Conversation
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsintelligent-assessm-91708f-turbot.vercel.app |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsintelligent-assessm-91708f-turbot.vercel.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds documentation for the new Intelligent Assessment guardrails, providing guidance on its purpose and usage within Turbot Guardrails.
- Adds a new markdown document that explains the Intelligent Assessment approach.
- Updates sidebar navigation in docs/sidebar.json to include the new documentation entry.
- Updates the guardrails index to feature the Intelligent Assessment docs.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
File | Description |
---|---|
docs/sidebar.json | Adds the Intelligent Assessment entry in the navigation. |
docs/concepts/guardrails/intelligent-assessment.md | Introduces a full documentation page explaining functionality. |
docs/concepts/guardrails/index.md | Updates the index to include Intelligent Assessment with description. |
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsintelligent-assessm-91708f-turbot.vercel.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@SumitPopat Please see comments, thanks!
sidebar_label: Intelligent Assessment | ||
--- | ||
|
||
# Intelligent Assessment Guardrails |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Headers should appear on the ON THIS PAGE
section
|
||
The `Context` sub-policy includes the resource metadata by default but can be updated to include additional data. | ||
The `User Prompt` sub-policy is where you would define a prompt to assess the resource. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add info on what the AI model will output as part of evaluation, e.g., state (describe what states are possible and when they appear) and reason (typically a short response of the evaluation)
Co-authored-by: cbruno10 <cody@turbot.com>
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsintelligent-assessm-91708f-turbot.vercel.app |
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsintelligent-assessm-91708f-turbot.vercel.app |
No description provided.