Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ API_PORT=8000
LLM_MODEL=gpt-3.5-turbo
LLM_API_KEY=your-api-key-here
LLM_ENGINE_PORT=8001
LLM_ENGINE_URL=http://llm_engine:8001

# Query Router Configuration
QUERY_ROUTER_PORT=8002

RUST_LOG=debug
RUST_LOG=debug
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Lucidata is an LLM based query tool designed to democratize data access. It tran
### Prerequisites

- `docker` installed
- An OpenAPI `API_KEY`
- An OpenAI `API_KEY`

### Usage

Expand All @@ -30,13 +30,19 @@ Lucidata is an LLM based query tool designed to democratize data access. It tran
cd lucidata
```

2. Build and start the application with `docker compose`:
2. Copy the example environment file and edit it to include your OpenAI key:
```bash
cp .env.example .env
# Edit the .env file to include your OpenAI key ...
```

3. Build and start the application with `docker compose`:
```bash
docker compose build # it can take a while to compile, be patient :-)
docker compose up
```

3. Send your query to the query_router endpoint, and check out the results!
4. Send your query to the query_router endpoint, and check out the results!
``` bash
curl -X POST "http://localhost:8002/translate-and-execute" \
-H "Content-Type: application/json" \
Expand All @@ -45,7 +51,7 @@ curl -X POST "http://localhost:8002/translate-and-execute" \
}'
```

4. (Optional) Pipe the output to the `jq` CLI:
5. (Optional) Pipe the output to the `jq` CLI:
``` bash
curl -X POST "http://localhost:8002/translate-and-execute" \
-H "Content-Type: application/json" \
Expand Down
Loading