-
Notifications
You must be signed in to change notification settings - Fork 385
Enhance knowledge base retrieval instructions #603
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
Added optimized agent instructions for knowledge base retrieval, including a Python template for effective usage and citation formatting.
|
@farzad528 : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. @farzad528 |
|
Learn Build status updates of commit aff4987: ✅ Validation status: passed
For more details, please refer to the build report. |
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 enhances the knowledge base retrieval documentation by adding a new section on optimizing agent instructions for knowledge base retrieval. The changes provide developers with a recommended instruction template designed to improve MCP tool invocation rates and ensure proper citation formatting, along with explanatory guidance on why the template is effective.
Key changes:
- Added a new "Optimize agent instructions for knowledge base retrieval" section with a Python template showing recommended instruction patterns
- Updated existing code examples in both Python and REST sections to use the optimized instruction template
- Included guidance on customizing instructions for specific use cases
|
Can you review the proposed changes? Important: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
|
|
||
| To maximize the accuracy of knowledge base invocations and ensure proper citation formatting, use optimized agent instructions. Based on our experiments, we recommend the following instruction template as a starting point: | ||
|
|
||
| ```python |
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.
Should we convert this code snippet to plain text? Configuring agent instructions isn't specific to Python.
In other words, changing python to plaintext and removing the instructions = """ portion.
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.
updated
Updated the instruction template for knowledge base retrieval to improve accuracy and citation formatting.
Updated the instruction template for knowledge base invocations to improve accuracy and citation formatting.
|
#sign-off |
|
Invalid command: '#sign-off'. Only the assigned author of one or more file in this PR can sign off. @haileytap |
|
Hi @farzad528 - Thanks for your review. In the public repo, pull requests should be signed off by the author, another member of the content team, or a PM. @haileytap Could you take a look? Thanks! |
|
Learn Build status updates of commit f946f2c: ✅ Validation status: passed
For more details, please refer to the build report. |
|
Learn Build status updates of commit 6cb280f: ✅ Validation status: passed
For more details, please refer to the build report. |
|
#sign-off |
|
@v-dirichards: By the way, @farzad528 is both a PM and the |
Added optimized agent instructions for knowledge base retrieval, including a Python template for effective usage and citation formatting.