@novo-learning/novo-sdk/src/clients/pronunciation-api/dto/pronunciation.dto.v1.ts

SDK for the Novolanguage Speech Analysis API

import { LanguageCode } from '../../../entities';

export type PhoneArray = Array<string>;

const PauseDto = {
  prohibited: 'prohibited',
  optional: 'optional',
  mandatory: 'mandatory',
} as const;
type PauseDto = typeof PauseDto[keyof typeof PauseDto];

const IntonationDto = {
  falling: 'falling',
  rising: 'rising',
  flat: 'flat',
} as const;
type IntonationDto = typeof IntonationDto[keyof typeof IntonationDto];

export class ProsodyDtoV1 {
  pause?: PauseDto;
  intonation?: IntonationDto;
  stress?: number;
}
export class WordPronunciationDtoV1 {
  word: string;
  correctPronunciations: Array<PhoneArray>;
  incorrectPronunciations: Array<PhoneArray>;
  liaisonPhoneme?: string;
  prosody?: ProsodyDtoV1;
  punctuation?: string;
}

export class TokenPronunciationDtoV1 {
  token: string;
  expanded: string;
  words: Array<WordPronunciationDtoV1>;
}

export class PhrasePronunciationDtoV1 {
  language: LanguageCode;
  phrase: string;
  tokens: Array<TokenPronunciationDtoV1>;
}