mirror of
https://github.com/StanGirard/quivr.git
synced 2024-11-25 19:07:43 +03:00
refactor(docs): Update Quivr documentation structure and content
This commit is contained in:
Stan Girard
parent
6391d5ecf4
commit
0ecc2775e5
@ -1,41 +1,68 @@
|
|||||||
# Welcome to Quivr Documentation
|
# Welcome to Quivr Documentation
|
||||||
|
|
||||||
Welcome to the documentation of Quivr! This is the place where you'll find help, guidance and support for collaborative software development. Whether you're involved in an open-source community or a large software team, these resources should get you up and running quickly!
|
Quivr, helps you build your second brain, utilizes the power of GenerativeAI to be your personal assistant !
|
||||||
|
|
||||||
[Quivr](https://quivr.app) is your **Second Brain** that can act as your **personal assistant**. Quivr is a platform that enables the creation of AI assistants, referred to as "Brain". These assistants are designed with specialized capabilities. Some can connect to specific data sources, allowing users to interact directly with the data. Others serve as specialized tools for particular use cases, powered by Rag technology. These tools process specific inputs to generate practical outputs, such as summaries, translations, and more.
|
## Key Features 🎯
|
||||||
|
|
||||||
## Quick Links
|
- **Opiniated RAG**: We created a RAG that is opinionated, fast and efficient so you can focus on your product
|
||||||
|
- **LLMs**: Quivr works with any LLM, you can use it with OpenAI, Anthropic, Mistral, Gemma, etc.
|
||||||
|
- **Any File**: Quivr works with any file, you can use it with PDF, TXT, Markdown, etc and even add your own parsers.
|
||||||
|
- **Customize your RAG**: Quivr allows you to customize your RAG, add internet search, add tools, etc.
|
||||||
|
- **Integrations with Megaparse**: Quivr works with [Megaparse](https://github.com/quivrhq/megaparse), so you can ingest your files with Megaparse and use the RAG with Quivr.
|
||||||
|
|
||||||
- [Video Installation](https://dub.sh/quivr-demo)
|
>We take care of the RAG so you can focus on your product. Simply install quivr-core and add it to your project. You can now ingest your files and ask questions.*
|
||||||
|
|
||||||
!!! note
|
**We will be improving the RAG and adding more features everything, stay tuned!**
|
||||||
**Our goal** is to make Quivr the **best personal assistant** that is powered by your knowledge and your applications 🔥
|
|
||||||
|
|
||||||
## What does it do?
|
|
||||||
|
|
||||||
<div style="text-align: center;">
|
This is the core of Quivr, the brain of Quivr.com.
|
||||||
<video width="640" height="480" controls>
|
|
||||||
<source src="https://quivr-cms.s3.eu-west-3.amazonaws.com/singlestore_demo_quivr_232893659c.mp4" type="video/mp4">
|
|
||||||
Your browser does not support the video tag.
|
|
||||||
</video>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
## How to get started? 👀
|
<!-- ## Demo Highlight 🎥
|
||||||
|
|
||||||
!!! tip
|
https://github.com/quivrhq/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5 -->
|
||||||
It takes less than **5 seconds** to get started with Quivr. You can even use your Google account to sign up.
|
|
||||||
|
|
||||||
1. **Create an account**: Go to [Quivr](https://quivr.app) and create an account.
|
## Getting Started 🚀
|
||||||
2. **Create a Brain**: Let us guide you to create your first brain!
|
|
||||||
3. **Feed this Brain**: Add documentation and/or URLs to feed your brain.
|
|
||||||
4. **Ask Questions to your Brain**: Ask your Brain questions about the knowledge that you provide.
|
|
||||||
|
|
||||||
## Empowering Innovation with Foundation Models & Generative AI
|
You can find everything on the [documentation](https://core.quivr.app/).
|
||||||
|
|
||||||
As a Leader in AI, Quivr leverages Foundation Models and Generative AI to empower businesses to achieve gains through Innovation.
|
### Prerequisites 📋
|
||||||
|
|
||||||
- 50k+ users
|
Ensure you have the following installed:
|
||||||
- 6k+ companies
|
|
||||||
- 35k+ github stars
|
- Python 3.10 or newer
|
||||||
- Top 100 open-source
|
|
||||||
|
### 30 seconds Installation 💽
|
||||||
|
|
||||||
|
|
||||||
|
- **Step 1**: Install the package
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install quivr-core # Check that the installation worked
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
- **Step 2**: Create a RAG with 5 lines of code
|
||||||
|
|
||||||
|
```python
|
||||||
|
import tempfile
|
||||||
|
|
||||||
|
from quivr_core import Brain
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
with tempfile.NamedTemporaryFile(mode="w", suffix=".txt") as temp_file:
|
||||||
|
temp_file.write("Gold is a liquid of blue-like colour.")
|
||||||
|
temp_file.flush()
|
||||||
|
|
||||||
|
brain = Brain.from_files(
|
||||||
|
name="test_brain",
|
||||||
|
file_paths=[temp_file.name],
|
||||||
|
)
|
||||||
|
|
||||||
|
answer = brain.ask(
|
||||||
|
"what is gold? asnwer in french"
|
||||||
|
)
|
||||||
|
print("answer:", answer)
|
||||||
|
```
|
||||||
|
|
||||||
|
|||||||
@ -1,5 +0,0 @@
|
|||||||
## Installation
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install quivr-core
|
|
||||||
```
|
|
||||||
@ -59,7 +59,6 @@ plugins:
|
|||||||
nav:
|
nav:
|
||||||
- Home:
|
- Home:
|
||||||
- index.md
|
- index.md
|
||||||
- installation.md
|
|
||||||
- quickstart.md
|
- quickstart.md
|
||||||
- Brain:
|
- Brain:
|
||||||
- brain/index.md
|
- brain/index.md
|
||||||
@ -86,7 +85,4 @@ nav:
|
|||||||
- config/index.md
|
- config/index.md
|
||||||
- config/base_config.md
|
- config/base_config.md
|
||||||
- config/config.md
|
- config/config.md
|
||||||
- Examples:
|
|
||||||
- examples/index.md
|
|
||||||
- examples/custom_storage.md
|
|
||||||
- Enterprise: https://docs.quivr.app/
|
- Enterprise: https://docs.quivr.app/
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user