quivr/docs/userGuide/brain.mdx
Stan Girard 030b353b41 docs: ✏️ brain
added explanation
2023-12-25 16:54:56 +01:00

99 lines
3.1 KiB
Plaintext

---
sidebar_position: 2
title: Brains
---
<Info>
A few brains were harmed in the making of this documentation 🤯😏
</Info>
# Introduction to Brains
<Steps>
<Step title="Specific to one thing">
A brain is a simple unit that either stores information or is used to do a specific thing. Think of it as your second brain.
</Step>
<Step title="Holds information or Interact with Apps">
A brain can be used to hold information or to interact with apps. For example, you can create a brain to hold information about your company or you can create a brain to interact with your CRM.
</Step>
<Step title="Shareable">
Brains can be shared with other users of Quivr. This allows you to share information with your team or to share apps with your team.
</Step>
</Steps>
# Two kinds of Brains
In Quivr, you can find two kinds of brains: **Document** and **App**.
The brains are here to help you store information or interact with apps. Let's see what each of them can do.
<CardGroup cols={2}>
<Card title="Document" icon="file">
Store all kinds of documents
</Card>
<Card title="App" icon="rocket">
Interact with all your favorite apps
</Card>
</CardGroup>
<Info>
You can create as many brains as you want. You can also share them with your team.
</Info>
We introduced the two kinds of brains in the previous section. Let's dive a little deeper into each of them.
# Create a Brain
Simply go to [Quivr](https://quivr.app/brains-management) and click on the "Add Brain" button.
<Info>
By default, on the free version you can create up to 3 brains. If you need more, you can upgrade to a paid plan.
</Info>
<Steps>
<Step title="Select the type">
Select the type of brain you want to create. You can choose between a document brain or an app brain.
<Frame>
<img src="/images/add-brain.png"/>
</Frame>
</Step>
<Step title="Give it a name & Description">
Give your brain a name. This name will be used to identify your brain in the list of brains.
<Frame>
<img src="/images/add-brain-step2.png"/>
</Frame>
</Step>
<Step title="Public or Private">
You can choose to make your brain public or private. If you make it public, other users will be able to see it and use it. If you make it private, only you will be able to see it.
<Frame>
<img src="/images/add-brain-step3.png"/>
</Frame>
</Step>
<Step title="Upload a file or website">
If you are creating a document brain, you can upload a file or a website.
<Frame>
<img src="/images/add-brain-step4.png"/>
</Frame>
</Step>
<Step title="Chat with your brain">
You can now ask questions to the files of your brain.
<Frame>
<img src="/images/add-brain-step5.png"/>
</Frame>
</Step>
<Step title="Enjoy">
Enjoy your new brain!
<Frame>
<img src="/images/add-brain-step6.png"/>
</Frame>
</Step>
</Steps>
If you have any questions or issue with the documentation, feel free to edit or open an issue.