assemblyai 4.3.2 → 4.3.4

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

@@ -45,7 +45,7 @@ export type AutoHighlightResult = {
 };
 /**
  * An array of results for the Key Phrases model, if it is enabled.
- * See [Key phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information.
+ * See {@link https://www.assemblyai.com/docs/models/key-phrases | Key phrases } for more information.
  *
  * @example
  * ```js
@@ -363,7 +363,7 @@ export type ContentSafetyLabelResult = {
 };
 /**
  * An array of results for the Content Moderation model, if it is enabled.
- * See [Content moderation](https://www.assemblyai.com/docs/models/content-moderation) for more information.
+ * See {@link https://www.assemblyai.com/docs/models/content-moderation | Content moderation } for more information.
  *
  * @example
  * ```js
@@ -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;
 };
@@ -987,7 +1007,7 @@ export type RedactedAudioResponse = {
  */
 export type RedactedAudioStatus = "redacted_audio_ready";
 /**
- * Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+ * Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
  * @defaultValue "mp3"
  * @example "mp3"
  */
@@ -1127,7 +1147,7 @@ export type SentimentAnalysisResult = {
      */
     sentiment: Sentiment;
     /**
-     * The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+     * The speaker of the sentence if {@link https://www.assemblyai.com/docs/models/speaker-diarization | Speaker Diarization } is enabled, else null
      */
     speaker?: string | null;
     /**
@@ -1157,11 +1177,11 @@ export type SeverityScoreSummary = {
 /**
  * The speech model to use for the transcription.
  */
-export type SpeechModel = "nano";
+export type SpeechModel = "best" | "nano" | "conformer-2";
 /**
- * The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/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
  */
@@ -1198,7 +1218,7 @@ export type Timestamp = {
 };
 /**
  * The result of the Topic Detection model, if it is enabled.
- * See [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) for more information.
+ * See {@link https://www.assemblyai.com/docs/models/topic-detection | Topic Detection } for more information.
  *
  * @example
  * ```js
@@ -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",
@@ -2081,7 +2101,7 @@ export type Transcript = {
      */
     audio_url: string;
     /**
-     * Whether [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters) is enabled, can be true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/auto-chapters | Auto Chapters } is enabled, can be true or false
      */
     auto_chapters?: boolean | null;
     /**
@@ -2090,7 +2110,7 @@ export type Transcript = {
     auto_highlights: boolean;
     /**
      * An array of results for the Key Phrases model, if it is enabled.
-     * See [Key phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information.
+     * See {@link https://www.assemblyai.com/docs/models/key-phrases | Key phrases } for more information.
      */
     auto_highlights_result?: AutoHighlightsResult | null;
     /**
@@ -2106,12 +2126,12 @@ export type Transcript = {
      */
     confidence?: number | null;
     /**
-     * Whether [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation) is enabled, can be true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/content-moderation | Content Moderation } is enabled, can be true or false
      */
     content_safety?: boolean | null;
     /**
      * An array of results for the Content Moderation model, if it is enabled.
-     * See [Content moderation](https://www.assemblyai.com/docs/models/content-moderation) for more information.
+     * See {@link https://www.assemblyai.com/docs/models/content-moderation | Content moderation } for more information.
      */
     content_safety_labels?: ContentSafetyLabelsResult | null;
     /**
@@ -2127,16 +2147,16 @@ export type Transcript = {
      */
     disfluencies?: boolean | null;
     /**
-     * Whether [Dual channel transcription](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) was enabled in the transcription request, either true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription | Dual channel transcription } was enabled in the transcription request, either true or false
      */
     dual_channel?: boolean | null;
     /**
      * An array of results for the Entity Detection model, if it is enabled.
-     * See [Entity detection](https://www.assemblyai.com/docs/models/entity-detection) for more information.
+     * See {@link https://www.assemblyai.com/docs/models/entity-detection | Entity detection } for more information.
      */
     entities?: Entity[] | null;
     /**
-     * Whether [Entity Detection](https://www.assemblyai.com/docs/models/entity-detection) is enabled, can be true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/entity-detection | Entity Detection } is enabled, can be true or false
      */
     entity_detection?: boolean | null;
     /**
@@ -2144,7 +2164,7 @@ export type Transcript = {
      */
     error?: string;
     /**
-     * Whether [Profanity Filtering](https://www.assemblyai.com/docs/models/speech-recognition#profanity-filtering) is enabled, either true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/speech-recognition#profanity-filtering | Profanity Filtering } is enabled, either true or false
      */
     filter_profanity?: boolean | null;
     /**
@@ -2152,12 +2172,12 @@ export type Transcript = {
      */
     format_text?: boolean | null;
     /**
-     * Whether [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) is enabled, can be true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/topic-detection | Topic Detection } is enabled, can be true or false
      */
     iab_categories?: boolean | null;
     /**
      * The result of the Topic Detection model, if it is enabled.
-     * See [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) for more information.
+     * See {@link https://www.assemblyai.com/docs/models/topic-detection | Topic Detection } for more information.
      */
     iab_categories_result?: TopicDetectionModelResult | null;
     /**
@@ -2166,12 +2186,12 @@ export type Transcript = {
     id: string;
     /**
      * The language of your audio file.
-     * Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).
+     * Possible values are found in {@link https://www.assemblyai.com/docs/concepts/supported-languages | Supported Languages }.
      * The default value is 'en_us'.
      */
-    language_code?: TranscriptLanguageCode;
+    language_code?: LiteralUnion<TranscriptLanguageCode, string>;
     /**
-     * Whether [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) is enabled, either true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection | Automatic language detection } is enabled, either true or false
      */
     language_detection?: boolean | null;
     /**
@@ -2184,43 +2204,43 @@ export type Transcript = {
      */
     punctuate?: boolean | null;
     /**
-     * Whether [PII Redaction](https://www.assemblyai.com/docs/models/pii-redaction) is enabled, either true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/pii-redaction | PII Redaction } is enabled, either true or false
      */
     redact_pii: boolean;
     /**
      * Whether a redacted version of the audio file was generated,
-     * either true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.
+     * either true or false. See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more information.
      */
     redact_pii_audio?: boolean | null;
     /**
      * The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled.
-     * See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.
+     * See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more information.
      */
     redact_pii_audio_quality?: RedactPiiAudioQuality | null;
     /**
      * The list of PII Redaction policies that were enabled, if PII Redaction is enabled.
-     * See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.
+     * See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more information.
      */
     redact_pii_policies?: PiiPolicy[] | null;
     /**
-     * The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+     * 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.
      */
     redact_pii_sub?: SubstitutionPolicy;
     /**
-     * Whether [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis) is enabled, can be true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/sentiment-analysis | Sentiment Analysis } is enabled, can be true or false
      */
     sentiment_analysis?: boolean | null;
     /**
      * An array of results for the Sentiment Analysis model, if it is enabled.
-     * See [Sentiment analysis](https://www.assemblyai.com/docs/models/sentiment-analysis) for more information.
+     * See {@link https://www.assemblyai.com/docs/models/sentiment-analysis | Sentiment analysis } for more information.
      */
     sentiment_analysis_results?: SentimentAnalysisResult[] | null;
     /**
-     * Whether [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, can be true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/speaker-diarization | Speaker diarization } is enabled, can be true or false
      */
     speaker_labels?: boolean | null;
     /**
-     * Tell the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details.
+     * Tell the speaker label model how many speakers it should attempt to identify, up to 10. See {@link https://www.assemblyai.com/docs/models/speaker-diarization | Speaker diarization } for more details.
      */
     speakers_expected?: number | null;
     /**
@@ -2243,20 +2263,20 @@ export type Transcript = {
      */
     status: TranscriptStatus;
     /**
-     * Whether [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled, either true or false
+     * Whether {@link https://www.assemblyai.com/docs/models/summarization | Summarization } is enabled, either true or false
      */
     summarization: boolean;
     /**
-     * The generated summary of the media file, if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled
+     * The generated summary of the media file, if {@link https://www.assemblyai.com/docs/models/summarization | Summarization } is enabled
      */
     summary?: string | null;
     /**
      * The Summarization model used to generate the summary,
-     * if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled
+     * if {@link https://www.assemblyai.com/docs/models/summarization | Summarization } is enabled
      */
     summary_model?: string | null;
     /**
-     * The type of summary generated, if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled
+     * The type of summary generated, if {@link https://www.assemblyai.com/docs/models/summarization | Summarization } is enabled
      */
     summary_type?: string | null;
     /**
@@ -2273,7 +2293,7 @@ export type Transcript = {
     topics?: string[];
     /**
      * When dual_channel or speaker_labels is enabled, a list of turn-by-turn utterance objects.
-     * See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more information.
+     * See {@link https://www.assemblyai.com/docs/models/speaker-diarization | Speaker diarization } for more information.
      */
     utterances?: TranscriptUtterance[] | null;
     /**
@@ -2298,7 +2318,7 @@ export type Transcript = {
     word_boost?: string[];
     /**
      * An array of temporally-sequential word objects, one for each word in the transcript.
-     * See [Speech recognition](https://www.assemblyai.com/docs/models/speech-recognition) for more information.
+     * See {@link https://www.assemblyai.com/docs/models/speech-recognition | Speech recognition } for more information.
      */
     words?: TranscriptWord[] | null;
 };
