Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): update doc #2470

Merged
merged 10 commits into from
Apr 22, 2024
Merged

fix(docs): update doc #2470

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
591788d
wip
Zewed Apr 22, 2024
bfabe2d
Merge branch 'main' into fix/docs
Zewed Apr 22, 2024
6b7455b
wip
Zewed Apr 22, 2024
31fcbb0
brain sharing
Zewed Apr 22, 2024
040216b
feature wip
Zewed Apr 22, 2024
b1a75aa
wip
Zewed Apr 22, 2024
b653610
wip
Zewed Apr 22, 2024
78a3277
Merge branch 'main' into fix/docs
Zewed Apr 22, 2024
e4e9369
done
Zewed Apr 22, 2024
b410bc7
small
Zewed Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/features/analytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "Analytics"
---

## Analyze your brains' activity!

<Tip>
The analytics feature can allow you to see which of your brains are the most
useful.
</Tip>

<Steps>
<Step title="Go to Brain Studio"></Step>
<Step title="Click on Analytics"></Step>
<Step title="Filter by Brain or get all your brains analytics"></Step>
</Steps>

<Snippet file="commercial.mdx" />
24 changes: 24 additions & 0 deletions docs/features/brain-creation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "Brain Creation"
---

## Create Brains connected to Specific Data Sources

<Steps>
<Step title="Choose a type of Brain">
Choose the type of Brain you want to use, based on the data source you wish
to interact with.
</Step>
<Step title="Define your Brain identity">
Name your Brain and provide a detailed description. The better the
description, the more effective it will be because when you search for
information in Quivr without specifying the Brain you want to interact with,
Quivr will automatically select the best Brain to answer your question based
on its description.
</Step>
<Step title="Feed your Brain">
If necessary, feed your brain with data that it can store.
</Step>
</Steps>

<Snippet file="commercial.mdx" />
29 changes: 29 additions & 0 deletions docs/features/brain-customisation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Brain Customisation"
---

## Customize your brain to fit your needs.

<CardGroup cols={2}>
<Card title="Model" icon="robot">
For each of your brains, you can choose which model you want to use.
</Card>

<Card title="Max Token" icon="paragraph">
You can set the maximum token count to define the maximum size of your brain's responses.
</Card>
</CardGroup>

<Tip>You can also update the name and description of the brain if needed.</Tip>

## Choose your prompt

You can choose from a library of prompts or create your own.

<Info>
A prompt in this context refers to a specific instruction or set of
instructions given to an AI system to perform a particular task or generate a
specific type of response.
</Info>

<Snippet file="commercial.mdx" />
59 changes: 59 additions & 0 deletions docs/features/brain-sharing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: Brain Sharing
---

Quivr provides a powerful feature to share your brains with others. This can be done by sharing with individuals via their emails and assigning them specific rights. The rights can be categorized into three types: Viewer, Editor, and Owner.

## Types of User Rights

Each user type has different levels of access and capabilities within a shared brain. Here's a breakdown:

<CardGroup cols={3}>
<Card title="Viewer" icon="eye">
A viewer has the right to ask questions to the brain. They can interact with the brain but cannot modify or delete any information.
</Card>

<Card title="Editor" icon="pen">
An editor has more rights than a viewer. They can not only ask questions but
also download files from the brain. However, they cannot delete any files.
</Card>

<Card title="Owner" icon="user-crown">
An owner has the highest level of rights. They can ask questions, download files, and even delete files from the brain.
</Card>
</CardGroup>

## How to Share a Brain

Sharing a brain is a straightforward process. Follow these steps:

<Steps>
<Step title="Go to Brain Studio"></Step>

<Step title="Choose the brain that you want to share"></Step>

<Step title="Click on People Tab"></Step>

<Step title="Enter the email address and choose a rol."></Step>

<Step title="Send the invitation"></Step>
</Steps>

The person will receive an email with an invitation to access the brain. They can accept the invitation and start interacting with the brain based on the rights assigned to them.

