Add documentation for creating and modifying assistants#599
Add documentation for creating and modifying assistants#599SangeetaMishr merged 4 commits intomainfrom
Conversation
This document provides a comprehensive guide on creating, modifying, and using assistants within Glific flows, including step-by-step instructions and key points to note.
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 42 minutes and 40 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, 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 have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughA new documentation page was added explaining how to create, modify, and copy Glific assistants. The guide provides step-by-step instructions with screenshots for assistant configuration, version management, and deployment within the platform. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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-599--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: 3
🧹 Nitpick comments (1)
docs/5. Integrations/Creating and modifying assistants in Glific.md (1)
45-45: Consider simplifying this sentence for clarity.Line 45 is understandable, but can be made crisper by removing “in order to.”
Example: “This action is needed to modify knowledge bases associated with assistants created before March 10, 2026.”🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/5`. Integrations/Creating and modifying assistants in Glific.md at line 45, Replace the sentence "This action is needed in order to modify knowledge bases associated with assistants created before 10th March 2026." with a crisper version that removes "in order to" and standardizes the date format; e.g., change it to "This action is needed to modify knowledge bases associated with assistants created before March 10, 2026." — update the sentence in the same paragraph that currently contains "This action is needed in order to modify knowledge bases associated with assistants created before 10th March 2026." in the document "Creating and modifying assistants in Glific".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/5`. Integrations/Creating and modifying assistants in Glific.md:
- Line 4: The Markdown heading is malformed ("##Creating a new assistant");
update the heading text used in the docs (the line containing "##Creating a new
assistant") to include a space after the hashes so it reads "## Creating a new
assistant" to satisfy MD018 linting.
- Line 58: Replace the generic link text "here" in the sentence "The workflow on
using the assistants remains the same, can be seen [here](...)" with a
descriptive phrase such as "OpenAI assistant usage in Flow Editor" to satisfy
MD059; update the markdown link so it reads e.g. "can be seen [OpenAI assistant
usage in Flow
Editor](https://glific.github.io/docs/docs/Integrations/Filesearch%20Using%20OpenAI%20Assistants#using-the-openai-assistant-in-floweditor!)"
so the link text is explicit and accessible.
- Around line 49-54: Tighten and correct wording in the key notes and the "Why
are versions created..." paragraph: replace "Be default" with "By default",
change "incase" to "in case", remove repeated "in order to" phrasing by
rewriting sentences for concision (e.g., "By default, new changes are not
applied to a flow; to use the latest modifications you must click 'Set as
LIVE'." and "Versions are created so you can easily revert to a previous state
if needed."), and ensure consistent capitalization of "Set as LIVE"; update the
bullets and explanatory sentence in the key notes and the following paragraph to
use these corrected, tighter phrasings.
---
Nitpick comments:
In `@docs/5`. Integrations/Creating and modifying assistants in Glific.md:
- Line 45: Replace the sentence "This action is needed in order to modify
knowledge bases associated with assistants created before 10th March 2026." with
a crisper version that removes "in order to" and standardizes the date format;
e.g., change it to "This action is needed to modify knowledge bases associated
with assistants created before March 10, 2026." — update the sentence in the
same paragraph that currently contains "This action is needed in order to modify
knowledge bases associated with assistants created before 10th March 2026." in
the document "Creating and modifying assistants in Glific".
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: 4799edfc-3267-46f5-8fb2-2977514f60de
📒 Files selected for processing (1)
docs/5. Integrations/Creating and modifying assistants in Glific.md
| 2. Any new updates can be evaluated (evaluations feature coming soon in Glific) before deploying to live assistants. | ||
|
|
||
| ### How to use the assistants in the Glific flow? | ||
| The workflow on using the assistants remains the same, can be seen [here](https://glific.github.io/docs/docs/Integrations/Filesearch%20Using%20OpenAI%20Assistants#using-the-openai-assistant-in-floweditor!) |
There was a problem hiding this comment.
Use descriptive link text instead of “here.”
Line 58 triggers MD059; replace generic link text with something explicit (for example, “OpenAI assistant usage in Flow Editor”).
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 58-58: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/5`. Integrations/Creating and modifying assistants in Glific.md at line
58, Replace the generic link text "here" in the sentence "The workflow on using
the assistants remains the same, can be seen [here](...)" with a descriptive
phrase such as "OpenAI assistant usage in Flow Editor" to satisfy MD059; update
the markdown link so it reads e.g. "can be seen [OpenAI assistant usage in Flow
Editor](https://glific.github.io/docs/docs/Integrations/Filesearch%20Using%20OpenAI%20Assistants#using-the-openai-assistant-in-floweditor!)"
so the link text is explicit and accessible.
|
@mahajantejas Can you add the below code update the relevant fields.
Do include the comments added by coderabit. |
Added metadata table for reading time, level, and last updated date.
…ic.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
@SangeetaMishr - added the header, and also addressed from the comments from coderabit. thanks |
|
@mahajantejas - I have reviewed and merged it. Good Work on the screenshot with explanation looks neat |
2 participants
This document provides a comprehensive guide on creating, modifying, and using assistants within Glific flows, including step-by-step instructions and key points to note.
Copied from here: https://docs.google.com/document/d/1wbhmt2xzX44KkdBfi6fFGa-Xs5J9xJ0vv_HwFyktRu0/edit?pli=1&tab=t.0 (to make reviewing easier for screenshots)
Summary by CodeRabbit