@novo-learning/novo-sdk/src/entities/exercises/word.ts

SDK for the Novolanguage Speech Analysis API

import { PhonemeList } from './phoneme-list';
import { ProsodyTarget } from './prosody';

export class Word {
  /**
   * The prompt for this word
   */
  label: string;
  /**
   * A list of correct pronunciations of the label
   */
  correctPronunciations: Array<PhonemeList>;
  /**
   * A list of incorrect pronunciations of the label
   */
  incorrectPronunciations: Array<PhonemeList>;

  /**
   * A phoneme which needs to be uttered at the end of the word due to its context
   */
  liaisonPhoneme?: string;

  /**
   * Evaluate when determining the correctness of the pronunciation
   */
  evaluate?: boolean;

  /**
   * Punctuation occurring after the word
   */
  punctuation?: string;

  /**
   * prosody
   */
  prosody?: ProsodyTarget;
}