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

Jump to bottom

docs: Update GPT4 documentation with available tools and use cases #2580

Merged
merged 1 commit into from
May 10, 2024
Merged

docs: Update GPT4 documentation with available tools and use cases #2580

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
19 changes: 14 additions & 5 deletions backend/modules/brain/integrations/GPT4/Brain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,20 @@ class AgentState(TypedDict):


class GPT4Brain(KnowledgeBrainQA):
"""This is the Notion brain class. it is a KnowledgeBrainQA has the data is stored locally.
It is going to call the Data Store internally to get the data.

Args:
KnowledgeBrainQA (_type_): A brain that store the knowledge internaly
"""
GPT4Brain integrates with GPT-4 to provide real-time answers and supports various tools to enhance its capabilities.

Available Tools:
- WebSearchTool: Performs web searches to find relevant information.
- ImageGeneratorTool: Generates images based on textual descriptions.
- URLReaderTool: Reads and summarizes content from URLs.
- EmailSenderTool: Sends emails with specified content.

Use Cases:
- WebSearchTool can be used to find the latest news articles on a specific topic or to gather information from various websites.
- ImageGeneratorTool is useful for creating visual content based on textual prompts, such as generating a company logo based on a description.
- URLReaderTool can be used to summarize articles or web pages, making it easier to quickly understand the content without reading the entire text.
- EmailSenderTool enables automated email sending, such as sending a summary of a meeting's minutes to all participants.
"""

tools: Optional[List[BaseTool]] = None
Expand Down
16 changes: 16 additions & 0 deletions docs/brains/gpt4.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,20 @@ To add a GPT-4 Brain to Quivr, you need to perform the following steps:
</Step>
</Steps>

## Tools Available for GPT4Brain

GPT4Brain is equipped with a variety of tools to enhance its capabilities and provide more comprehensive answers. These tools include:

- **WebSearchTool**: Allows GPT4Brain to perform web searches to find relevant information.
- **ImageGeneratorTool**: Enables GPT4Brain to generate images based on textual descriptions.
- **URLReaderTool**: Allows GPT4Brain to read and summarize content from URLs.
- **EmailSenderTool**: Enables GPT4Brain to send emails with specified content.

### Use Cases

Here are some use cases demonstrating how each tool can be utilized within GPT4Brain:

- **WebSearchTool**: Can be used to find the latest news articles on a specific topic or to gather information from various websites.
- **ImageGeneratorTool**: Useful for creating visual content based on textual prompts, such as generating a company logo based on a description.
- **URLReaderTool**: Can be used to summarize articles or web pages, making it easier to quickly understand the content without reading the entire text.
- **EmailSenderTool**: Enables automated email sending, such as sending a summary of a meeting's minutes to all participants.