# Description
Added some initial documentation on RAG workflows, including also some
nice Excalidraw diagrams
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
Adds a new "Privacy & Compliance" page to the Quivr documentation.
- **Introduces a comprehensive overview** of Quivr's commitment to
privacy and compliance, including the open-source security model,
responsible telemetry use, row-level policy enforcement, local data
handling, and LLM compatibility.
- **Details the open-source security model**, emphasizing transparency
and community-driven security enhancements.
- **Explains the responsible use of telemetry**, highlighting minimal
data collection, anonymization, secure storage, and opt-out options.
- **Describes row-level policy enforcement** for database security,
ensuring controlled data access.
- **Clarifies local data handling**, ensuring all data remains local
with no external data transfer without user consent.
- **Highlights compatibility with any LLM**, including local server-run
models, offering flexibility for user needs.
- **Includes information on SOC2 compliance** through partnership with
Porter & Oneleet, aiming for compliance within 90 days for managed
instances.
---
For more details, open the [Copilot Workspace
session](https://copilot-workspace.githubnext.com/QuivrHQ/quivr?shareId=e9ecbf64-d06d-45b6-ab73-c04b9ed7916d).
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).
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
Updates the `docs/brains/gpt4.mdx` documentation to include detailed
instructions on adding a GPT-4 Brain to Quivr and configuring it within
the Supabase integration table.
- Adds a new section titled "Adding GPT-4 Brain to Quivr" that outlines
the steps required to integrate a GPT-4 Brain into Quivr, including
accessing the Supabase dashboard and navigating to the integration
table.
- Provides step-by-step instructions for adding a custom brain named
gpt4 in the Supabase integration table and configuring the necessary
settings for the GPT-4 Brain, such as API keys and preferences.
---
For more details, open the [Copilot Workspace
session](https://copilot-workspace.githubnext.com/QuivrHQ/quivr?shareId=81c5fd43-eb46-407c-a40f-c0b0b3a41925).
This pull request introduces comprehensive documentation for configuring
Supabase in Quivr, including details on CLI usage, running migrations,
resetting the database, and deploying to a hosted version of Supabase.
- **Documentation Addition**: Adds a new document
`docs/configuring/supabase-setup.mdx` that provides a step-by-step guide
on setting up Supabase for Quivr. This includes initializing Supabase,
configuring environment variables, using the Supabase CLI for migrations
and database resets, and deploying to a hosted Supabase environment.
- **Documentation Navigation Update**: Updates `docs/mint.json` to
include a reference to the newly added `supabase-setup.mdx` in the
configuring section, ensuring users can easily find this resource.
---
For more details, open the [Copilot Workspace
session](https://copilot-workspace.githubnext.com/QuivrHQ/quivr?shareId=cadcc1b3-ff9d-4650-b92a-28cadcc3ebdf).
This pull request adds Llama Parse integration for complex document
parsing in Quivr. Llama Parse is a tool from Llama Index that allows you
to read complex documents in Quivr. It provides an API key that needs to
be added to the `.env` file as `LLAMA_CLOUD_API_KEY`. Once configured,
you can use the Llama Parse tool to read `pdf`, `docx`, and `doc` files
in Quivr.
This pull request updates the links in the mint.json file to include a
link to the API documentation. The "Blog" link has been replaced with an
"API Docs" link that points to https://api.quivr.app/docs.
This pull request updates the telemetry configuration in Quivr. The
guide now includes instructions on how to deactivate or configure the
telemetry service.
This pull request adds a new guide to the documentation that explains
how to configure reranking in Quivr. The guide covers the steps to
configure the reranking service using the FlashrankRerank library and
the Cohere ReRanker. It also provides information on the required
environment variables and the default behavior of the Ranker.
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
This pull request adds environment variables, increases user usage, and
adds new models to the Quivr application. It includes the following
commits:
- docs: Add environment variables, increase user usage, and add new
models
This pull request updates the documentation and images for the default
brain in Quivr. It includes instructions on how to get started,
customize the brain, and ask questions. Additionally, it adds
documentation for the GPT-4 brain and provides steps on how to interact
with it.
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
This pull request updates the deployment instructions for Digital Ocean
in the Quivr repository. The instructions now include step-by-step
details on creating a Droplet, choosing the Docker image, updating the
.env file, installing Supabase, allowing the firewall, and launching the
project. The new instructions provide a more comprehensive guide for
deploying Quivr on Digital Ocean.
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
This pull request updates the API documentation to include new sections
on configuring Quivr and contacting the Quivr team. It also removes the
"API Brains" section from the documentation.
# Description
38de2e7440/docs/developers/contribution/llm/ollama.mdx (L20-L25)
Due to architectural changes in the file system, the ollama
documentation is out of date.
The sql files are now nested inside a `migrations` directory instead of
at the root of the supabase directory.
Fixed by adding `migrations` to the path
```bash
mv supabase/migrations/local_20240107152745_ollama.sql supabase/migrations/20240107152745_ollama.sql
supabase db reset
```
## Checklist before requesting a review
Please delete options that are not relevant.
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my code
- [x] I have commented hard-to-understand areas
- [x] I have ideally added tests that prove my fix is effective or that
my feature works
- [x] New and existing unit tests pass locally with my changes
- [x] Any dependent changes have been merged
Fix extra comma in the JSON file
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
# Description
Please include a summary of the changes and the related issue. Please
also include relevant motivation and context.
## Checklist before requesting a review
Please delete options that are not relevant.
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented hard-to-understand areas
- [ ] I have ideally added tests that prove my fix is effective or that
my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged
## Screenshots (if appropriate):
# Added translation status badge from inlang
To better see when there are missing translations or contribution
opportunities.
# What I changed
- Added a dynamic image for markdown that renders the translation status
