Overview
UpliftAISTTService transcribes audio into text using Uplift AI’s
Scribe speech-to-text API, optimized for the Urdu language with optional
domain-specific optimization. It is a SegmentedSTTService built on Uplift AI’s
HTTP transcription endpoint.
Source Repository
Source code, examples, and issues for the Uplift AI STT integration
Uplift AI
Learn more about Uplift AI’s speech services
API Keys
Create and manage your Uplift AI API keys
Installation
This is a community-maintained package distributed separately frompipecat-ai.
It is not yet published to PyPI, so install it directly from GitHub:
Prerequisites
Uplift AI Account Setup
Before using the Uplift AI STT service, you need:- Uplift AI Account: Sign up at Uplift AI
- API Key: Generate a key (format:
sk_api_...) from the API Keys page
Required Environment Variables
UPLIFT_API_KEY: Your Uplift AI API key. Falls back to this environment variable ifapi_keyis not passed to the constructor.
Configuration
str
default:"None"
Uplift AI API key. Falls back to the
UPLIFT_API_KEY environment variable if
not provided.str
default:"https://api.upliftai.org/v1"
Base URL for the Uplift AI API.
int
default:"None"
Audio sample rate in Hz. If not provided, the pipeline’s sample rate is used.
str
default:"scribe"
Model to use for transcription. Options:
"scribe" (full accuracy, 40
credits/min) or "scribe-mini" (cost-effective, 20 credits/min).str
default:"None"
Optional domain-specific optimization. Options:
"phone-commerce" or
"farming".UpliftAISTTService.InputParams
default:"None"
Alternative parameter configuration. See InputParams below.
InputParams
Advanced configuration passed via theparams constructor argument using
UpliftAISTTService.InputParams(...).
See the source
repository for the
authoritative, up-to-date configuration options.