Skip to main content

list_voices

Signature:

Speech.list_voices() -> list[dict[str, Any]]

Description:

Get list of available voices.

Parameters:

No parameters.

Returns:

list[dict[str, Any]]

Fields included in each voice item in the returned list:

Field

Type

Description

id

str

Voice ID

name

str

Voice name

gender

str

Voice gender identifier

capabilities

list[str]

List of supported voice capabilities; refer to the table below for the values.

Possible values for capabilities:

Value

Description

"chat"

Voice conversation voices available for Speech.chat()

"synthesize"

Speech synthesis voices available for Speech.synthesize()

Raises:

None.

Example:

from boosteros.brain import Speech
from boosteros.robots.booster import BoosterRobot

robot = BoosterRobot()
speech = Speech(robot)
for voice in speech.list_voices():
print(voice["id"], voice["capabilities"])
# Example output: warm_ahu ['chat']