assemblyai 4.3.2 → 4.3.3

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [4.3.3] - 2024-03-18
+
+### Added
+
+- GitHub action to generate API reference
+- Generate API reference with Typedoc and host on GitHub Pages
+
+### Changed
+
+- Add `conformer-2` to `SpeechModel` type
+- Change `language_code` field to accept any string
+- Move from JSDoc to TSDoc
+- Update `ws` to 8.13.0
+- Update dev dependencies (no public facing changes)
+
 ## [4.3.2] - 2024-03-08
 
 ### Added

package/README.md

@@ -19,6 +19,7 @@ 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
 
@@ -240,9 +241,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: 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("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("error", (error: Error) => console.error('Error', error));
 ```
 

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
@@ -987,7 +987,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 +1127,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,9 +1157,9 @@ export type SeverityScoreSummary = {
 /**
  * The speech model to use for the transcription.
  */
-export type SpeechModel = "nano";
+export type SpeechModel = "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_type" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
  */
 export type SubstitutionPolicy = "entity_type" | "hash";
 /**
@@ -1198,7 +1198,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
@@ -2081,7 +2081,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 +2090,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 +2106,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 +2127,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 +2144,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 +2152,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 +2166,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 +2184,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 +2243,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 +2273,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 +2298,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,7 +2329,7 @@ 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
@@ -2452,7 +2452,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 +2464,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 +2484,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 +2500,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 +2521,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 +2563,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 +2644,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;
@@ -2730,7 +2730,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 +2902,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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.3.2",
+  "version": "4.3.3",
   "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"
@@ -67,8 +67,8 @@
   },
   "scripts": {
     "build": "pnpm clean && pnpm rollup -c",
-    "clean": "rimraf dist/*",
-    "lint": "eslint -c .eslintrc.json '{src,tests}/**/*.{js,ts}' && publint",
+    "clean": "rimraf dist/* && rimraf temp/* && rimraf temp-docs/*",
+    "lint": "eslint -c .eslintrc.json '{src,tests}/**/*.{js,ts}' && publint && tsc --noEmit -p tsconfig.json",
     "test": "jest --config jest.config.js",
     "format": "prettier '**/*' --write",
     "generate-types": "tsx ./scripts/generate-types.ts && pnpm format",
@@ -98,36 +98,36 @@
     "docs"
   ],
   "devDependencies": {
-    "@babel/preset-env": "^7.23.5",
+    "@babel/preset-env": "^7.24.0",
     "@babel/preset-typescript": "^7.23.3",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.5",
-    "@types/jest": "^29.5.5",
-    "@types/node": "^20.5.7",
-    "@types/websocket": "^1.0.8",
-    "@types/ws": "^8.5.5",
-    "@typescript-eslint/eslint-plugin": "^6.7.5",
-    "dotenv": "^16.3.1",
-    "eslint": "^8.48.0",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^18.11.9",
+    "@types/websocket": "^1.0.10",
+    "@types/ws": "^8.5.10",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.57.0",
     "eslint-plugin-tsdoc": "^0.2.17",
-    "jest": "^29.5.0",
-    "jest-cli": "^29.5.0",
+    "jest": "^29.7.0",
+    "jest-cli": "^29.7.0",
     "jest-fetch-mock": "^3.0.3",
     "jest-junit": "^16.0.0",
-    "jest-websocket-mock": "^2.4.1",
-    "mock-socket": "^9.2.1",
-    "npm": "^9.7.1",
-    "openapi-typescript": "^6.6.1",
-    "prettier": "^2.8.8",
-    "publint": "^0.2.5",
-    "rimraf": "^5.0.1",
-    "rollup": "^3.25.1",
-    "ts-jest": "^29.1.0",
+    "jest-websocket-mock": "^2.5.0",
+    "mock-socket": "^9.3.1",
+    "openapi-typescript": "^6.7.5",
+    "prettier": "^3.2.5",
+    "publint": "^0.2.7",
+    "rimraf": "^5.0.5",
+    "rollup": "^4.13.0",
+    "ts-jest": "^29.1.2",
     "tslib": "^2.5.3",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.2",
+    "typedoc": "^0.25.12"
   },
   "dependencies": {
-    "ws": "^8.13.0"
+    "ws": "^8.16.0"
   }
 }

package/src/polyfills/fs/index.ts

@@ -1,8 +1,8 @@
 export const readFile = async function (
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  path: string
+  path: string,
 ): Promise<ReadableStream<Uint8Array>> {
   throw new Error(
-    "Interacting with the file system is not supported in this environment."
+    "Interacting with the file system is not supported in this environment.",
   );
 };

package/src/polyfills/fs/node.ts

@@ -3,5 +3,5 @@ import { Readable } from "stream";
 
 export const readFile = async (path: string) =>
   Readable.toWeb(
-    createReadStream(path)
+    createReadStream(path),
   ) as unknown as ReadableStream<Uint8Array>;

package/src/polyfills/streams/index.ts

@@ -2,5 +2,5 @@ export const { WritableStream } =
   typeof window !== "undefined"
     ? window
     : typeof global !== "undefined"
-    ? global
-    : globalThis;
+      ? global
+      : globalThis;

package/src/services/base.ts

@@ -12,7 +12,7 @@ export abstract class BaseService {
   constructor(private params: BaseServiceParams) {}
   protected async fetch(
     input: string,
-    init?: RequestInit | undefined
+    init?: RequestInit | undefined,
   ): Promise<Response> {
     init = init ?? {};
     init.headers = init.headers ?? {};
@@ -45,7 +45,7 @@ export abstract class BaseService {
 
   protected async fetchJson<T>(
     input: string,
-    init?: RequestInit | undefined
+    init?: RequestInit | undefined,
   ): Promise<T> {
     const response = await this.fetch(input, init);
     return response.json() as Promise<T>;

package/src/services/lemur/index.ts

@@ -20,26 +20,26 @@ export class LemurService extends BaseService {
   }
 
   questionAnswer(
-    params: LemurQuestionAnswerParams
+    params: LemurQuestionAnswerParams,
   ): Promise<LemurQuestionAnswerResponse> {
     return this.fetchJson<LemurQuestionAnswerResponse>(
       "/lemur/v3/generate/question-answer",
       {
         method: "POST",
         body: JSON.stringify(params),
-      }
+      },
     );
   }
 
   actionItems(
-    params: LemurActionItemsParams
+    params: LemurActionItemsParams,
   ): Promise<LemurActionItemsResponse> {
     return this.fetchJson<LemurActionItemsResponse>(
       "/lemur/v3/generate/action-items",
       {
         method: "POST",
         body: JSON.stringify(params),
-      }
+      },
     );
   }
 

package/src/services/realtime/factory.ts

@@ -38,7 +38,7 @@ export class RealtimeTranscriberFactory extends BaseService {
       {
         method: "POST",
         body: JSON.stringify(params),
-      }
+      },
     );
     return data.token;
   }

package/src/services/realtime/service.ts

@@ -93,15 +93,15 @@ export class RealtimeTranscriber {
   on(event: "open", listener: (event: SessionBeginsEventData) => void): void;
   on(
     event: "transcript",
-    listener: (transcript: RealtimeTranscript) => void
+    listener: (transcript: RealtimeTranscript) => void,
   ): void;
   on(
     event: "transcript.partial",
-    listener: (transcript: PartialTranscript) => void
+    listener: (transcript: PartialTranscript) => void,
   ): void;
   on(
     event: "transcript.final",
-    listener: (transcript: FinalTranscript) => void
+    listener: (transcript: FinalTranscript) => void,
   ): void;
   on(event: "error", listener: (error: Error) => void): void;
   on(event: "close", listener: (code: number, reason: string) => void): void;
@@ -135,7 +135,7 @@ export class RealtimeTranscriber {
           return;
         }
         this.configureEndUtteranceSilenceThreshold(
-          this.endUtteranceSilenceThreshold
+          this.endUtteranceSilenceThreshold,
         );
       };
 

package/src/services/transcripts/index.ts

@@ -20,7 +20,10 @@ import { FileService } from "../files";
 import { getPath } from "../../utils/path";
 
 export class TranscriptService extends BaseService {
-  constructor(params: BaseServiceParams, private files: FileService) {
+  constructor(
+    params: BaseServiceParams,
+    private files: FileService,
+  ) {
     super(params);
   }
 
@@ -32,7 +35,7 @@ export class TranscriptService extends BaseService {
    */
   async transcribe(
     params: TranscribeParams,
-    options?: TranscribeOptions
+    options?: TranscribeOptions,
   ): Promise<Transcript> {
     const transcript = await this.submit(params);
     return await this.waitUntilReady(transcript.id, options);
@@ -82,7 +85,7 @@ export class TranscriptService extends BaseService {
    */
   async create(
     params: TranscriptParams,
-    options?: CreateTranscriptOptions
+    options?: CreateTranscriptOptions,
   ): Promise<Transcript> {
     const path = getPath(params.audio_url);
     if (path !== null) {
@@ -110,7 +113,7 @@ export class TranscriptService extends BaseService {
    */
   async waitUntilReady(
     transcriptId: string,
-    options?: PollingOptions
+    options?: PollingOptions,
   ): Promise<Transcript> {
     const pollingInterval = options?.pollingInterval ?? 3_000;
     const pollingTimeout = options?.pollingTimeout ?? -1;
@@ -153,7 +156,7 @@ export class TranscriptService extends BaseService {
         Object.keys(params).map((key) => [
           key,
           params[key as keyof ListTranscriptParams]?.toString() || "",
-        ])
+        ]),
       )}`;
     }
     const data = await this.fetchJson<TranscriptList>(url);
