Skip to content

Commit ac9fd02

Browse files
Update readme
1 parent c6a1569 commit ac9fd02

File tree

4 files changed

+45
-9
lines changed

4 files changed

+45
-9
lines changed

examples/transcription/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Transcription demo
2+
3+
This directory contains a demo app, which uses [Fishjam](https://fishjam.io) and [Gemini Live API](https://ai.google.dev/gemini-api/docs/live)
4+
for real-time transcription of ongoing calls.
5+
6+
The application contains an HTTP server written in [FastAPI](https://fastapi.tiangolo.com/)
7+
and uses [uv](https://docs.astral.sh/uv/) for dependency management.
8+
9+
## Running
10+
11+
Make sure to [install uv](https://docs.astral.sh/uv/getting-started/installation/) if you don't have it already.
12+
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 managemen token, which you can get on the [Fishjam website](https://fishjam.io/app)
23+
- `GEMINI_API_KEY`: An API key for the Gemini API. You can generate one on the [Gemini website](https://aistudio.google.com/app/apikey).
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 fastapi dev
32+
```
33+
34+
Now, you can create peer tokens by going to <http://localhost:3000>.
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 as these peers and see your transcriptions live in the console!
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
[project]
22
name = "transcription"
33
version = "0.1.0"
4-
description = "Add your description here"
4+
description = "Fishjam transcription demo"
55
readme = "README.md"
66
requires-python = ">=3.10"
7-
dependencies = ["fastapi[standard]==0.116.0", "fishjam-server-sdk"]
7+
dependencies = [
8+
"fastapi[standard]==0.116.0",
9+
"fishjam-server-sdk",
10+
"google-genai>=1.31.0",
11+
]
812

913
[tool.uv.sources]
1014
fishjam-server-sdk = { workspace = true }

pyproject.toml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ dependencies = [
1515
"httpx>=0.28.0,<0.29.0",
1616
"attrs>=21.3.0",
1717
"flask-cors>=6.0.1,<7",
18-
"google-genai>=1.31.0",
1918
]
2019

2120
[project.urls]
@@ -55,10 +54,7 @@ test = [
5554
default-groups = ["dev", "test"]
5655

5756
[tool.uv.workspace]
58-
members = [
59-
"examples/transcription",
60-
".",
61-
]
57+
members = ["examples/transcription", "."]
6258

6359
[tool.hatch.build.targets.sdist]
6460
include = ["fishjam"]

uv.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)