Add documentation for additional search tools #413
Conversation
- Updated `mint.json` to include new search tools - Added documentation pages for DuckDuckGo, Exa, Google Serper, Serp, and Wikipedia search tools - Included installation instructions, overview, and example code for each search tool
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @MervinPraison, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request adds documentation for several new search tools to be used with PraisonAI agents. Specifically, I've updated mint.json to include these new tools and added documentation pages for DuckDuckGo, Exa, Google Serper, Serp, and Wikipedia search tools. Each documentation page includes installation instructions, an overview, and example code.
Highlights
- Documentation: Added documentation pages for DuckDuckGo, Exa, Google Serper, Serp, and Wikipedia search tools.
- Configuration: Updated
mint.jsonto include the new search tools in the documentation. - Installation and Usage: Included installation instructions, overview, and example code for each search tool.
Changelog
Click here to see the changelog
- docs/mint.json
- Added entries for Exa Search, Wikipedia Search, DuckDuckGo Search, Google Serper Search, and Serp Search to the list of documentation pages.
- The new entries are added to the 'tools/external' section.
- docs/tools/external/duckduckgo-search.mdx
- Created a new documentation page for the DuckDuckGo Search tool.
- The page includes a title, description, and icon in the frontmatter.
- Added an overview section explaining the tool's purpose.
- Included installation instructions using
pipand setting theOPENAI_API_KEYenvironment variable. - Provided example code demonstrating how to use the tool with
praisonaiagents.
- docs/tools/external/exa-search.mdx
- Created a new documentation page for the Exa Search tool.
- The page includes a title, description, and icon in the frontmatter.
- Added an overview section explaining the tool's purpose.
- Included installation instructions using
pipforpraisonaiagentsandexa-py, and setting theEXA_API_KEYandOPENAI_API_KEYenvironment variables. - Provided example code demonstrating how to use the tool with
praisonaiagentsandexa_py.
- docs/tools/external/google-serper-search.mdx
- Created a new documentation page for the Google Serper Search tool.
- The page includes a title, description, and icon in the frontmatter.
- Added an overview section explaining the tool's purpose.
- Included installation instructions using
pipforlangchain-communityandpython-dotenv, and setting theSERPER_API_KEYandOPENAI_API_KEYenvironment variables. - Provided example code demonstrating how to use the tool with
praisonaiagentsandlangchain_community.utilities.GoogleSerperAPIWrapper.
- docs/tools/external/serp-search.mdx
- Created a new documentation page for the SerpSearch tool.
- The page includes a title, description, and icon in the frontmatter.
- Added an overview section explaining the tool's purpose.
- Included installation instructions using
pipforlangchain-communityandgoogle-search-results, and setting theSERPAPI_API_KEYandOPENAI_API_KEYenvironment variables. - Provided example code demonstrating how to use the tool with
praisonaiagentsandlangchain_community.utilities.SerpAPIWrapper.
- docs/tools/external/wikipedia-search.mdx
- Created a new documentation page for the Wikipedia Search tool.
- The page includes a title, description, and icon in the frontmatter.
- Added an overview section explaining the tool's purpose.
- Included installation instructions using
pipforlangchain-communityand setting theOPENAI_API_KEYenvironment variable. - Provided example code demonstrating how to use the tool with
praisonaiagentsandlangchain_community.utilities.WikipediaAPIWrapper.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Trivia time!
What is the origin of the name 'Wikipedia'?
Click here for the answer
The name 'Wikipedia' is a portmanteau of the words 'wiki' (a type of collaborative website) and 'encyclopedia'.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds documentation for several new search tools, enhancing the usability of PraisonAI agents. The documentation includes installation instructions, overviews, and example code for each tool. Overall, the changes are well-structured and contribute positively to the project. However, there are a few areas that could be improved for clarity and consistency.
Summary of Findings
- Inconsistent Installation Instructions: The installation instructions vary slightly across different documentation pages. Standardizing these instructions would improve user experience.
- Missing Dependencies: Some documentation pages do not list all necessary dependencies in the installation instructions, potentially leading to user setup issues.
- Incomplete Example Code: The example code provided in some documentation pages lacks necessary context or imports, making it difficult for users to run the examples directly.
Merge Readiness
The pull request is a valuable addition to the documentation. However, addressing the inconsistencies in installation instructions and ensuring all dependencies are listed would significantly improve the user experience. I recommend addressing the identified issues before merging. I am unable to directly approve the pull request, and that users should have others review and approve this code before merging.
| ```bash | ||
| pip install praisonaiagents | ||
| export OPENAI_API_KEY=your_api_key_here |
There was a problem hiding this comment.
Consider adding a comment about the purpose of exporting the OPENAI_API_KEY environment variable, as well as mentioning that this is a prerequisite for using the tool.
# Set the OpenAI API key (required for using the tool)
export OPENAI_API_KEY=your_api_key_here
| pip install praisonaiagents exa-py | ||
| export EXA_API_KEY=your_api_key_here | ||
| export OPENAI_API_KEY=your_api_key_here |
There was a problem hiding this comment.
It's great that you're including the installation instructions for the exa-py package. However, consider adding a comment about the purpose of exporting the EXA_API_KEY and OPENAI_API_KEY environment variables, as well as mentioning that these are prerequisites for using the tool.
# Set the Exa API key (required for using the Exa Search tool)
export EXA_API_KEY=your_api_key_here
# Set the OpenAI API key (required for using the tool)
export OPENAI_API_KEY=your_api_key_here
| pip install langchain-community python-dotenv | ||
| export SERPER_API_KEY=your_api_key_here | ||
| export OPENAI_API_KEY=your_api_key_here |
There was a problem hiding this comment.
It's great that you're including the installation instructions for the langchain-community and python-dotenv packages. However, consider adding a comment about the purpose of exporting the SERPER_API_KEY and OPENAI_API_KEY environment variables, as well as mentioning that these are prerequisites for using the tool.
# Set the Serper API key (required for using the Google Serper Search tool)
export SERPER_API_KEY=your_api_key_here
# Set the OpenAI API key (required for using the tool)
export OPENAI_API_KEY=your_api_key_here
| pip install langchain-community google-search-results | ||
| export SERPAPI_API_KEY=your_api_key_here | ||
| export OPENAI_API_KEY=your_api_key_here |
There was a problem hiding this comment.
It's great that you're including the installation instructions for the langchain-community and google-search-results packages. However, consider adding a comment about the purpose of exporting the SERPAPI_API_KEY and OPENAI_API_KEY environment variables, as well as mentioning that these are prerequisites for using the tool.
# Set the SerpAPI API key (required for using the SerpSearch tool)
export SERPAPI_API_KEY=your_api_key_here
# Set the OpenAI API key (required for using the tool)
export OPENAI_API_KEY=your_api_key_here
| pip install langchain-community | ||
| export OPENAI_API_KEY=your_api_key_here | ||
| ``` |
There was a problem hiding this comment.
Consider adding a comment about the purpose of exporting the OPENAI_API_KEY environment variable, as well as mentioning that this is a prerequisite for using the tool.
# Set the OpenAI API key (required for using the tool)
export OPENAI_API_KEY=your_api_key_here
✅ Deploy Preview for praisonai ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mint.jsonto include new search tools