Merge pull request #85 from deepgram/formatting-features

added formatting features to live and pre-recorded transcriptions

src/types/liveTranscriptionOptions.ts

@@ -100,9 +100,20 @@ export type LiveTranscriptionOptions = {
    * numerical format (e.g., 1). Deepgram can format numbers up to 999,999.
    * @remarks Converted numbers do not include punctuation. For example,
    * 999,999 would be transcribed as 999999.
-   * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/numerals
+   * @see https://developers.deepgram.com/documentation/features/numerals/
+   */
+  numbers?: boolean;
+
+  /**
+   * Same as numbers. Is the old name for the option. Will eventually be deprecated
    */
   numerals?: boolean;
+
+  /**
+   * adds spaces between numbers in the transcript
+   */
+  numbers_spaces?: boolean;
+
   /**
    * Terms or phrases to search for in the submitted audio. Deepgram searches
    * for acoustic patterns in audio rather than text patterns in transcripts
@@ -182,4 +193,35 @@ export type LiveTranscriptionOptions = {
    * diarize, or multichannel to true.
    */
   paragraphs?: boolean;
+
+  /**
+   * Indicates whether to convert dates from written format (e.g., january first) to
+   * numerical format (e.g., 01-01).
+   */
+  dates?: boolean;
+
+  /**
+   * Indicates the format the dates will be converted to. Requires dates to be turned on.
+   * Format string is specified using chrono strftime notation https://docs.rs/chrono/latest/chrono/format/strftime/index.html   *
+   * @example %Y-%m-%d
+   */
+  date_format?: string;
+
+  /**
+   * Indicates whether to convert times from written format (e.g., three oclock) to
+   * numerical format (e.g., 3:00).
+   * 	*/
+  times: boolean;
+
+  /**
+   * Option to format punctuated commands
+   * Before - “i went to the store period new paragraph then i went home”
+   * After - “i went to the store. <\n> then i went home”
+   */
+  dictation?: boolean;
+
+  /**
+   * Option to format measurements in the transcript
+   * */
+  measurements?: boolean;
 };

src/types/prerecordedTranscriptionOptions.ts

@@ -107,8 +107,18 @@ export type PrerecordedTranscriptionOptions = {
    * 999,999 would be transcribed as 999999.
    * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/numerals
    */
+  numbers?: boolean;
+
+  /**
+   * Same as numbers. Is the old name for the option. Will eventually be deprecated
+   */
   numerals?: boolean;
 
+  /**
+   * adds spaces between numbers in the transcript
+   */
+  numbers_spaces?: boolean;
+
   /**
    * Terms or phrases to search for in the submitted audio. Deepgram searches
    * for acoustic patterns in audio rather than text patterns in transcripts
@@ -202,11 +212,42 @@ export type PrerecordedTranscriptionOptions = {
   /**
    * Indicates whether Deepgram will identify sentiment in the transcript.
    */
-  analyze_sentiment?: boolean
+  analyze_sentiment?: boolean;
 
   /**
-   * Indicates the confidence requirement for non-neutral sentiment. 
+   * Indicates the confidence requirement for non-neutral sentiment.
    * Setting this variable turns sentiment analysis on.
    */
-  sent_thresh?: number
+  sent_thresh?: number;
+
+  /**
+   * Indicates whether to convert dates from written format (e.g., january first) to
+   * numerical format (e.g., 01-01).
+   */
+  dates?: boolean;
+
+  /**
+   * Indicates the format the dates will be converted to. Requires dates to be turned on.
+   * Format string is specified using chrono strftime notation https://docs.rs/chrono/latest/chrono/format/strftime/index.html   *
+   * @example %Y-%m-%d
+   */
+  date_format?: string;
+
+  /**
+   * Indicates whether to convert times from written format (e.g., three oclock) to
+   * numerical format (e.g., 3:00).
+   * 	*/
+  times: boolean;
+
+  /**
+   * Option to format punctuated commands
+   * Before - “i went to the store period new paragraph then i went home”
+   * After - “i went to the store. <\n> then i went home”
+   */
+  dictation?: boolean;
+
+  /**
+   * Option to format measurements in the transcript
+   * */
+  measurements?: boolean;
 };

src/types/usageOptions.ts

@@ -20,6 +20,7 @@ export type UsageOptions = {
   redact?: boolean;
   alternatives?: boolean;
   numerals?: boolean;
+  numbers?: boolean;
   translation?: boolean;
   detect_entities?: boolean;
   detect_topics?: boolean;

src/types/usageRequestDetail.ts

@@ -25,7 +25,8 @@ export type UsageRequestDetail = {
       redact?: boolean;
       alternatives?: boolean;
       numerals?: boolean;
-      translation?:boolean;
+      numbers?: boolean;
+      translation?: boolean;
     };
   };
 };