Docs: Update full stack docs (#1230)

This commit is contained in:
Taranjeet Singh
2024-01-29 20:21:32 -08:00
committed by GitHub
parent 2985b667b0
commit 34c41c87dc
2 changed files with 19 additions and 0 deletions

View File

@@ -8,6 +8,9 @@ Get started with full-stack RAG applications using Embedchain's easy-to-use CLI
Choose your setup method: Choose your setup method:
* [Without docker](#without-docker)
* [With Docker](#with-docker)
### Without Docker ### Without Docker
Ensure these are installed: Ensure these are installed:
@@ -21,6 +24,14 @@ Install Docker from [Docker's official website](https://docs.docker.com/engine/i
## Quick Start Guide ## Quick Start Guide
### Install the package
Before proceeding, make sure you have the Embedchain package installed.
```bash
pip install embedchain -U
```
### Setting Up ### Setting Up
For the purpose of the demo, you have to set `OPENAI_API_KEY` to start with but you can choose any llm by changing the configuration easily. For the purpose of the demo, you have to set `OPENAI_API_KEY` to start with but you can choose any llm by changing the configuration easily.
@@ -60,3 +71,11 @@ Open http://localhost:3000 to view the chat UI.
Check out the Embedchain admin panel to see the document chunks for your RAG application. Check out the Embedchain admin panel to see the document chunks for your RAG application.
![full stack chunks](/images/fullstack-chunks.png) ![full stack chunks](/images/fullstack-chunks.png)
### API Server
If you want to access the API server, you can do so at http://localhost:8000/docs.
![API Server](/images/fullstack-api-server.png)
You can customize the UI and code as per your requirements.

Binary file not shown.

After

Width:  |  Height:  |  Size: 262 KiB