Enhance AI Evaluations documentation with new steps#630
Conversation
- Added instructions for raising requests and navigating AI Evaluations. - fixed the images stretching issue
|
Warning Review limit reached
More reviews will be available in 20 minutes and 29 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates the "AI Evaluations in Glific" documentation with a new "Raising the request" section that guides users through the access request process and expected enablement timeline. The change includes refreshed UI screenshots at six points throughout the workflow: the AI Evaluations navigation area, the evaluation creation interface, the Golden QA dataset selection flow, the AI assistant version and evaluation naming steps, the results review section, and the Golden QA reference guide. The documentation now provides end-to-end visual coverage of the AI evaluation feature from initial access request through results review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
🚀 Deployed on https://deploy-preview-630--glific-docs.netlify.app |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/5`. Integrations/AI Evaluations in Glific.md:
- Line 15: Insert a single blank line immediately before each of the three
headings mentioned to satisfy markdownlint MD022: add one blank line above "##
Raising the request", above "### Step 2: Select or Upload a Golden QA Dataset",
and above "### Step 4: Enter an Evaluation Name", ensuring there is exactly one
empty line (no extra spacing) so each heading is preceded by one blank line.
- Line 19: Fix the capitalization typo in the sentence "CLick on the button to
raise the request to enable the feature" by changing "CLick" to "Click" so the
line reads "Click on the button to raise the request to enable the feature";
locate and update that exact string in the file "AI Evaluations in Glific.md"
(search for "CLick on the button to raise the request to enable the feature")
and commit the corrected line.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 65544963-4394-43d3-8633-9d2c7339932a
📒 Files selected for processing (1)
docs/5. Integrations/AI Evaluations in Glific.md
|
|
||
| AI Evaluations allow your organization to test and measure how accurately your AI Assistant responds to questions, by comparing its answers against a trusted set of "golden" question-answer pairs. This helps NGOs ensure their AI Assistants are performing well and giving the right information to beneficiaries before deploying them at scale. | ||
|
|
||
| ## Raising the request |
There was a problem hiding this comment.
Add blank lines before headings to comply with Markdown formatting standards.
Headings should be surrounded by blank lines for proper Markdown formatting. Three headings are missing blank lines above them:
- Line 15:
## Raising the request - Line 50:
### Step 2: Select or Upload a Golden QA Dataset - Line 70:
### Step 4: Enter an Evaluation Name
As per markdownlint (MD022), all headings should have exactly one blank line before them.
🔧 Proposed fixes
# AI Evaluations
AI Evaluations allow your organization to test and measure how accurately your AI Assistant responds to questions, by comparing its answers against a trusted set of "golden" question-answer pairs. This helps NGOs ensure their AI Assistants are performing well and giving the right information to beneficiaries before deploying them at scale.
+
## Raising the request - Option B — Upload a new dataset: Click the "Upload Golden QA" button to upload a new CSV file. Provide the duplication factor for the uploaded data set.
+
### Step 2: Select or Upload a Golden QA Dataset Tip: Use a name that helps you identify the test later, such as v2-assistant-may-test or knowledge-base-check-q1.
+
### Step 4: Enter an Evaluation NameAlso applies to: 50-50, 70-70
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 15-15: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/5`. Integrations/AI Evaluations in Glific.md at line 15, Insert a single
blank line immediately before each of the three headings mentioned to satisfy
markdownlint MD022: add one blank line above "## Raising the request", above
"### Step 2: Select or Upload a Golden QA Dataset", and above "### Step 4: Enter
an Evaluation Name", ensuring there is exactly one empty line (no extra spacing)
so each heading is preceded by one blank line.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
@mahajantejas - How will NGOs come to know that feature has been enabled can we add that too for their clarity and also coud change the file last updated status to June |
2 participants
Summary by CodeRabbit