https://github.com/assemblyai/assemblyai-haystack
Haystack integration
https://github.com/assemblyai/assemblyai-haystack
Last synced: about 1 year ago
JSON representation
Haystack integration
- Host: GitHub
- URL: https://github.com/assemblyai/assemblyai-haystack
- Owner: AssemblyAI
- License: apache-2.0
- Created: 2023-10-31T15:48:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-12T10:54:50.000Z (over 2 years ago)
- Last Synced: 2024-05-02T01:47:28.744Z (almost 2 years ago)
- Language: Python
- Size: 61.5 KB
- Stars: 7
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
[](https://github.com/AssemblyAI/assemblyai-haystack/actions/workflows/test.yml)
[](https://github.com/AssemblyAI/assemblyai-haystack/blob/main/LICENSE)
[](https://badge.fury.io/py/assemblyai-haystack)
[](https://pypi.python.org/pypi/assemblyai-haystack/)
[](https://twitter.com/AssemblyAI)
[](https://www.youtube.com/@AssemblyAI)
[
](https://assemblyai.com/discord)
# AssemblyAITranscriber
This custom component is designed for using AssemblyAI with [Haystack (2.x)](https://github.com/deepset-ai/haystack), an open source Python framework for building custom LLM applications. It seamlessly integrates with the AssemblyAI API and enhances Haystack's capabilities.
The AssemblyAITranscriber goes beyond simple audio transcription; it also offers features such as summarization and speaker diarization. This allows you to not only convert audio to text but also obtain concise summaries and identify speakers in the conversation. To use AssemblyAITranscriber, you should pass your `ASSEMBLYAI_API_KEY` as an argument while adding a component (see usage code example below).
More info about AssemblyAI:
* [Website](https://www.assemblyai.com/)
* [Get a Free API key](https://www.assemblyai.com/dashboard/signup)
* [AssemblyAI API Docs](https://www.assemblyai.com/docs)
## Installation
First, install the assemblyai-haystack python package.
```bash
pip install assemblyai-haystack
```
This package installs and uses the AssemblyAI Python SDK. You can find more info about the SDK at the [assemblyai-python-sdk GitHub repo]([https://www.assemblyai.com/docs](https://github.com/AssemblyAI/assemblyai-python-sdk)).
## Usage
The `AssemblyAITranscriber` needs to be initialized with the AssemblyAI API key.
The `run` function needs at least the file_path argument. Audio files can be specified as an URL or a local file path.
You can also specify whether you want summarization and speaker diarization results in the `run` function.
```python
import os
from assemblyai_haystack.transcriber import AssemblyAITranscriber
from haystack.document_stores.in_memory import InMemoryDocumentStore
from haystack import Pipeline
from haystack.components.writers import DocumentWriter
ASSEMBLYAI_API_KEY = os.environ.get("ASSEMBLYAI_API_KEY")
## Use AssemblyAITranscriber in a pipeline
document_store = InMemoryDocumentStore()
file_url = "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3"
indexing = Pipeline()
indexing.add_component("transcriber", AssemblyAITranscriber(api_key=ASSEMBLYAI_API_KEY))
indexing.add_component("writer", DocumentWriter(document_store))
indexing.connect("transcriber.transcription", "writer.documents")
indexing.run(
{
"transcriber": {
"file_path": file_url,
"summarization": None,
"speaker_labels": None,
}
}
)
print("Indexed Document Count:", document_store.count_documents())
```
Note: Calling `indexing.run()` blocks until the transcription is finished.
The results of the transcription, summarization and speaker diarization are returned in separate document lists:
* transcription
* summarization
* speaker_labels
The metadata of the transcription document contains the transcription ID and url of the uploaded audio file.
```json
{
"transcript_id":"73089e32-...-4ae9-97a4-eca7fe20a8b1",
"audio_url":"https://storage.googleapis.com/aai-docs-samples/nbc.mp3"
}
```