Result Types

All SDK methods return typed result objects instead of raw httpx.Response.

khaya.models.TranslationResult(text, source_language, target_language) dataclass

Result returned by :meth:~khaya.KhayaClient.translate and :meth:~khaya.KhayaClient.atranslate.

Attributes:

Name	Type	Description
text	str	The translated string.
source_language	str	Source language code (e.g. "en").
target_language	str	Target language code (e.g. "tw").

khaya.models.TranscriptionResult(text, language) dataclass

Result returned by :meth:~khaya.KhayaClient.transcribe and :meth:~khaya.KhayaClient.atranscribe.

Attributes:

Name	Type	Description
text	str	The transcribed string.
language	str	Language code of the transcribed audio (e.g. "tw").

khaya.models.SynthesisResult(audio, language) dataclass

Result returned by :meth:~khaya.KhayaClient.synthesize and :meth:~khaya.KhayaClient.asynthesize.

Attributes:

Name	Type	Description
audio	bytes	Raw audio bytes.
language	str	Language code used for synthesis (e.g. "tw").

save(path)

Write the audio bytes to a file.

Parameters:

Name	Type	Description	Default
path	str	Destination file path (e.g. "output.wav").	required