Skip to content
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.

Sign up for GitHub

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

Add documentation for additional search tools #413

Merged
merged 1 commit into from
Mar 11, 2025
+84 −1
Merged

Add documentation for additional search tools #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,12 @@
"pages": [
"tools/external/serp-api",
"tools/external/brave-search",
"tools/external/google-trends"
"tools/external/google-trends",
"tools/external/exa-search",
"tools/external/wikipedia-search",
"tools/external/duckduckgo-search",
"tools/external/google-serper-search",
"tools/external/serp-search"
]
},
"tools/duckduckgo_tools",
Expand Down
15 changes: 15 additions & 0 deletions docs/tools/external/duckduckgo-search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
---
title: "DuckDuckGo Search Tool"
description: "Guide for using the DuckDuckGo Search tool with PraisonAI agents."
icon: "duck"
---

## Overview

The DuckDuckGo Search tool is a tool that allows you to search the web using the DuckDuckGo search engine.

```bash
pip install praisonaiagents
export OPENAI_API_KEY=your_api_key_here
Comment on lines +11 to +13
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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

```

```python
from praisonaiagents import Agent, PraisonAIAgents
from praisonaiagents.tools import duckduckgo
Expand Down
16 changes: 16 additions & 0 deletions docs/tools/external/exa-search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
---
title: "Exa Search Tool"
description: "Guide for using the Exa Search tool with PraisonAI agents."
icon: "magnifying-glass-chart"
---

## Overview

The Exa Search tool is a tool that allows you to search the web and retrieve content using the Exa API.

```bash
pip install praisonaiagents exa-py
export EXA_API_KEY=your_api_key_here
export OPENAI_API_KEY=your_api_key_here
Comment on lines +12 to +14
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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

```

```python
from praisonaiagents import Agent, PraisonAIAgents
from exa_py import Exa
Expand Down
16 changes: 16 additions & 0 deletions docs/tools/external/google-serper-search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
---
title: "Google Serper Search Tool"
description: "Guide for using the Google Serper Search tool with PraisonAI agents."
icon: "google"
---

## Overview

The Google Serper Search tool is a tool that allows you to search the web using the Google Serper API.

```bash
pip install langchain-community python-dotenv
export SERPER_API_KEY=your_api_key_here
export OPENAI_API_KEY=your_api_key_here
Comment on lines +12 to +14
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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

```

```python
from praisonaiagents import Agent, PraisonAIAgents
from langchain_community.utilities import GoogleSerperAPIWrapper
Expand Down
16 changes: 16 additions & 0 deletions docs/tools/external/serp-search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
---
title: "SerpSearch Tool"
description: "Guide for using the SerpSearch tool with PraisonAI agents."
icon: "searchengin"
---

## Overview

The SerpSearch tool is a tool that allows you to search the web using the SerpAPI.

```bash
pip install langchain-community google-search-results
export SERPAPI_API_KEY=your_api_key_here
export OPENAI_API_KEY=your_api_key_here
Comment on lines +12 to +14
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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

```

```python
from praisonaiagents import Agent, PraisonAIAgents
from langchain_community.utilities import SerpAPIWrapper
Expand Down
15 changes: 15 additions & 0 deletions docs/tools/external/wikipedia-search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
---
title: "Wikipedia Search Tool"
description: "Guide for using the Wikipedia Search tool with PraisonAI agents."
icon: "wikipedia-w"
---

## Overview

The Wikipedia Search tool is a tool that allows you to search and retrieve information from Wikipedia.

```bash
pip install langchain-community
export OPENAI_API_KEY=your_api_key_here
```
Comment on lines +12 to +14
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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


```python
from praisonaiagents import Agent, PraisonAIAgents
from langchain_community.utilities import WikipediaAPIWrapper
Expand Down
Loading