brennv/assemblyai-python-sdk

=====================
assemblyai-python-sdk
=====================


Transcribe audio into text. Recognize made-up words and boost accuracy using custom language models.

- Documentation: https://assemblyai-python-sdk.readthedocs.io
- Issues: https://github.com/assemblyai/assemblyai-python-sdk
- Support: https://assemblyai.com
- Community: https://assemblyaicommunity.slack.com


Getting started
---------------

Run pip install and get an API token from https://assemblyai.com

    pip install assemblyai


Quickstart
----------

    import assemblyai

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

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

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

    text = transcript.text


Transcripts take about half the duration of the audio to complete.


Custom language models
----------------------

The quickstart example transcribes audio using a generic English language model.

In order to retain accuracy with unique word sets, create a custom language model.

For this example, we create a model using a list of words/sentences found on a wikipedia page.

    import assemblyai
    import wikipedia

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

    phrases = wikipedia.page("Pokemon characters").content.split('\n')

    model = aai.train(phrases)

    transcript = aai.transcribe('https://example.com/pokemon.wav', model=model)

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

    text = transcript.text



Model and Transcript attributes
-------------------------------

Prior models and transcripts can by 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',
    >>>  'closed_domain',
    >>>  'warning',
    >>>  'dict']

    transcript.props()

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

The `dict` attribute contains the raw API response:

    model.dict
    transcript.dict

For additional background see: https://docs.assemblyai.com