@@ -186,7 +189,7 @@ export class TranscriptService extends BaseService {
   wordSearch(id: string, words: string[]): Promise<WordSearchResponse> {
     const params = new URLSearchParams({ words: words.join(",") });
     return this.fetchJson<WordSearchResponse>(
-      `/v2/transcript/${id}/word-search?${params.toString()}`
+      `/v2/transcript/${id}/word-search?${params.toString()}`,
     );
   }
 
@@ -206,7 +209,7 @@ export class TranscriptService extends BaseService {
    */
   paragraphs(id: string): Promise<ParagraphsResponse> {
     return this.fetchJson<ParagraphsResponse>(
-      `/v2/transcript/${id}/paragraphs`
+      `/v2/transcript/${id}/paragraphs`,
     );
   }
 
@@ -220,7 +223,7 @@ export class TranscriptService extends BaseService {
   async subtitles(
     id: string,
     format: SubtitleFormat = "srt",
-    chars_per_caption?: number
+    chars_per_caption?: number,
   ): Promise<string> {
     let url = `/v2/transcript/${id}/${format}`;
     if (chars_per_caption) {
@@ -239,7 +242,7 @@ export class TranscriptService extends BaseService {
    */
   redactions(id: string): Promise<RedactedAudioResponse> {
     return this.fetchJson<RedactedAudioResponse>(
-      `/v2/transcript/${id}/redacted-audio`
+      `/v2/transcript/${id}/redacted-audio`,
     );
   }
 }

package/src/types/asyncapi.generated.ts

@@ -11,8 +11,8 @@ type XOR<T, U> = T | U extends object
 type OneOf<T extends any[]> = T extends [infer Only]
   ? Only
   : T extends [infer A, infer B, ...infer Rest]
-  ? OneOf<[XOR<A, B>, ...Rest]>
-  : never;
+    ? OneOf<[XOR<A, B>, ...Rest]>
+    : never;
 
 /* eslint-enable */
 

package/src/types/openapi.generated.ts

@@ -11,8 +11,8 @@ type XOR<T, U> = T | U extends object
 type OneOf<T extends any[]> = T extends [infer Only]
   ? Only
   : T extends [infer A, infer B, ...infer Rest]
-  ? OneOf<[XOR<A, B>, ...Rest]>
-  : never;
+    ? OneOf<[XOR<A, B>, ...Rest]>
+    : never;
 
 /* eslint-enable */
 
@@ -58,7 +58,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
@@ -380,7 +380,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
@@ -603,7 +603,7 @@ export type LemurBaseParams = {
       string,
       {
         [key: string]: unknown;
-      }
+      },
     ]
   >;
   /**
@@ -686,7 +686,7 @@ export type LemurQuestion = {
       string,
       {
         [key: string]: unknown;
-      }
+      },
     ]
   >;
   /**
@@ -1094,7 +1094,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"
  */
@@ -1237,7 +1237,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;
   /**
@@ -1269,10 +1269,10 @@ export type SeverityScoreSummary = {
 /**
  * The speech model to use for the transcription.
  */
-export type SpeechModel = "nano";
+export type SpeechModel = "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_type" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
  */
 export type SubstitutionPolicy = "entity_type" | "hash";
 
@@ -1321,7 +1321,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
@@ -2206,7 +2206,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;
   /**
@@ -2215,7 +2215,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;
   /**
@@ -2231,12 +2231,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;
   /**
@@ -2252,16 +2252,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;
   /**
@@ -2269,7 +2269,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;
   /**
@@ -2277,12 +2277,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;
   /**
@@ -2291,12 +2291,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;
   /**
@@ -2309,43 +2309,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;
   /**
@@ -2368,20 +2368,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;
   /**
@@ -2398,7 +2398,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;
   /**
@@ -2423,7 +2423,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;
 };
@@ -2457,7 +2457,7 @@ export type TranscriptCustomSpelling = {
 };
 
 /**
- * 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
@@ -2603,7 +2603,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;
   /**
@@ -2615,7 +2615,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;
   /**
@@ -2635,11 +2635,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;
   /**
@@ -2651,16 +2651,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;
   /**
@@ -2672,32 +2672,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;
@@ -2714,7 +2714,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;
   /**
@@ -2796,7 +2796,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;
@@ -2886,7 +2886,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;
@@ -3061,7 +3061,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;