@@ -2329,39 +2349,52 @@ export type TranscriptCustomSpelling = {
     to: string;
 };
 /**
- * The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).
+ * The language of your audio file. Possible values are found in {@link https://www.assemblyai.com/docs/concepts/supported-languages | Supported Languages }.
  * The default value is 'en_us'.
  *
  * @defaultValue "en_us
  */
 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,
@@ -2452,7 +2490,7 @@ export type TranscriptOptionalParams = {
      */
     audio_start_from?: number;
     /**
-     * Enable [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters), can be true or false
+     * Enable {@link https://www.assemblyai.com/docs/models/auto-chapters | Auto Chapters }, can be true or false
      */
     auto_chapters?: boolean;
     /**
@@ -2464,7 +2502,7 @@ export type TranscriptOptionalParams = {
      */
     boost_param?: TranscriptBoostParam;
     /**
-     * Enable [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be true or false
+     * Enable {@link https://www.assemblyai.com/docs/models/content-moderation | Content Moderation }, can be true or false
      */
     content_safety?: boolean;
     /**
@@ -2484,11 +2522,11 @@ export type TranscriptOptionalParams = {
      */
     disfluencies?: boolean;
     /**
-     * Enable [Dual Channel](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) transcription, can be true or false.
+     * Enable {@link https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription | Dual Channel } transcription, can be true or false.
      */
     dual_channel?: boolean;
     /**
-     * Enable [Entity Detection](https://www.assemblyai.com/docs/models/entity-detection), can be true or false
+     * Enable {@link https://www.assemblyai.com/docs/models/entity-detection | Entity Detection }, can be true or false
      */
     entity_detection?: boolean;
     /**
@@ -2500,16 +2538,16 @@ export type TranscriptOptionalParams = {
      */
     format_text?: boolean;
     /**
-     * Enable [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true or false
+     * Enable {@link https://www.assemblyai.com/docs/models/topic-detection | Topic Detection }, can be true or false
      */
     iab_categories?: boolean;
     /**
-     * The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).
+     * The language of your audio file. Possible values are found in {@link https://www.assemblyai.com/docs/concepts/supported-languages | Supported Languages }.
      * The default value is 'en_us'.
      */
-    language_code?: TranscriptLanguageCode | null;
+    language_code?: LiteralUnion<TranscriptLanguageCode, string> | null;
     /**
-     * Whether [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) was enabled in the transcription request, either true or false.
+     * Whether {@link https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection | Automatic language detection } was enabled in the transcription request, either true or false.
      */
     language_detection?: boolean;
     /**
@@ -2521,32 +2559,32 @@ export type TranscriptOptionalParams = {
      */
     redact_pii?: boolean;
     /**
-     * Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+     * Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
      */
     redact_pii_audio?: boolean;
     /**
-     * Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+     * Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
      * @defaultValue "mp3"
      */
     redact_pii_audio_quality?: RedactPiiAudioQuality;
     /**
-     * The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+     * The list of PII Redaction policies to enable. See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
      */
     redact_pii_policies?: PiiPolicy[];
     /**
-     * The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+     * 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.
      */
     redact_pii_sub?: SubstitutionPolicy | null;
     /**
-     * Enable [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis), can be true or false
+     * Enable {@link https://www.assemblyai.com/docs/models/sentiment-analysis | Sentiment Analysis }, can be true or false
      */
     sentiment_analysis?: boolean;
     /**
-     * Enable [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be true or false
+     * Enable {@link https://www.assemblyai.com/docs/models/speaker-diarization | Speaker diarization }, can be true or false
      */
     speaker_labels?: boolean;
     /**
-     * Tells the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details.
+     * Tells the speaker label model how many speakers it should attempt to identify, up to 10. See {@link https://www.assemblyai.com/docs/models/speaker-diarization | Speaker diarization } for more details.
      * @defaultValue "null
      */
     speakers_expected?: number | null;
@@ -2563,7 +2601,7 @@ export type TranscriptOptionalParams = {
      */
     speech_threshold?: number | null;
     /**
-     * Enable [Summarization](https://www.assemblyai.com/docs/models/summarization), can be true or false
+     * Enable {@link https://www.assemblyai.com/docs/models/summarization | Summarization }, can be true or false
      */
     summarization?: boolean;
     /**
@@ -2644,7 +2682,7 @@ export type TranscriptParagraph = {
     confidence: number;
     end: number;
     /**
-     * The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+     * The speaker of the sentence if {@link https://www.assemblyai.com/docs/models/speaker-diarization | Speaker Diarization } is enabled, else null
      */
     speaker?: string | null;
     start: number;
@@ -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
@@ -2730,7 +2816,7 @@ export type TranscriptSentence = {
     confidence: number;
     end: number;
     /**
-     * The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+     * The speaker of the sentence if {@link https://www.assemblyai.com/docs/models/speaker-diarization | Speaker Diarization } is enabled, else null
      */
     speaker?: string | null;
     start: number;
@@ -2902,7 +2988,7 @@ export type TranscriptWord = {
     confidence: number;
     end: number;
     /**
-     * The speaker of the sentence if [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+     * The speaker of the sentence if {@link https://www.assemblyai.com/docs/models/speaker-diarization | Speaker Diarization } is enabled, else null
      */
     speaker?: string | null;
     start: number;