mirror of
https://github.com/StanGirard/quivr.git
synced 2024-12-17 07:31:42 +03:00
8b68aeb64f
# 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):
99 lines
3.6 KiB
Plaintext
99 lines
3.6 KiB
Plaintext
---
|
||
title: Overview
|
||
description: Quivr is an open source RAG framework to deploy and use **AI assistants**
|
||
---
|
||
|
||
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](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.
|
||
|
||
<CardGroup cols={2}>
|
||
<Card title="Understand Quivr" icon="forward" href="/home/quickstart">
|
||
Get your own assistant
|
||
</Card>
|
||
<Card
|
||
title="Video Installation"
|
||
icon="youtube"
|
||
href="https://dub.sh/quivr-demo"
|
||
>
|
||
We've cooked some video materials to get you in-depth assistance for your
|
||
setup.
|
||
</Card>
|
||
</CardGroup>
|
||
|
||
<Tip>
|
||
**Our goal** is to make Quivr the **best open-source personal assistant** that
|
||
is powered by your knowledge and your applications 🔥 It will remain
|
||
open-source
|
||
</Tip>
|
||
|
||
## What does it do ?
|
||
|
||
<div style={{ textAlign: "center" }}>
|
||
<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 ? 👀
|
||
|
||
<Tip>
|
||
It takes less than **5 seconds** to get started with Quivr. You can even use
|
||
your Google account to sign up.
|
||
</Tip>
|
||
|
||
<Steps>
|
||
<Step title="Create an account">
|
||
Go to [Quivr](https://quivr.app) and create an account.
|
||
</Step>
|
||
<Step title="Create a Brain">
|
||
Let us guide you to create you first brain!
|
||
</Step>
|
||
<Step title="Feed this Brain">
|
||
Add documentation and/or URLs to feed your brain.
|
||
</Step>
|
||
<Step title="Ask Questions to your Brain">
|
||
Ask your Brain questions about the knowledge that you provide.
|
||
</Step>
|
||
</Steps>
|
||
|
||
**Empowering Innovation with Foundation Models & Generative AI**
|
||
|
||
As a Leader in AI, Quivr leverages Foundation Models and Generative AI to empower businesses to achieve gains through Innovation.
|
||
|
||
<CardGroup cols={4}>
|
||
<Card title="42k+ users" icon="user" />
|
||
<Card title="6k+ companies" icon="building" />
|
||
<Card title="32k+ github stars" icon="star" />
|
||
<Card title="Top 100 open-source" icon="osi" />
|
||
</CardGroup>
|
||
|
||
## Quivr Features
|
||
|
||
<CardGroup cols={2}>
|
||
<Card title="Brain Creation" href="features/brain-creation">
|
||
Empower your employees with a complete Private ChatGPT solution.
|
||
</Card>
|
||
<Card title="Quivr Assistants" href="/home/use-cases/customer-support">
|
||
Automate repetitive tasks for your customer support.
|
||
</Card>
|
||
<Card title="Brain Sharing" href="/home/use-cases/content-generation">
|
||
Generate content for your business with Quivr.
|
||
</Card>
|
||
<Card title="Chat" href="/home/use-cases/customer-support">
|
||
Automate repetitive tasks for your customer support.
|
||
</Card>
|
||
<Card title="Analytics" href="/home/use-cases/hr">
|
||
Harness the power of AI for your HR department.
|
||
</Card>
|
||
<Card title="Brain Customisation" href="/home/use-cases/customer-support">
|
||
Automate repetitive tasks for your customer support.
|
||
</Card>
|
||
</CardGroup>
|
||
|
||
<Snippet file="commercial.mdx" />
|