Skip to main content

Python package for AssemblyAI

Project description

assemblyai

Integrate the AssemblyAI API to accurately recognize speech in your application.

You can also train custom models to more accurately recognize speech in your application, and expand vocabulary with custom words like product/person names.

Documentation:

Slack community: https://docs.assemblyai.com/help/#slack

Issues: https://github.com/assemblyai/assemblyai-python-sdk

Getting started

First, get an API token, and then pip install the SDK.

pip install assemblyai

Quickstart

Start transcribing:

import assemblyai

aai = assemblyai.Client(token='your-secret-api-token')

transcript = aai.transcribe(filename='/path/to/example.wav')

Get the completed transcript. Transcripts take about half the duration of the audio to complete.

while transcript.status != 'completed':
    transcript = transcript.get()

text = transcript.text

Instead of a local file, you can also specify a url for the audio file:

transcript = aai.transcribe(audio_url='https://example.com/example.wav')

Custom models

The quickstart example transcribes audio using our default model. In order to boost accuracy and recognize custom words, you can create a custom model. You can read more about how custom model work in the docs.

Create a custom model.

import assemblyai

aai = assemblyai.Client(token='your-secret-api-token')

# boost accuracy for keywords/phrases, and add custom words
# to the vocabulary
phrases = ["foobar", "Dirk Gently", "electric monk", "yourLingoHere",
           "perhaps a common phrase here", "and a common response"]

model = aai.train(phrases)

Check to see that the model has finished training -- models take about six minutes to complete.

while model.status != 'trained':
    model = model.get()

Reference the model when creating a transcript.

transcript = aai.transcribe(filename='/path/to/example.wav', model=model)

Transcribing stereo audio with two speakers on different channels

For stereo audio with two speakers on separate channels, you can leverage enhanced accuracy and formatting by setting speak_count to 2.

transcript = aai.transcribe('example.wav', speaker_count=2)

Transcribing without formatted text

To receive transcript text without formatting or punctuation, set the option format_text to False (default is True).

transcript = aai.transcribe('example.wav', format_text=False)

Model and Transcript attributes

Prior models and transcripts can be called by ID.

model = aai.model.get(id=<id>)
transcript = aai.transcript.get(id=<id>)

To inspect additional attributes, use props():

model.props()

>>> ['headers',
>>>  'id',
>>>  'status',
>>>  'name',
>>>  'phrases',
>>>  'warning',
>>>  'dict']

transcript.props()

>>> ['headers',
>>>  'id',
>>>  'audio_url',
>>>  'model',
>>>  'status',
>>>  'warning',
>>>  'text',
>>>  'confidence',
>>>  'segments',
>>>  'speaker_count',
>>>  'dict']

The dict attribute contains the raw API response:

model.dict
transcript.dict

For additional background on the raw API response, see: https://docs.assemblyai.com

Troubleshooting

Enable verbose logging by enabling the Client debug option:

import assemblyai

aai = assemblyai.Client(debug=True)

More options to get unstuck:

Development

Install dev requirements, install from source and run tests.

pip install -r requirements_dev.txt
python setup.py install
tox

Contributing

Bug reports and pull requests welcome.

Release notes

0.2.6 - Bug fixes, logging improvements, and cleanup

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
assemblyai-0.2.7-py2.py3-none-any.whl (7.8 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jul 19, 2018
assemblyai-0.2.7.tar.gz (69.8 kB) Copy SHA256 hash SHA256 Source None Jul 19, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page