diff --git a/docs/brains/docs-and-urls.mdx b/docs/brains/docs-and-urls.mdx index 64924cb9e..50b91b56f 100644 --- a/docs/brains/docs-and-urls.mdx +++ b/docs/brains/docs-and-urls.mdx @@ -4,3 +4,37 @@ description: Docs and URLs icon: file --- +## Docs and URLs + +This is the default brain that comes with Quivr. It is a simple brain that is used to answer questions about your files and URLs. + +### How to get started ? 👀 + + + + Go to [Quivr](https://chat.quivr.app) and create a brain + ![Create a brain](/images/create-brain-doc.png) + + + The better your description, the better Quivr will be at finding your brain when you ask questions. + ![Enter a name and a description](/images/brain-name-description.png) + + + You can upload your docs or URLS by clicking on the "Upload" button. + ![Upload your docs or URLS](/images/upload-docs-urls.png) + + + You can customize: + - The name of your brain + - The description of your brain + - The model that your brain uses (GPT3.5 or GPT4) + - The prompt of your brain + + + Ask your Brain questions about the knowledge that you provide. + Simply **@brain** followed by your question. + + + + +You now have a brain that can answer questions about your files and URLs. You can ask your brain questions by typing **@brain** followed by your question. \ No newline at end of file diff --git a/docs/brains/gpt4.mdx b/docs/brains/gpt4.mdx index e8ee9c296..68db46488 100644 --- a/docs/brains/gpt4.mdx +++ b/docs/brains/gpt4.mdx @@ -4,4 +4,23 @@ description: GPT-4 icon: brain --- -Talk to GPT4 via Quivr \ No newline at end of file +## GPT-4 + +This is a brain that allows you to interact with GPT-4. You can ask questions to GPT-4 and get answers in real-time. + +### How to get started ? 👀 + + + + Go to [Quivr](https://chat.quivr.app) and create a brain. + + + Choose GPT-4 as your brain. + + + Ask a question to GPT-4 by typing **@brain** followed by your question. + + + +You now have a brain that can answer questions using GPT-4. You can ask your brain questions by typing **@brain** followed by your question. + diff --git a/docs/images/brain-name-description.png b/docs/images/brain-name-description.png new file mode 100644 index 000000000..73132d34b Binary files /dev/null and b/docs/images/brain-name-description.png differ diff --git a/docs/images/create-brain-doc.png b/docs/images/create-brain-doc.png new file mode 100644 index 000000000..ccb3eeee8 Binary files /dev/null and b/docs/images/create-brain-doc.png differ diff --git a/docs/images/upload-docs-urls.png b/docs/images/upload-docs-urls.png new file mode 100644 index 000000000..044aad6a2 Binary files /dev/null and b/docs/images/upload-docs-urls.png differ diff --git a/docs/intro.mdx b/docs/intro.mdx index cf1bf7063..c0394f45d 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -1,6 +1,7 @@ --- title: Overview description: Quivr is an open source RAG framework to deploy and use **AI assistants** +icon: forward --- 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! diff --git a/docs/mint.json b/docs/mint.json index 08ad1d978..ad212537d 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -71,7 +71,7 @@ "pages": [ "brains/docs-and-urls","brains/gpt4", "brains/sql"] }, { - "group": "Agents", + "group": "Assistants", "pages": ["agents/summary"] } ],