Docs: Update full stack docs (#1230)
This commit is contained in:
@@ -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.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
### API Server
|
||||||
|
|
||||||
|
If you want to access the API server, you can do so at http://localhost:8000/docs.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
You can customize the UI and code as per your requirements.
|
||||||
|
|||||||
BIN
docs/images/fullstack-api-server.png
Normal file
BIN
docs/images/fullstack-api-server.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 262 KiB |
Reference in New Issue
Block a user