Added updates to diarize option, updated transcription response to include speaker_confidence

Author: briancbarrow

src/types/liveTranscriptionOptions.ts

@@ -62,12 +62,16 @@ export type LiveTranscriptionOptions = {
    * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/redact
    */
   redact?: Array<string>;
+
   /**
-   * Indicates whether to recognize speaker changes. When set to true, each word
+   * Indicates whether to recognize speaker changes. When passed in, each word
    * in the transcript will be assigned a speaker number starting at 0.
+   * Allowed values are either "latest" or "VERSION" where VERSION is the specified version of the diarizer.
+   * If 'true' is passed, it will be assumed to be the old version of the diarizer, and 'speaker_confidence' will not be returned in the response.
    * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/diarize
    */
-  diarize?: boolean;
+  diarize?: string | boolean;
+
   /**
    * Indicates whether to transcribe each audio channel independently. When set
    * to true, you will receive one transcript for each channel, which means you

src/types/prerecordedTranscriptionOptions.ts

@@ -62,12 +62,16 @@ export type PrerecordedTranscriptionOptions = {
    * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/redact
    */
   redact?: Array<string>;
+
   /**
-   * Indicates whether to recognize speaker changes. When set to true, each word
+   * Indicates whether to recognize speaker changes. When passed in, each word
    * in the transcript will be assigned a speaker number starting at 0.
+   * Allowed values are either "latest" or "VERSION" where VERSION is the specified version of the diarizer.
+   * If 'true' is passed, it will be assumed to be the old version of the diarizer, and 'speaker_confidence' will not be returned in the response.
    * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/diarize
    */
-  diarize?: boolean;
+  diarize?: string | boolean;
+
   /**
    * Indicates whether to transcribe each audio channel independently. When set
    * to true, you will receive one transcript for each channel, which means you

src/types/wordBase.ts

@@ -5,4 +5,6 @@ export type WordBase = {
   confidence: number;
   punctuated_word?: string;
   speaker?: number;
+  // speaker_confidence will only be included if 'diarize=latest' or 'diarize=VERSION' is passed in the request
+  speaker_confidence?: number;
 };