Interface VoiceProfile

Acoustic voice profile returned alongside the transcript when enableVoiceProfile is true. Each dimension is an array of {label, confidence} candidates ordered by descending confidence.

Remarks

The response schema is not publicly documented by Inworld; additional dimension keys may appear at runtime.

interface VoiceProfile {
    accent?: {
        confidence: number;
        label: string;
    }[];
    age?: {
        confidence: number;
        label: string;
    }[];
    emotion?: {
        confidence: number;
        label: string;
    }[];
    pitch?: {
        confidence: number;
        label: string;
    }[];
    vocalStyle?: {
        confidence: number;
        label: string;
    }[];
    [key: string]: unknown;
}

Indexable

[key: string]: unknown

Properties

accent? age? emotion? pitch? vocalStyle?

Properties

Optional accent

accent?: {
    confidence: number;
    label: string;
}[]

Type declaration

  • confidence: number
  • label: string

Optional age

age?: {
    confidence: number;
    label: string;
}[]

Type declaration

  • confidence: number
  • label: string

Optional emotion

emotion?: {
    confidence: number;
    label: string;
}[]

Type declaration

  • confidence: number
  • label: string

Optional pitch

pitch?: {
    confidence: number;
    label: string;
}[]

Type declaration

  • confidence: number
  • label: string

Optional vocalStyle

vocalStyle?: {
    confidence: number;
    label: string;
}[]

Type declaration

  • confidence: number
  • label: string

Settings

Member Visibility

Theme

On This Page

accentageemotionpitchvocalStyle