KhayaClient¶
khaya.KhayaClient(api_key, config=None)
¶
High-level interface to the Khaya API.
Provides translation, automatic speech recognition (ASR), and text-to-speech (TTS) for African languages.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
api_key
|
str
|
Your Khaya API key. Can also be set via the
|
required |
config
|
Settings | None
|
Optional pre-built Settings instance. When provided,
|
None
|
Example::
import os
from khaya import KhayaClient
with KhayaClient(os.environ["KHAYA_API_KEY"]) as khaya:
result = khaya.translate("Hello", "en-tw")
print(result.text)
Async example::
async with KhayaClient(api_key) as khaya:
result = await khaya.atranslate("Hello", "en-tw")
print(result.text)
translate(text, language_pair='en-tw')
¶
Translate text from one language to another.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
str
|
The text to translate. |
required |
language_pair
|
str
|
Source-target language pair (e.g. |
'en-tw'
|
Returns:
| Type | Description |
|---|---|
TranslationResult
|
TranslationResult with |
transcribe(audio_file_path, language='tw')
¶
Transcribe an audio file to text.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
audio_file_path
|
str
|
Path to the .wav audio file. |
required |
language
|
str
|
Language spoken in the audio (e.g. |
'tw'
|
Returns:
| Type | Description |
|---|---|
TranscriptionResult
|
TranscriptionResult with |
synthesize(text, language, speaker=None)
¶
Synthesize speech from text.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
str
|
The text to convert to speech. |
required |
language
|
str
|
Target language code (e.g. |
required |
speaker
|
str | None
|
Optional speaker voice — |
None
|
Returns:
| Type | Description |
|---|---|
SynthesisResult
|
SynthesisResult with |
atranslate(text, language_pair='en-tw')
async
¶
Async version of :meth:translate.
atranscribe(audio_file_path, language='tw')
async
¶
Async version of :meth:transcribe.
asynthesize(text, language, speaker=None)
async
¶
Async version of :meth:synthesize.