Skip to content

Commit f19ed00

Browse files
Update README
1 parent eab3dc1 commit f19ed00

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

examples/poet_chat/README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
1-
# Trivia Chat
1+
# Limerick Poet demo
22

3+
This directory contains an example implementation of a real-time chat agent using the [Fishjam](https://fishjam.io) and [OpenAI Agents](https://github.com/openai/openai-agents-python) Python SDKs.
34

5+
The agent introduces itself when the user joins and creates limericks based on what the user says.
6+
The agent handles interruptions from users to ensure a natural conversation flow.
7+
8+
## Running
9+
10+
> ![NOTE] All commands should be run from the parent directory of this README
11+
12+
Make sure to [install uv](https://docs.astral.sh/uv/getting-started/installation/) if you don't have it already.
13+
Once you have `uv` installed, fetch the dependencies with
14+
15+
```bash
16+
uv sync
17+
```
18+
19+
To run the app, you will need 3 environment variables:
20+
21+
- `FISHJAM_ID`: Your Fishjam ID, which you can get on the [Fishjam website](https://fishjam.io/app)
22+
- `FISHJAM_MANAGEMENT_TOKEN`: Your Fishjam management token, which you can get on the [Fishjam website](https://fishjam.io/app)
23+
- `OPENAI_API_KEY`: An API key for the OpenAI Realtime API. You can generate one on the [OpenAI website](https://platform.openai.com/api-keys).
24+
25+
Once you have these variables, you can run the demo with
26+
27+
```bash
28+
FISHJAM_ID=<your-fishjam-id> \
29+
FISHJAM_MANAGEMENT_TOKEN=<your-management-token> \
30+
GEMINI_API_KEY=<your-api-token> \
31+
uv run ./main.py
32+
```
33+
34+
A peer token should be generated and printed to standard output.
35+
You can then use the [minimal-react](https://github.com/fishjam-cloud/web-client-sdk/tree/main/examples/react-client)
36+
demo app to connect with this token and talk with the agent!

0 commit comments

Comments
 (0)