mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-09-11 14:36:35 +03:00
bbcca2a8fe
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). |
||
|---|---|---|
| .. | ||
| _snippets | ||
| agents | ||
| brains | ||
| configuring | ||
| deployment | ||
| developers | ||
| features | ||
| images | ||
| video | ||
| .gitignore | ||
| contact-us.mdx | ||
| favicon.ico | ||
| favicon.svg | ||
| install.mdx | ||
| intro.mdx | ||
| mint.json | ||
| README.md | ||
| roadmap.mdx | ||
| slackbot.mdx | ||
| tech-design.mdx | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.