📖 Transcribe and Summarize any business communication at scale with Wordcab's API
Project description
Wordcab Python
📖 Transcribe and Summarize any business communication at scale with Wordcab's API
Wordcab is a transcription and summarization service that provides a simple API to summarize any audio
, text
, or JSON
file.
It also includes compatibility with other transcripts platforms like:
Getting started
You can learn more about Wordcab services and pricing on our website.
If you want to try out the API, you can signup for a free account and start using the API right away.
Requirements
- OS:
- Python:
Installation
You can install Wordcab Python via pip from PyPI:
$ pip install wordcab
Start using the API with any python script right away!
Usage
Start Summary full pipeline
import time
from wordcab import retrieve_job, retrieve_summary, start_summary
from wordcab.core_objects import AudioSource, GenericSource, InMemorySource
# Prepare your input source
## For a transcript stored as a .txt or .json file
source = GenericSource(filepath="path/to/file.txt") # Or file.json
## For a transcript stored as an audio file
source = AudioSource(filepath="path/to/file.mp3")
## For a transcript already in memory
transcript = {"transcript": ["SPEAKER A: Hello.", "SPEAKER B: Hi."]}
source = InMemorySource(obj=transcript)
# Launch the Summarization job
job = start_summary(
source_object=source,
display_name="sample_txt",
summary_type="narrative",
summary_lens=[1, 3],
tags=["sample", "text"],
)
# Wait for the job completion
while True:
job = retrieve_job(job_name=job.job_name)
if job.job_status == "SummaryComplete":
break
else:
time.sleep(3)
# Get the summary id
summary_id = job.summary_details["summary_id"]
# Retrieve the summary
summary = retrieve_summary(summary_id=summary_id)
# Get the summary as a human-readable string
print(summary.get_formatted_summaries())
# Save the json object to a file
with open("wordcab_summary.json", "w") as f:
f.write(summary)
Documentation
Please see the Documentation for more details.
Contributing
Contributions are very welcome. 🚀 To learn more, see the Contributor Guide.
License
Issues
If you encounter any problems, please file an issue along with a detailed description.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file wordcab-0.7.2.tar.gz
.
File metadata
- Download URL: wordcab-0.7.2.tar.gz
- Upload date:
- Size: 31.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.25.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a2975ffda0a0bafbbab2f36b3fbf151ab38b2c35f1b524053e12a5f19347c79 |
|
MD5 | 68665f7ad61f58a7ba155366bc3803f9 |
|
BLAKE2b-256 | 415e47e4644073f65ab89efdc95b58590d18e988c19468cfa49dd79dc67df268 |
File details
Details for the file wordcab-0.7.2-py3-none-any.whl
.
File metadata
- Download URL: wordcab-0.7.2-py3-none-any.whl
- Upload date:
- Size: 36.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.25.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c08307bca6fc8338c2da4b6e1f9f634124f73c0cf90226285a081ae5f61c106d |
|
MD5 | ff1362ff264fa3a4375276ab9dca60cb |
|
BLAKE2b-256 | ab11d849441c91128341690579b8521b32d8368e45f84db875f40410d4e561ad |