mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-12-16 01:55:15 +03:00
9edf82031a
added example
96 lines
3.8 KiB
Plaintext
96 lines
3.8 KiB
Plaintext
---
|
|
title: "Features"
|
|
---
|
|
|
|
## Welcome to Quivr 👋
|
|
|
|
Quivr is a **knowledge management** tool that allows you to **store** and **search** your knowledge.
|
|
|
|
<Frame caption="Quivr Homepage">
|
|
<img src="/images/homepage.png" alt="Quivr"/>
|
|
</Frame>
|
|
|
|
|
|
## How can you leverage Quivr ? 🚀
|
|
|
|
You can use Quivr to:
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Search in files" icon="searchengin">
|
|
Quivr allows you to easily ask questions about your files
|
|
</Accordion>
|
|
<Accordion title="Cross-search" icon="shuffle">
|
|
Tired of Cross referencing your information between files ?
|
|
</Accordion>
|
|
<Accordion title="Store your knowledge" icon="database">
|
|
Store all your knowledge in one place
|
|
</Accordion>
|
|
<Accordion title="Share your knowledge" icon="share">
|
|
Share your knowledge with your team by leveraging the collaboration features
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
|
|
## Features 🤗
|
|
|
|
### Public & Private Brains
|
|
|
|
You can create **public** and **private** brains.
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Public" icon="globe">
|
|
A public brain is a brain that is searchable by everyone on Quivr. You can make a brain public by clicking on the **public** button on the brain page.
|
|
</Accordion>
|
|
<Accordion title="Private" icon="lock">
|
|
A private brain is a brain that is only searchable by you. You can make a brain private by clicking on the **private** button on the brain page.
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
|
|
You can share your brains with a set of people by using their emails. This means that you can **collaborate** with your team on a brain without making it public.
|
|
|
|
### Ask Questions to a Brain
|
|
|
|
Quivr is designed to answer your questions by leveraging the knowledge that you've uploaded to it. Here's how you can ask questions:
|
|
|
|
<Steps>
|
|
<Step title="Access Quivr" icon="searchengin">
|
|
Go to [Quivr](https://quivr.app) and login to your account.
|
|
</Step>
|
|
<Step title="Select a Brain" icon="database">
|
|
Select the brain you want to ask a question to. A brain in Quivr is a knowledge base that you or someone else has created. If you haven't created a brain yet, you'll need to do that first.
|
|
</Step>
|
|
<Step title="Ask Your Question" icon="question">
|
|
There should be a text input field where you can type your question. Enter your question into this field.
|
|
</Step>
|
|
<Step title="Submit Your Question" icon="check">
|
|
Submit your question. Depending on the platform, this might involve pressing enter, clicking a button, or performing some other action.
|
|
</Step>
|
|
<Step title="Wait for the Answer" icon="clock">
|
|
Quivr will process your question and provide an answer. The time it takes to get an answer will depend on the complexity of your question and the size of the brain you're asking.
|
|
</Step>
|
|
</Steps>
|
|
|
|
Remember, Quivr is only as smart as the knowledge you've given it. If it doesn't know the answer to a question, consider adding more information to your brain.
|
|
|
|
### Custom Personality
|
|
|
|
You can **customize** the personality of Quivr by changing the **prompt** of your brain. You could tell your brain to always answer with a **funny** or **serious** tone or act like a **robot** or a **human**.
|
|
|
|
To customize the prompt of your brain in Quivr, you would typically follow these steps:
|
|
<Steps>
|
|
<Step title="Brain Settings">
|
|
Navigate to the brain settings. This is usually accessible from the main interface where your brains are listed.
|
|
</Step>
|
|
<Step title="Prompt">
|
|
Look for a setting or field named "Prompt". This is where you can define the custom prompt for your brain.
|
|
</Step>
|
|
<Step title="Enter Prompt">
|
|
Enter your desired custom prompt. This could instruct your brain to always answer with a certain tone (funny, serious, etc.) or to behave like a certain character (robot, human, etc.).
|
|
</Step>
|
|
<Step title="Save Changes">
|
|
Save your changes. There should be a button or option to save or apply your changes.
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Snippet file="commercial.mdx" /> |