mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-12-14 17:03:29 +03:00
docs(brain): improved
This commit is contained in:
Stan Girard
parent
225280f2f5
commit
1fbeeff326
@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "Backend Development",
|
||||
"label": "Quivr's Brain",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
|
||||
8
docs/docs/backend/api/_category_.json
Normal file
8
docs/docs/backend/api/_category_.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "API",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "How does the API works ?"
|
||||
}
|
||||
}
|
||||
@ -1,8 +1,12 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# API Backend Documentation
|
||||
# How to use the API
|
||||
|
||||
**URL**: https://api.quivr.app
|
||||
|
||||
**Swagger**: https://api.quivr.app/docs
|
||||
|
||||
## Overview
|
||||
This documentation outlines the key points and usage instructions for interacting with the API backend. Please follow the guidelines below to use the backend services effectively.
|
||||
@ -2,6 +2,33 @@
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Introduction
|
||||
Quivr is using FastAPI to provide a RESTful API for the backend. The API is currently in beta and is subject to change. The API is available at [https://api.quivr.app](https://api.quivr.app).
|
||||
|
||||
You can find the Swagger documentation for the API at [https://api.quivr.app/docs](https://api.quivr.app/docs).
|
||||
|
||||
## Overview
|
||||
|
||||
This documentation outlines the key points and usage instructions for interacting with the API backend. Please follow the guidelines below to use the backend services effectively.
|
||||
|
||||
|
||||
## FastAPI
|
||||
|
||||
FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.6+ based on standard Python type hints. FastAPI is a class-based API framework that is built on top of Starlette and Pydantic. FastAPI is a great choice for building APIs because it is easy to use, fast, and has a lot of great features.
|
||||
|
||||
We decided to choose FastAPI because it is a modern, fast, and easy-to-use API framework. FastAPI is also very well documented and has a lot of great features that make it easy to build APIs. FastAPI is also very well supported by the community and has a lot of great features that make it easy to build APIs.
|
||||
|
||||
|
||||
## Authentication
|
||||
|
||||
The API uses API keys for authentication. You can generate an API key by signing in to the frontend application and navigating to the `/config` page. The API key will be required to authenticate your requests to the backend.
|
||||
|
||||
When making requests to the backend API, include the following header:
|
||||
|
||||
```http
|
||||
Authorization: Bearer {api_key}
|
||||
```
|
||||
|
||||
Replace `{api_key}` with the generated API key obtained from the frontend
|
||||
|
||||
You can find more information in the [Authentication](/docs/backend/api/getting_started) section of the documentation.
|
||||
|
||||
You have just learned the **Quivr**
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "Frontend Development",
|
||||
"label": "Quivr's Face",
|
||||
"position": 4,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
|
||||
8
docs/docs/get_started/_category_.json
Normal file
8
docs/docs/get_started/_category_.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Getting Started",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "How to start using Quivr"
|
||||
}
|
||||
}
|
||||
@ -26,22 +26,14 @@ Quivr, your second brain, utilizes the power of GenerativeAI to store and retrie
|
||||
|
||||
## Demo Highlights 🎥
|
||||
|
||||
> **Please note: The DEMO WITH STREAMLIT IS USING AN OLD VERSION**
|
||||
> The new version showcases a fresh UI, however, it is not yet deployed as it lacks some features of the old version. Expected to go live before 25/05/23
|
||||
### **Demo**:
|
||||
|
||||
### **Demo with GPT3.5**:
|
||||
<video width="640" height="480" controls>
|
||||
<source src="https://github.com/StanGirard/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5" type="video/mp4"/>
|
||||
Your browser does not support the video tag.
|
||||
</video>
|
||||
|
||||
https://github.com/StanGirard/quivr/assets/19614572/80721777-2313-468f-b75e-09379f694653
|
||||
|
||||
### **Demo with Claude 100k context**:
|
||||
|
||||
https://github.com/StanGirard/quivr/assets/5101573/9dba918c-9032-4c8d-9eea-94336d2c8bd4
|
||||
|
||||
### **Demo of the new version (Work in progress)**:
|
||||
|
||||
https://github.com/StanGirard/quivr/assets/19614572/a6463b73-76c7-4bc0-978d-70562dca71f5
|
||||
|
||||
## Getting Started: New Version 🚀
|
||||
## Getting Started: 🚀
|
||||
|
||||
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Roadmap
|
||||
|
||||
@ -70,20 +70,19 @@ const config = {
|
||||
src: 'img/logo.png',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'tutorialSidebar',
|
||||
position: 'left',
|
||||
label: 'Tutorial',
|
||||
},
|
||||
{
|
||||
href: '/docs/roadmap',
|
||||
label: 'Roadmap',
|
||||
position: 'left',
|
||||
},
|
||||
{
|
||||
href: 'https://quivr.app',
|
||||
position: 'right',
|
||||
label: 'Try me now',
|
||||
},
|
||||
{
|
||||
href: 'https://github.com/stangirard/Quivr',
|
||||
label: 'GitHub',
|
||||
label: 'Star us on GitHub',
|
||||
position: 'right',
|
||||
},
|
||||
],
|
||||
@ -96,7 +95,7 @@ const config = {
|
||||
items: [
|
||||
{
|
||||
label: 'Get Started',
|
||||
to: '/docs/intro',
|
||||
to: '/docs/get_started/intro',
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
@ -1,41 +1,5 @@
|
||||
import Link from '@docusaurus/Link';
|
||||
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||
import HomepageFeatures from '@site/src/components/HomepageFeatures';
|
||||
import Layout from '@theme/Layout';
|
||||
import clsx from 'clsx';
|
||||
import React from 'react';
|
||||
|
||||
import styles from './index.module.css';
|
||||
|
||||
function HomepageHeader() {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return (
|
||||
<header className={clsx('hero hero--primary', styles.heroBanner)}>
|
||||
<div className="container">
|
||||
<h1 className="hero__title">{siteConfig.title}</h1>
|
||||
<p className="hero__subtitle">{siteConfig.tagline}</p>
|
||||
<div className={styles.buttons}>
|
||||
<Link
|
||||
className="button button--secondary button--lg"
|
||||
to="/docs/intro">
|
||||
Get Started with Quivr 🧠
|
||||
</Link>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
);
|
||||
}
|
||||
|
||||
import { Redirect } from "@docusaurus/router";
|
||||
import React from "react";
|
||||
export default function Home() {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return (
|
||||
<Layout
|
||||
title={`Hello from ${siteConfig.title}`}
|
||||
description="Description will go into a meta tag in <head />">
|
||||
<HomepageHeader />
|
||||
<main>
|
||||
<HomepageFeatures />
|
||||
</main>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
return <Redirect to="docs/get_started/intro.html" />;
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user