{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/DeepgramVoice",
"title": "DeepgramVoice",
"type": "object",
"properties": {
"cachingEnabled": {
"type": "boolean",
"description": "This is the flag to toggle voice caching for the assistant.",
"example": true,
"default": true
},
"provider": {
"type": "string",
"description": "This is the voice provider that will be used.",
"enum": [
"deepgram"
]
},
"voiceId": {
"type": "string",
"description": "This is the provider-specific ID that will be used.",
"enum": [
"asteria",
"luna",
"stella",
"athena",
"hera",
"orion",
"arcas",
"perseus",
"angus",
"orpheus",
"helios",
"zeus",
"thalia",
"andromeda",
"helena",
"apollo",
"arcas",
"aries",
"amalthea",
"asteria",
"athena",
"atlas",
"aurora",
"callista",
"cora",
"cordelia",
"delia",
"draco",
"electra",
"harmonia",
"hera",
"hermes",
"hyperion",
"iris",
"janus",
"juno",
"jupiter",
"luna",
"mars",
"minerva",
"neptune",
"odysseus",
"ophelia",
"orion",
"orpheus",
"pandora",
"phoebe",
"pluto",
"saturn",
"selene",
"theia",
"vesta",
"zeus",
"celeste",
"estrella",
"nestor",
"sirio",
"carina",
"alvaro",
"diana",
"aquila",
"selena",
"javier"
],
"title": "This is the Deepgram Voice ID"
},
"model": {
"type": "string",
"description": "This is the model that will be used. Defaults to 'aura-2' when not specified.",
"enum": [
"aura",
"aura-2"
],
"example": "aura-2"
},
"mipOptOut": {
"type": "boolean",
"description": "If set to true, this will add mip_opt_out=true as a query parameter of all API requests. See https://developers.deepgram.com/docs/the-deepgram-model-improvement-partnership-program#want-to-opt-out\n\nThis will only be used if you are using your own Deepgram API key.\n\n@default false",
"example": false,
"default": false
},
"chunkPlan": {
"description": "This is the plan for chunking the model output before it is sent to the voice provider.",
"allOf": [
{
"$ref": "#/components/schemas/ChunkPlan"
}
]
},
"fallbackPlan": {
"description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
"allOf": [
{
"$ref": "#/components/schemas/FallbackPlan"
}
]
}
},
"required": [
"provider",
"voiceId"
]
}