quivr/docs/brains/gpt4.mdx
Stan Girard bbcca2a8fe
docs: Update GPT4 documentation with available tools and use cases (#2580)
Updates the GPT-4 documentation and the `GPT4Brain` class to include
detailed information about the tools available for GPT4Brain and their
use cases.

- **Documentation (`docs/brains/gpt4.mdx`):**
- Adds a new section titled "Tools Available for GPT4Brain" that
describes specific tools: WebSearchTool, ImageGeneratorTool,
URLReaderTool, and EmailSenderTool.
- Provides use cases for each tool, demonstrating how they can be
utilized within GPT4Brain for various scenarios, such as generating
images, reading content from URLs, and sending emails.

- **Code (`backend/modules/brain/integrations/GPT4/Brain.py`):**
- Updates the class documentation to include information about the tools
available for GPT4Brain and outlines use cases for WebSearchTool,
ImageGeneratorTool, URLReaderTool, and EmailSenderTool.
- Maintains the existing functionality of the `GPT4Brain` class,
ensuring compatibility with the newly documented tools and use cases.


---

For more details, open the [Copilot Workspace
session](https://copilot-workspace.githubnext.com/QuivrHQ/quivr?shareId=2c2c1666-e5fb-4a06-bb08-ca967f4fe276).
2024-05-10 09:33:21 -07:00

63 lines
2.5 KiB
Plaintext

---
title: GPT-4
description: GPT-4
icon: brain
---
## GPT-4
This is a brain that allows you to interact with GPT-4. You can ask questions to GPT-4 and get answers in real-time.
### How to get started ? 👀
<Steps>
<Step title="Create a brain">
Go to [Quivr](https://chat.quivr.app) and create a brain.
</Step>
<Step title="Choose GPT-4">
Choose GPT-4 as your brain.
</Step>
<Step title="Ask a question to GPT-4">
Ask a question to GPT-4 by typing **@brain** followed by your question.
</Step>
</Steps>
You now have a brain that can answer questions using GPT-4. You can ask your brain questions by typing **@brain** followed by your question.
## Adding GPT-4 Brain to Quivr
To add a GPT-4 Brain to Quivr, you need to perform the following steps:
<Steps>
<Step title="Access the Supabase dashboard">
Log in to your Supabase account and access the dashboard.
</Step>
<Step title="Navigate to the integration table">
Go to the 'integration' table where you can configure your brains.
</Step>
<Step title="Add a custom brain named gpt4">
Add a new entry to the table with the name 'gpt4' to create a custom GPT-4 brain and type `custom`
</Step>
<Step title="Configure the GPT-4 Brain">
Configure the necessary settings for your GPT-4 Brain, including API keys and other preferences.
</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.