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->>submit_audio_for_transcription: Audio URL or Local file path and include other intelligence features
submit_audio_for_transcription-->>User: transcription_id
User->>get_transcription_results: transcription_id, all_details=True/False
get_transcription_results-->>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`
Raw data
{
"_id": null,
"home_page": "https://github.com/afizs/assembly-ai-plus",
"name": "assembly-ai-plus",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python",
"author": "Afiz",
"author_email": "itsafiz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e3/59/a81f4385aee11cc6c5541ed0aec8319c9eaabb40a5f54a777b07283166df/assembly-ai-plus-0.0.11.tar.gz",
"platform": null,
"description": "assembly-ai-plus\n================\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n> Simple Library for transcribing and understanding audio and video\n> files using AssemblyAI.\n\nRead more about AssemblyAI \ud83d\udc49 [Docs](https://www.assemblyai.com/docs)\n\n## Install\n\n``` sh\npip install assembly-ai-plus\n```\n\n### How it works\n\n``` mermaid\nsequenceDiagram\n participant User\n User->>submit_audio_for_transcription: Audio URL or Local file path and include other intelligence features\n submit_audio_for_transcription-->>User: transcription_id\n User->>get_transcription_results: transcription_id, all_details=True/False\n get_transcription_results-->>User: Full Transcription Results\n```\n\n## How to use\n\nThis Library provides a\n[`AssemblyAI`](https://afizs.github.io/assembly-ai-plus/assemblyai.html#assemblyai)\nclass using which you can submit audio files for transcribing and\nunderstanding.\n\n``` python\nfrom assembly_ai_plus.assemblyai import AssemblyAI\n```\n\nFirst create the assembly_ai instance by providing the AssemblyAI API\nKEY, which you can get it for free from\n[here](https://app.assemblyai.com/)\n\n``` python\nassembly_ai = AssemblyAI(api_key='YOURKEY')\n```\n\n### Submit the audio url for transcription\n\n``` python\nres = assembly_ai.submit_audio_for_transcription(audio_url=\"https://bit.ly/3yxKEIY\")\n```\n\n``` python\nres.get('id') # This id is used to extract the actual text from the audio files.\n```\n\n 'rsh0hzmusy-024f-472e-937b-e86223eaf7c9'\n\n### Sumbit Local Audio file for transcription\n\n``` python\nres = assembly_ai.submit_audio_for_transcription(local_audio_file_path='your_file_path')\n```\n\n``` python\nres.get('id')\n```\n\n 'rsh0n4g7nv-f022-409b-b97b-9a138261a0d7'\n\n### Getting the Transcription Result\n\n``` python\nfull_details = assembly_ai.get_transcription_results('rs3c8julbq-177d-4071-ab6f-d7c7a9bb6dbb')\n```\n\n``` python\nprint(full_details['text'])\n```\n\n 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.\n\nWe can check out other details like sentiment analysis from\n`full_details`\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Transcribe and understand your audio/video files super fast.",
"version": "0.0.11",
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "749a797608dff513afad1358bec1b6c5",
"sha256": "1f9487a15deb9874b0ada0d820a12951223d5168b2032879bce1b5978ea44c16"
},
"downloads": -1,
"filename": "assembly_ai_plus-0.0.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "749a797608dff513afad1358bec1b6c5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11010,
"upload_time": "2022-12-11T17:01:02",
"upload_time_iso_8601": "2022-12-11T17:01:02.143986Z",
"url": "https://files.pythonhosted.org/packages/59/0b/de3d8b2e34efe99742c537b92dce4b173946556471ec290201ca26d64b1c/assembly_ai_plus-0.0.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "e1ed52cf5205ce52b8b0f0165072e6c0",
"sha256": "9627052eb9836a6eed9d5120e2b1d3fc900771b7d5e0a32238d38ac6a40c8942"
},
"downloads": -1,
"filename": "assembly-ai-plus-0.0.11.tar.gz",
"has_sig": false,
"md5_digest": "e1ed52cf5205ce52b8b0f0165072e6c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9515,
"upload_time": "2022-12-11T17:01:03",
"upload_time_iso_8601": "2022-12-11T17:01:03.881811Z",
"url": "https://files.pythonhosted.org/packages/e3/59/a81f4385aee11cc6c5541ed0aec8319c9eaabb40a5f54a777b07283166df/assembly-ai-plus-0.0.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-11 17:01:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "afizs",
"github_project": "assembly-ai-plus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "assembly-ai-plus"
}
JSON
