Skip to content
Open
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
11 changes: 11 additions & 0 deletions audio-rag/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Speechmatics — audio transcription + speaker diarization
SPEECHMATICS_API_KEY=<YOUR_SPEECHMATICS_API_KEY>

# Voyage AI — embeddings (voyage-context-3)
VOYAGE_API_KEY=<YOUR_VOYAGE_API_KEY>

# MongoDB Atlas — vector store connection string
MONGODB_URI=<YOUR_MONGODB_ATLAS_CONNECTION_STRING>

# OpenRouter — LLM (defaults to deepseek/deepseek-v3.2)
OPENROUTER_API_KEY=<YOUR_OPENROUTER_API_KEY>
71 changes: 71 additions & 0 deletions audio-rag/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# RAG over audio using Speechmatics

This project builds a RAG app over audio files.
We use:
- Speechmatics to generate speaker-labeled transcripts from audio files.
- LlamaIndex for orchestrating the RAG app.
- Voyage AI (`voyage-context-3`) for contextualized chunk embeddings.
- MongoDB Atlas Vector Search for storing the embeddings.
- OpenRouter (DeepSeek V3.2) as the LLM.
- Streamlit to build the UI.

## Installation and setup

**Setup Speechmatics**:

Get an API key from [Speechmatics](https://portal.speechmatics.com/) and set it in the `.env` file as follows:

```bash
SPEECHMATICS_API_KEY=<YOUR_API_KEY>
```

**Setup Voyage AI**:

Get an API key from [Voyage AI](https://www.voyageai.com/) for the `voyage-context-3` contextualized embedding model, then set it in the `.env` file as follows:

```bash
VOYAGE_API_KEY=<YOUR_API_KEY>
```

**Setup MongoDB Atlas**:

Create a free cluster at [MongoDB Atlas](https://www.mongodb.com/cloud/atlas/register), then set your connection string in the `.env` file as follows:

```bash
MONGODB_URI=<YOUR_MONGODB_ATLAS_CONNECTION_STRING>
```

**Setup OpenRouter**:

Get an API key from [OpenRouter](https://openrouter.ai/) and set it in the `.env` file as follows:

```bash
OPENROUTER_API_KEY=<YOUR_OPENROUTER_API_KEY>
```

**Install dependencies**:

Ensure you have Python 3.11 or later installed.

```bash
uv sync
```

**Run the app**:

```bash
uv run streamlit run app.py
```

---

## 📬 Stay Updated with Our Newsletter!
**Get a FREE Data Science eBook** 📖 with 150+ essential lessons in Data Science when you subscribe to our newsletter! Stay in the loop with the latest tutorials, insights, and exclusive resources. [Subscribe now!](https://join.dailydoseofds.com)

[![Daily Dose of Data Science Newsletter](https://github.com/patchy631/ai-engineering/blob/main/resources/join_ddods.png)](https://join.dailydoseofds.com)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Verify the image URL references the correct repository.

The image link references patchy631/ai-engineering/blob/main/resources/..., but the PR is in patchy631/ai-engineering-hub. This path mismatch will likely result in a broken image (404) when rendered on GitHub, preventing the newsletter call-to-action from displaying correctly.

🔗 Correcting the image URL
-[![Daily Dose of Data Science Newsletter](https://github.com/patchy631/ai-engineering/blob/main/resources/join_ddods.png)](https://join.dailydoseofds.com)
+[![Daily Dose of Data Science Newsletter](https://github.com/patchy631/ai-engineering-hub/blob/main/resources/join_ddods.png)](https://join.dailydoseofds.com)

Alternatively, verify the correct repository and path where this image resource actually resides.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
[![Daily Dose of Data Science Newsletter](https://github.com/patchy631/ai-engineering/blob/main/resources/join_ddods.png)](https://join.dailydoseofds.com)
[![Daily Dose of Data Science Newsletter](https://github.com/patchy631/ai-engineering-hub/blob/main/resources/join_ddods.png)](https://join.dailydoseofds.com)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@audio-rag/README.md` at line 65, The image URL in the markdown link on line
65 references the incorrect repository path. Update the URL to replace the
repository reference from `patchy631/ai-engineering` to
`patchy631/ai-engineering-hub` to match the correct repository where this PR
resides. Ensure the full path to the image resource, including the
`resources/join_ddods.png` file, matches the actual location in the correct
repository so the image displays properly when rendered on GitHub.


---

## Contribution

Contributions are welcome! Please fork the repository and submit a pull request with your improvements.
Loading