Skip to content

Commit

Permalink
Application docs
Browse files Browse the repository at this point in the history
  • Loading branch information
NolanTrem committed Sep 30, 2024
1 parent 8368ddd commit c8005e7
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 8 deletions.
24 changes: 17 additions & 7 deletions docs/cookbooks/application.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ icon: 'display'

R2R offers an [open-source React+Next.js application](https://github.com/SciPhi-AI/R2R-Application) designed to give developers an administrative portal for their R2R deployment, and users an application to communicate with out of the box.

In addition, R2R comes with an orchestration GUI powered by Hatchet, which you can learn about [here](/cookbooks/orchestration).

## Setup

### Install PNPM
Expand Down Expand Up @@ -36,7 +34,7 @@ After installation, you may need to add PNPM to your system's PATH.

### Installing and Running the R2R Dashboard

If you're running R2R with the Docker, you already have the R2R dashboard running! Just navigate to [http://localhost:3000](http://localhost:3000).
If you're running R2R with the Docker, you already have the R2R application running! Just navigate to [http://localhost:7273](http://localhost:7273).

If you're running R2R outside of Docker, run the following commands to install the R2R Dashboard.

Expand Down Expand Up @@ -74,15 +72,27 @@ By default, an R2R instance is hosted on port 7272. The login page will include

### Documents

The documents page provides an overview of uploaded documents and their metadata. You can upload new documents and update or delete existing ones.
The documents page provides an overview of uploaded documents and their metadata. You can upload new documents and update, download, or delete existing ones. Additionally, you can view information about each document, including the documents' chunks and previews of PDFs.

![Documents Page](/images/oss_dashboard_documents.png)

### Playground
### Collections

Collections allow users to create and share sets of documents. The collections page provides a place to manage your existing collections or create new collections.

![Collections Page](/images/oss_collections_page.png)

### Chat

In the chat page, you can stream RAG responses with different models and configurable settings. You can interact with both the RAG Agent and RAG endpoints here.

![Chat Interface](/images/chat.png)

### Users

The playground allows streaming RAG responses with different models and configurable settings.
Manage your users and gain insight into their interactions.

![Playground Interface](/images/playground.png)
![Users Page](/images/users.png)

### Logs

Expand Down
Binary file modified docs/images/chat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/oss_dashboard_documents.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/settings.png
Binary file not shown.
Binary file modified docs/images/settings_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/settings_prompts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/sciphi-cloud/projects.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Every search query and subsequent search results that flow through the R2R syste
The configuration file for your R2R system as well as editable system prompts can be found at `https://sciphi-b30ed103-...YOUR-PROJECT...-qwpin2swwa/settings`.

<Frame>
<img src="/images/settings.png" style={{ borderRadius: '0.5rem' }} />
<img src="/images/settings_prompts.png" style={{ borderRadius: '0.5rem' }} />
</Frame>


Expand Down

0 comments on commit c8005e7

Please sign in to comment.