assemblyai 4.3.3 → 4.3.4

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [4.3.4] - 2024-04-02
+
+### Added
+
+- `SpeechModel.Best` enum
+- `TranscriptListItem.error` property
+
+### Updated
+
+- Make `PageDetails.prev_url` nullable
+- Rename Realtime to Streaming inside code documentation
+- More inline code documentation
+
+### Fixed
+
+- Rename `SubstitutionPolicy` literal "entity_type" to "entity_name"
+- Fix the pagination example in "List transcripts" sample on README
+
 ## [4.3.3] - 2024-03-18
 
 ### Added

package/README.md

@@ -19,7 +19,6 @@ It is written primarily for Node.js in TypeScript with all types exported, but a
 ## Documentation
 
 Visit the [AssemblyAI documentation](https://www.assemblyai.com/docs) for step-by-step instructions and a lot more details about our AI models and API.
-Explore the [SDK API reference](https://assemblyai.github.io/assemblyai-node-sdk/) for more details on the SDK types, functions, and classes.
 
 ## Quickstart
 
@@ -185,13 +184,18 @@ const page = await client.transcripts.list();
 You can also paginate over all pages.
 
 ```typescript
-let nextPageUrl: string | null = null;
+let previousPageUrl: string | null = null;
 do {
-  const page = await client.transcripts.list(nextPageUrl);
-  nextPageUrl = page.page_details.next_url;
-} while (nextPageUrl !== null);
+  const page = await client.transcripts.list(previousPageUrl);
+  previousPageUrl = page.page_details.prev_url;
+} while (previousPageUrl !== null);
 ```
 
+> [!NOTE]
+> To paginate over all pages, you need to use the `page.page_details.prev_url`
+> because the transcripts are returned in descending order by creation date and time.
+> The first page is are the most recent transcript, and each "previous" page are older transcripts.
+
 </details>
 
 <details>
@@ -241,9 +245,9 @@ You can configure the following events.
 ```typescript
 rt.on("open", ({ sessionId, expiresAt }) => console.log('Session ID:', sessionId, 'Expires at:', expiresAt));
 rt.on("close", (code: number, reason: string) => console.log('Closed', code, reason));
-rt.on("transcript", (transcript: RealtimeTranscript) => console.log('Transcript:', transcript));
-rt.on("transcript.partial", (transcript: PartialTranscript) => console.log('Partial transcript:', transcript));
-rt.on("transcript.final", (transcript: FinalTranscript) => console.log('Final transcript:', transcript));
+rt.on("transcript", (transcript: TranscriptMessage) => console.log('Transcript:', transcript));
+rt.on("transcript.partial", (transcript: PartialTranscriptMessage) => console.log('Partial transcript:', transcript));
+rt.on("transcript.final", (transcript: FinalTranscriptMessage) => console.log('Final transcript:', transcript));
 rt.on("error", (error: Error) => console.error('Error', error));
 ```
 

package/dist/types/asyncapi.generated.d.ts

@@ -107,7 +107,7 @@ export type SessionTerminated = RealtimeBaseMessage & {
 };
 export type TerminateSession = {
     /**
-     * Set to true to end your real-time session forever
+     * Set to true to end your streaming session forever
      */
     terminate_session: boolean;
 };

package/dist/types/openapi.generated.d.ts

@@ -532,7 +532,8 @@ export type LemurActionItemsResponse = LemurBaseResponse & {
  * ```js
  * {
  *   "transcript_ids": [
- *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
+ *     "85f9b381-e90c-46ed-beca-7d76245d375e",
+ *     "7c3acd18-df4d-4432-88f5-1e89f8827eea"
  *   ],
  *   "context": "This is an interview about wildfires.",
  *   "final_model": "default",
@@ -761,12 +762,12 @@ export type LemurSummaryResponse = LemurBaseResponse & {
  * }
  * ```
  */
-export type LemurTaskParams = LemurBaseParams & {
+export type LemurTaskParams = {
     /**
      * Your text to prompt the model to produce a desired output, including any context you want to pass into the model.
      */
     prompt: string;
-};
+} & LemurBaseParams;
 /**
  * @example
  * ```js
@@ -776,12 +777,12 @@ export type LemurTaskParams = LemurBaseParams & {
  * }
  * ```
  */
-export type LemurTaskResponse = LemurBaseResponse & {
+export type LemurTaskResponse = {
     /**
      * The response generated by LeMUR.
      */
     response: string;
-};
+} & LemurBaseResponse;
 /**
  * @example
  * ```js
@@ -823,6 +824,8 @@ export type ListTranscriptParams = {
     throttled_only?: boolean;
 };
 /**
+ * Details of the transcript page.
+ * Details of the transcript page. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
  * @example
  * ```js
  * {
@@ -835,10 +838,27 @@ export type ListTranscriptParams = {
  * ```
  */
 export type PageDetails = {
+    /**
+     * The URL used to retrieve the current page of transcripts
+     */
     current_url: string;
+    /**
+     * The number of results this page is limited to
+     */
     limit: number;
-    next_url?: string | null;
-    prev_url: string;
+    /**
+     * The URL to the next page of transcripts
+     * The URL to the next page of transcripts. The next URL always points to a page with newer transcripts.
+     */
+    next_url: string | null;
+    /**
+     * The URL to the previous page of transcripts
+     * The URL to the next page of transcripts. The previous URL always points to a page with older transcripts.
+     */
+    prev_url: string | null;
+    /**
+     * The actual number of results in the page
+     */
     result_count: number;
 };
 /**
@@ -959,7 +979,7 @@ export type PurgeLemurRequestDataResponse = {
  */
 export type RealtimeTemporaryTokenResponse = {
     /**
-     * The temporary authentication token for real-time transcription
+     * The temporary authentication token for Streaming Speech-to-Text
      */
     token: string;
 };
@@ -1157,11 +1177,11 @@ export type SeverityScoreSummary = {
 /**
  * The speech model to use for the transcription.
  */
-export type SpeechModel = "nano" | "conformer-2";
+export type SpeechModel = "best" | "nano" | "conformer-2";
 /**
- * The replacement logic for detected PII, can be "entity_type" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
+ * The replacement logic for detected PII, can be "entity_name" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
  */
-export type SubstitutionPolicy = "entity_type" | "hash";
+export type SubstitutionPolicy = "entity_name" | "hash";
 /**
  * Format of the subtitles
  */
@@ -1609,7 +1629,7 @@ export type TopicDetectionResult = {
  *   "punctuate": true,
  *   "format_text": true,
  *   "dual_channel": false,
- *   "webhook_url": "https://your-webhook-url/path",
+ *   "webhook_url": "https://your-webhook-url.tld/path",
  *   "webhook_status_code": 200,
  *   "webhook_auth": true,
  *   "webhook_auth_header_name": "webhook-secret",
@@ -2336,32 +2356,45 @@ export type TranscriptCustomSpelling = {
  */
 export type TranscriptLanguageCode = "en" | "en_au" | "en_uk" | "en_us" | "es" | "fr" | "de" | "it" | "pt" | "nl" | "hi" | "ja" | "zh" | "fi" | "ko" | "pl" | "ru" | "tr" | "uk" | "vi";
 /**
+ * A list of transcripts
+ * A list of transcripts. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
  * @example
  * ```js
  * {
  *   "page_details": {
- *     "limit": 2",
- *     "result_count": 2,
- *     "current_url": "https://api.assemblyai.com/v2/transcript?limit=2",
- *     "prev_url": "https://api.assemblyai.com/v2/transcript?limit=2&before_id=62npeahu2b-a8ea-4112-854c-69542c20d90c",
- *     "next_url": "https://api.assemblyai.com/v2/transcript?limit=2&after_id=62nfw3mlar-01ad-4631-92f6-629929496eed"
+ *     "limit": 3",
+ *     "result_count": 3,
+ *     "current_url": "https://api.assemblyai.com/v2/transcript?limit=3",
+ *     "prev_url": "https://api.assemblyai.com/v2/transcript?limit=3&before_id=28a73d01-98db-41dd-9e98-2533ba0af117",
+ *     "next_url": "https://api.assemblyai.com/v2/transcript?limit=3&after_id=b33f4691-85b7-4f31-be12-a87cef1c1229"
  *   },
  *   "transcripts": [
  *     {
- *       "id": "9ea68fd3-f953-42c1-9742-976c447fb463",
- *       "resource_url": "https://api.assemblyai.com/v2/transcript/9ea68fd3-f953-42c1-9742-976c447fb463",
+ *       "id": "b33f4691-85b7-4f31-be12-a87cef1c1229",
+ *       "resource_url": "https://api.assemblyai.com/v2/transcript/b33f4691-85b7-4f31-be12-a87cef1c1229",
  *       "status": "completed",
- *       "created": "2023-11-02T21:49:25.586965",
- *       "completed": "2023-11-02T21:49:25.586965",
- *       "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3"
+ *       "created": "2024-03-11T21:29:59.936851",
+ *       "completed": "2024-03-11T21:30:07.314223",
+ *       "audio_url": "http://deleted_by_user",
+ *       "error": null
  *     },
  *     {
- *       "id": "d5a3d302-066e-43fb-b63b-8f57baf185db",
- *       "resource_url": "https://api.assemblyai.com/v2/transcript/d5a3d302-066e-43fb-b63b-8f57baf185db",
+ *       "id": "ce522f10-d204-42e8-a838-6b95098145cc",
+ *       "resource_url": "https://api.assemblyai.com/v2/transcript/ce522f10-d204-42e8-a838-6b95098145cc",
+ *       "status": "error",
+ *       "created": "2024-03-11T21:23:59.979420",
+ *       "completed": null,
+ *       "audio_url": "https://storage.googleapis.com/client-docs-samples/nbc.mp3",
+ *       "error": "Download error, unable to download https://storage.googleapis.com/client-docs-samples/nbc.mp3. Please make sure the file exists and is accessible from the internet."
+ *     },
+ *     {
+ *       "id": "28a73d01-98db-41dd-9e98-2533ba0af117",
+ *       "resource_url": "https://api.assemblyai.com/v2/transcript/28a73d01-98db-41dd-9e98-2533ba0af117",
  *       "status": "completed",
- *       "created": "2023-11-02T21:49:25.586965",
- *       "completed": "2023-11-02T21:49:25.586965",
- *       "audio_url": "http://deleted_by_user"
+ *       "created": "2024-03-11T21:12:57.372215",
+ *       "completed": "2024-03-11T21:13:03.267020",
+ *       "audio_url": "https://storage.googleapis.com/aai-docs-samples/nbc.mp3",
+ *       "error": null
  *     }
  *   ]
  * }
@@ -2380,7 +2413,8 @@ export type TranscriptList = {
  *   "status": "completed",
  *   "created": "2023-11-02T21:49:25.586965",
  *   "completed": "2023-11-02T21:49:25.586965",
- *   "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3"
+ *   "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3",
+ *   "error": null
  * }
  * ```
  */
@@ -2388,6 +2422,10 @@ export type TranscriptListItem = {
     audio_url: string;
     completed: Date | null;
     created: Date;
+    /**
+     * Error message of why the transcript failed
+     */
+    error: string | null;
     id: string;
     resource_url: string;
     status: TranscriptStatus;
@@ -2402,7 +2440,7 @@ export type TranscriptListItem = {
  *   "punctuate": true,
  *   "format_text": true,
  *   "dual_channel": true,
- *   "webhook_url": "https://your-webhook-url/path",
+ *   "webhook_url": "https://your-webhook-url.tld/path",
  *   "webhook_auth_header_name": "webhook-secret",
  *   "webhook_auth_header_value": "webhook-secret-value",
  *   "auto_highlights": true,
@@ -2653,13 +2691,61 @@ export type TranscriptParagraph = {
 };
 /**
  * The parameters for creating a transcript
+ * @example
+ * ```js
+ * {
+ *   "speech_model": null,
+ *   "language_code": "en_us",
+ *   "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3",
+ *   "punctuate": true,
+ *   "format_text": true,
+ *   "dual_channel": true,
+ *   "webhook_url": "https://your-webhook-url/path",
+ *   "webhook_auth_header_name": "webhook-secret",
+ *   "webhook_auth_header_value": "webhook-secret-value",
+ *   "auto_highlights": true,
+ *   "audio_start_from": 10,
+ *   "audio_end_at": 280,
+ *   "word_boost": [
+ *     "aws",
+ *     "azure",
+ *     "google cloud"
+ *   ],
+ *   "boost_param": "high",
+ *   "filter_profanity": true,
+ *   "redact_pii": true,
+ *   "redact_pii_audio": true,
+ *   "redact_pii_audio_quality": "mp3",
+ *   "redact_pii_policies": [
+ *     "us_social_security_number",
+ *     "credit_card_number"
+ *   ],
+ *   "redact_pii_sub": "hash",
+ *   "speaker_labels": true,
+ *   "speakers_expected": 2,
+ *   "content_safety": true,
+ *   "iab_categories": true,
+ *   "language_detection": false,
+ *   "custom_spelling": [],
+ *   "disfluencies": false,
+ *   "sentiment_analysis": true,
+ *   "auto_chapters": true,
+ *   "entity_detection": true,
+ *   "speech_threshold": 0.5,
+ *   "summarization": true,
+ *   "summary_model": "informative",
+ *   "summary_type": "bullets",
+ *   "custom_topics": true,
+ *   "topics": []
+ * }
+ * ```
  */
-export type TranscriptParams = TranscriptOptionalParams & {
+export type TranscriptParams = {
     /**
      * The URL of the audio or video file to transcribe.
      */
     audio_url: string;
-};
+} & TranscriptOptionalParams;
 /**
  * The notification when the transcript status is completed or error.
  * @example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.3.3",
+  "version": "4.3.4",
   "description": "The AssemblyAI JavaScript SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async and real-time transcription, as well as the latest LeMUR models.",
   "engines": {
     "node": ">=18"

package/src/types/asyncapi.generated.ts

@@ -149,7 +149,7 @@ export type SessionTerminated = RealtimeBaseMessage & {
 
 export type TerminateSession = {
   /**
-   * Set to true to end your real-time session forever
+   * Set to true to end your streaming session forever
    */
   terminate_session: boolean;
 };

package/src/types/openapi.generated.ts

@@ -585,7 +585,8 @@ export type LemurActionItemsResponse = LemurBaseResponse & {
  * ```js
  * {
  *   "transcript_ids": [
- *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
+ *     "85f9b381-e90c-46ed-beca-7d76245d375e",
+ *     "7c3acd18-df4d-4432-88f5-1e89f8827eea"
  *   ],
  *   "context": "This is an interview about wildfires.",
  *   "final_model": "default",
@@ -831,12 +832,12 @@ export type LemurSummaryResponse = LemurBaseResponse & {
  * }
  * ```
  */
-export type LemurTaskParams = LemurBaseParams & {
+export type LemurTaskParams = {
   /**
    * Your text to prompt the model to produce a desired output, including any context you want to pass into the model.
    */
   prompt: string;
-};
+} & LemurBaseParams;
 
 /**
  * @example
@@ -847,12 +848,12 @@ export type LemurTaskParams = LemurBaseParams & {
  * }
  * ```
  */
-export type LemurTaskResponse = LemurBaseResponse & {
+export type LemurTaskResponse = {
   /**
    * The response generated by LeMUR.
    */
   response: string;
-};
+} & LemurBaseResponse;
 
 /**
  * @example
@@ -896,6 +897,8 @@ export type ListTranscriptParams = {
 };
 
 /**
+ * Details of the transcript page.
+ * Details of the transcript page. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
  * @example
  * ```js
  * {
@@ -908,10 +911,27 @@ export type ListTranscriptParams = {
  * ```
  */
 export type PageDetails = {
+  /**
+   * The URL used to retrieve the current page of transcripts
+   */
   current_url: string;
+  /**
+   * The number of results this page is limited to
+   */
   limit: number;
-  next_url?: string | null;
-  prev_url: string;
+  /**
+   * The URL to the next page of transcripts
+   * The URL to the next page of transcripts. The next URL always points to a page with newer transcripts.
+   */
+  next_url: string | null;
+  /**
+   * The URL to the previous page of transcripts
+   * The URL to the next page of transcripts. The previous URL always points to a page with older transcripts.
+   */
+  prev_url: string | null;
+  /**
+   * The actual number of results in the page
+   */
   result_count: number;
 };
 
@@ -1063,7 +1083,7 @@ export type PurgeLemurRequestDataResponse = {
  */
 export type RealtimeTemporaryTokenResponse = {
   /**
-   * The temporary authentication token for real-time transcription
+   * The temporary authentication token for Streaming Speech-to-Text
    */
   token: string;
 };
@@ -1269,12 +1289,12 @@ export type SeverityScoreSummary = {
 /**
  * The speech model to use for the transcription.
  */
-export type SpeechModel = "nano" | "conformer-2";
+export type SpeechModel = "best" | "nano" | "conformer-2";
 
 /**
- * The replacement logic for detected PII, can be "entity_type" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
+ * The replacement logic for detected PII, can be "entity_name" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
  */
-export type SubstitutionPolicy = "entity_type" | "hash";
+export type SubstitutionPolicy = "entity_name" | "hash";
 
 /**
  * Format of the subtitles
@@ -1734,7 +1754,7 @@ export type TopicDetectionResult = {
  *   "punctuate": true,
  *   "format_text": true,
  *   "dual_channel": false,
- *   "webhook_url": "https://your-webhook-url/path",
+ *   "webhook_url": "https://your-webhook-url.tld/path",
  *   "webhook_status_code": 200,
  *   "webhook_auth": true,
  *   "webhook_auth_header_name": "webhook-secret",
@@ -2485,32 +2505,45 @@ export type TranscriptLanguageCode =
   | "vi";
 
 /**
+ * A list of transcripts
+ * A list of transcripts. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
  * @example
  * ```js
  * {
  *   "page_details": {
- *     "limit": 2",
- *     "result_count": 2,
- *     "current_url": "https://api.assemblyai.com/v2/transcript?limit=2",
- *     "prev_url": "https://api.assemblyai.com/v2/transcript?limit=2&before_id=62npeahu2b-a8ea-4112-854c-69542c20d90c",
- *     "next_url": "https://api.assemblyai.com/v2/transcript?limit=2&after_id=62nfw3mlar-01ad-4631-92f6-629929496eed"
+ *     "limit": 3",
+ *     "result_count": 3,
+ *     "current_url": "https://api.assemblyai.com/v2/transcript?limit=3",
+ *     "prev_url": "https://api.assemblyai.com/v2/transcript?limit=3&before_id=28a73d01-98db-41dd-9e98-2533ba0af117",
+ *     "next_url": "https://api.assemblyai.com/v2/transcript?limit=3&after_id=b33f4691-85b7-4f31-be12-a87cef1c1229"
  *   },
  *   "transcripts": [
  *     {
- *       "id": "9ea68fd3-f953-42c1-9742-976c447fb463",
- *       "resource_url": "https://api.assemblyai.com/v2/transcript/9ea68fd3-f953-42c1-9742-976c447fb463",
+ *       "id": "b33f4691-85b7-4f31-be12-a87cef1c1229",
+ *       "resource_url": "https://api.assemblyai.com/v2/transcript/b33f4691-85b7-4f31-be12-a87cef1c1229",
  *       "status": "completed",
- *       "created": "2023-11-02T21:49:25.586965",
- *       "completed": "2023-11-02T21:49:25.586965",
- *       "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3"
+ *       "created": "2024-03-11T21:29:59.936851",
+ *       "completed": "2024-03-11T21:30:07.314223",
+ *       "audio_url": "http://deleted_by_user",
+ *       "error": null
  *     },
  *     {
- *       "id": "d5a3d302-066e-43fb-b63b-8f57baf185db",
- *       "resource_url": "https://api.assemblyai.com/v2/transcript/d5a3d302-066e-43fb-b63b-8f57baf185db",
+ *       "id": "ce522f10-d204-42e8-a838-6b95098145cc",
+ *       "resource_url": "https://api.assemblyai.com/v2/transcript/ce522f10-d204-42e8-a838-6b95098145cc",
+ *       "status": "error",
+ *       "created": "2024-03-11T21:23:59.979420",
+ *       "completed": null,
+ *       "audio_url": "https://storage.googleapis.com/client-docs-samples/nbc.mp3",
+ *       "error": "Download error, unable to download https://storage.googleapis.com/client-docs-samples/nbc.mp3. Please make sure the file exists and is accessible from the internet."
+ *     },
+ *     {
+ *       "id": "28a73d01-98db-41dd-9e98-2533ba0af117",
+ *       "resource_url": "https://api.assemblyai.com/v2/transcript/28a73d01-98db-41dd-9e98-2533ba0af117",
  *       "status": "completed",
- *       "created": "2023-11-02T21:49:25.586965",
- *       "completed": "2023-11-02T21:49:25.586965",
- *       "audio_url": "http://deleted_by_user"
+ *       "created": "2024-03-11T21:12:57.372215",
+ *       "completed": "2024-03-11T21:13:03.267020",
+ *       "audio_url": "https://storage.googleapis.com/aai-docs-samples/nbc.mp3",
+ *       "error": null
  *     }
  *   ]
  * }
@@ -2530,7 +2563,8 @@ export type TranscriptList = {
  *   "status": "completed",
  *   "created": "2023-11-02T21:49:25.586965",
  *   "completed": "2023-11-02T21:49:25.586965",
- *   "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3"
+ *   "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3",
+ *   "error": null
  * }
  * ```
  */
@@ -2538,6 +2572,10 @@ export type TranscriptListItem = {
   audio_url: string;
   completed: Date | null;
   created: Date;
+  /**
+   * Error message of why the transcript failed
+   */
+  error: string | null;
   id: string;
   resource_url: string;
   status: TranscriptStatus;
@@ -2553,7 +2591,7 @@ export type TranscriptListItem = {
  *   "punctuate": true,
  *   "format_text": true,
  *   "dual_channel": true,
- *   "webhook_url": "https://your-webhook-url/path",
+ *   "webhook_url": "https://your-webhook-url.tld/path",
  *   "webhook_auth_header_name": "webhook-secret",
  *   "webhook_auth_header_value": "webhook-secret-value",
  *   "auto_highlights": true,
@@ -2806,13 +2844,61 @@ export type TranscriptParagraph = {
 
 /**
  * The parameters for creating a transcript
+ * @example
+ * ```js
+ * {
+ *   "speech_model": null,
+ *   "language_code": "en_us",
+ *   "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3",
+ *   "punctuate": true,
+ *   "format_text": true,
+ *   "dual_channel": true,
+ *   "webhook_url": "https://your-webhook-url/path",
+ *   "webhook_auth_header_name": "webhook-secret",
+ *   "webhook_auth_header_value": "webhook-secret-value",
+ *   "auto_highlights": true,
+ *   "audio_start_from": 10,
+ *   "audio_end_at": 280,
+ *   "word_boost": [
+ *     "aws",
+ *     "azure",
+ *     "google cloud"
+ *   ],
+ *   "boost_param": "high",
+ *   "filter_profanity": true,
+ *   "redact_pii": true,
+ *   "redact_pii_audio": true,
+ *   "redact_pii_audio_quality": "mp3",
+ *   "redact_pii_policies": [
+ *     "us_social_security_number",
+ *     "credit_card_number"
+ *   ],
+ *   "redact_pii_sub": "hash",
+ *   "speaker_labels": true,
+ *   "speakers_expected": 2,
+ *   "content_safety": true,
+ *   "iab_categories": true,
+ *   "language_detection": false,
+ *   "custom_spelling": [],
+ *   "disfluencies": false,
+ *   "sentiment_analysis": true,
+ *   "auto_chapters": true,
+ *   "entity_detection": true,
+ *   "speech_threshold": 0.5,
+ *   "summarization": true,
+ *   "summary_model": "informative",
+ *   "summary_type": "bullets",
+ *   "custom_topics": true,
+ *   "topics": []
+ * }
+ * ```
  */
-export type TranscriptParams = TranscriptOptionalParams & {
+export type TranscriptParams = {
   /**
    * The URL of the audio or video file to transcribe.
    */
   audio_url: string;
-};
+} & TranscriptOptionalParams;
 
 /**
  * The notification when the transcript status is completed or error.