Metadata-Version: 2.1
Name: assembly-ai-plus
Version: 0.0.9
Summary: Transcribe and understand your audio/video files super fast.
Home-page: https://github.com/afizs/assembly-ai-plus
Author: Afiz
Author-email: itsafiz@gmail.com
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

assembly-ai-plus
================

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

> Simple Library for transcribing and understanding audio and video
> files using AssemblyAI.

Read more about AssemblyAI 👉 [Docs](https://www.assemblyai.com/docs)

## Install

``` sh
pip install assembly-ai-plus
```

### How it works

``` mermaid
sequenceDiagram
  participant User
  User-&gt;&gt;submit_audio_for_transcription: Audio URL or Local file path and include other intelligence features
  submit_audio_for_transcription--&gt;&gt;User: transcription_id
  User-&gt;&gt;get_transcription_results: transcription_id, all_details=True/False
  get_transcription_results--&gt;&gt;User: Full Transcription Results
```

## How to use

This Library provides a
[`AssemblyAI`](https://afizs.github.io/assembly-ai-plus/assemblyai.html#assemblyai)
class using which you can submit audio files for transcribing and
understanding.

``` python
from assembly_ai_plus.assemblyai import AssemblyAI
```

First create the assembly_ai instance by providing the AssemblyAI API
KEY, which you can get it for free from
[here](https://app.assemblyai.com/)

``` python
assembly_ai = AssemblyAI(api_key='YOURKEY')
```

### Submit the audio url for transcription

``` python
res = assembly_ai.submit_audio_for_transcription(audio_url="https://bit.ly/3yxKEIY")
```

``` python
res.get('id') # This id is used to extract the actual text from the audio files.
```

    'rsh0hzmusy-024f-472e-937b-e86223eaf7c9'

### Sumbit Local Audio file for transcription

``` python
res = assembly_ai.submit_audio_for_transcription(local_audio_file_path='your_file_path')
```

``` python
res.get('id')
```

    'rsh0n4g7nv-f022-409b-b97b-9a138261a0d7'

### Getting the Transcription Result

``` python
full_details = assembly_ai.get_transcription_results('rs3c8julbq-177d-4071-ab6f-d7c7a9bb6dbb')
```

``` python
print(full_details['text'])
```

    You know, demons on TV like that. And and for people to expose themselves to being rejected on TV or, you know, humili humiliated by Fear Factor or, you know.

We can check out other details like sentiment analysis from
`full_details`
