Skip to content

Commit 1d66e03

Browse files
Update README.md (#90)
* Update README.md Added llm gateway to env file in crewai and an example of how to get it. * Update plot_agent/crewai_plot_agent/README.md Co-authored-by: Akash Gupta <akash@truefoundry.com> --------- Co-authored-by: Akash Gupta <akash@truefoundry.com>
1 parent e8c92cf commit 1d66e03

File tree

1 file changed

+28
-11
lines changed

1 file changed

+28
-11
lines changed

plot_agent/crewai_plot_agent/README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,23 +49,40 @@ Ensure you have Python >=3.10 <3.13 installed on your system. This project uses
4949
pip install uv
5050
```
5151

52-
### Environment Setup
5352

54-
1. Create a `.env` file in your project root:
55-
```env
56-
OPENAI_API_KEY=your_openai_api_key
57-
CLICKHOUSE_HOST=your_clickhouse_host
58-
CLICKHOUSE_PORT=9000
59-
CLICKHOUSE_DB=your_database
60-
CLICKHOUSE_USER=your_user
61-
CLICKHOUSE_PASSWORD=your_password
53+
### Environment Configuration
54+
55+
1. Copy the example environment file:
56+
```bash
57+
cp .env.example .env
6258
```
6359

64-
2. Install project dependencies:
60+
2. Edit the `.env` file with your actual credentials:
61+
```env
62+
# Truefoundry LLMGateway Configuration
63+
LLM_GATEWAY_BASE_URL=your_llm_gateway_base_url_here
64+
LLM_GATEWAY_API_KEY=your_llm_gateway_api_key_here
65+
66+
# ClickHouse Database Configuration
67+
CLICKHOUSE_HOST=your_clickhouse_host_here
68+
CLICKHOUSE_PORT=443
69+
CLICKHOUSE_USER=your_clickhouse_user_here
70+
CLICKHOUSE_PASSWORD=your_clickhouse_password_here
71+
CLICKHOUSE_DATABASE=default
72+
```
73+
3. Install project dependencies:
6574
```bash
6675
uv sync
6776
```
68-
77+
### How to Get Your LLM Gateway Base URL
78+
79+
You can find your LLM_GATEWAY_BASE_URL from the TrueFoundry console:
80+
1. Navigate to the LLM Gateway service on your TrueFoundry dashboard.
81+
2. Click on the deployed endpoint you want to use. Then click on code in the top right.
82+
3. Copy the base part of the URL from the endpoint details. It usually looks like:
83+
```
84+
https://<your-platform-url>/api/llm/api/inference/openai
85+
```
6986
### Configuration
7087

7188
1. **Agent Configuration**:

0 commit comments

Comments
 (0)