<Tip>
If the person you are sharing the brain with does not have a Quivr account,
they will be asked to create one before they can access the brain.
</Tip>
<Warning>
Only one mail is sent to the person you are sharing the brain with. If they
lose the mail, they will not be able to access the brain. In such a case, you
will have to share the brain again.
</Warning>
<Info>
Remember, sharing brains in Quivr is a great way to collaborate with your team
or share information with others. Make sure to assign the appropriate rights
to ensure the security and integrity of your information.
</Info>

<Snippet file="commercial.mdx" />
29 changes: 29 additions & 0 deletions docs/features/chat.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Chat"
---

## Chat With your Brain

<CardGroup cols={2}>

<Card title="Chat with your Brains" icon="message">
You can chat with each of your brains, which will give you responses based on the knowledge you have provided them.
</Card>

<Card title="Threads History" icon="messages">
You can access and continue your past conversations with your brains.
</Card>

</CardGroup>

<Tip>
In the same thread, you can decide to talk to multiple brains. For example,
ask a question to a first brain of the 'Docs & URLs' type and reformulate the
response using a 'GPT4' type brain.
</Tip>

## Chat With your Brain

For each response provided by a Brain, you can access the sources by clicking on the file icon at the bottom of the response. You can also like or dislike the response, which will help Quivr improve its responses.

<Snippet file="commercial.mdx" />
19 changes: 19 additions & 0 deletions docs/features/quivr-assistants.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "Quivr Assistants"
---

## Generate usable outputs

<Info>
A Quivr assistant is another kind of Brain. It's an AI agent that generates
usable outputs from specific inputs. For example, input a PDF and receive a
summary of the document as the result.
</Info>

<Steps>
<Step title="Choose your Quivr Assistant"></Step>
<Step title="Give your inputs"></Step>
<Step title="Choose to receive the result by email or upload it to an existing brain."></Step>
</Steps>

<Snippet file="commercial.mdx" />
103 changes: 49 additions & 54 deletions docs/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,103 +1,98 @@
---
title: Introduction
description: Quivr is your Second Brain that can act as your personal assistant.
icon: arrow-right-to-arc
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](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 in less than 5 seconds
<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.
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
**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 ?
## What does it do ?


<div style={{ textAlign: 'center' }}>
<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"/>
<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.
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="Upload a file">
Upload a file to Quivr.
<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 Quivr">
Ask questions to Quivr about your file.
<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="30k+ users" icon="user"/>
<Card title="4k+ companies" icon="building"/>
<Card title="26k+ developers" icon="code"/>
<Card title="Top 100 open-source" icon="osi"/>
<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>


## Use Cases for Quivr

Leverage Quivr to build your next generation of AI applications. Quivr is a platform that enables you to build AI applications that are powered by Foundation Models and Generative AI.
But it also acts as a second brain for your business, helping you to make better decisions, and to automate repetitive tasks.
## Quivr Features

<CardGroup cols={2}>
<Card title="Entreprise ChatGPT" href="/use-cases/entreprise-gpt">
Empower your employees with a complete Private ChatGPT solution.
</Card>
<Card title="Content Generation" href="/use-cases/content-generation">
Generate content for your business with Quivr.
</Card>
<Card title="Human Resources" href="/use-cases/hr">
Harness the power of AI for your HR department.
</Card>
<Card title="Customer Support" href="/use-cases/customer-support">
Automate repetitive tasks for your customer support.
</Card>
<Card title="Market Research" href="/use-cases/market-analysis">
Unlock the power of market research with Quivr.
</Card>
<Card title="Project Management" href="/use-cases/project-management">
Elevate your project management with Quivr.
</Card>
<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" />
<Snippet file="commercial.mdx" />
15 changes: 8 additions & 7 deletions docs/mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,19 @@
"pages": [
"intro",
"install",
"slackbot",
{
"group": "Use Cases",
"group": "Features",
"icon": "lightbulb",
"pages": [
"use-cases/entreprise-gpt",
"use-cases/content-generation",
"use-cases/hr",
"use-cases/market-analysis",
"use-cases/project-management"
"features/brain-creation",
"features/brain-sharing",
"features/quivr-assistants",
"features/chat",
"features/analytics",
"features/brain-customisation"
]
},
"slackbot",
"configuring",
"tech-design",
"contact-us"
Expand Down
Loading