assemblyai 4.3.1 → 4.3.2

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

@@ -6,12 +6,13 @@ type Without<T, U> = {
 type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
 type OneOf<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? OneOf<[XOR<A, B>, ...Rest]> : never;
 /**
- * @description Either success, or unavailable in the rare case that the model failed
- * @enum {string}
+ * Either success, or unavailable in the rare case that the model failed
  */
 export type AudioIntelligenceModelStatus = "success" | "unavailable";
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "count": 1,
  *   "rank": 0.08,
  *   "text": "air quality alerts",
@@ -22,25 +23,33 @@ export type AudioIntelligenceModelStatus = "success" | "unavailable";
  *     }
  *   ]
  * }
+ * ```
  */
 export type AutoHighlightResult = {
-    /** @description The total number of times the key phrase appears in the audio file */
+    /**
+     * The total number of times the key phrase appears in the audio file
+     */
     count: number;
     /**
-     * Format: float
-     * @description The total relevancy to the overall audio file of this key phrase - a greater number means more relevant
+     * The total relevancy to the overall audio file of this key phrase - a greater number means more relevant
      */
     rank: number;
-    /** @description The text itself of the key phrase */
+    /**
+     * The text itself of the key phrase
+     */
     text: string;
-    /** @description The timestamp of the of the key phrase */
+    /**
+     * The timestamp of the of the key phrase
+     */
     timestamps: Timestamp[];
 };
 /**
- * @description An array of results for the Key Phrases model, if it is enabled.
+ * 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.
  *
- * @example {
+ * @example
+ * ```js
+ * {
  *   "status": "success",
  *   "results": [
  *     {
@@ -242,56 +251,77 @@ export type AutoHighlightResult = {
  *     }
  *   ]
  * }
+ * ```
  */
 export type AutoHighlightsResult = {
-    /** @description A temporally-sequential array of Key Phrases */
+    /**
+     * A temporally-sequential array of Key Phrases
+     */
     results: AutoHighlightResult[];
 };
 /**
- * @description Chapter of the audio file
- * @example {
+ * Chapter of the audio file
+ * @example
+ * ```js
+ * {
  *   "summary": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. In some places, the air quality warnings include the warning to stay inside.",
  *   "gist": "Smoggy air quality alerts across US",
  *   "headline": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts across US",
  *   "start": 250,
  *   "end": 28840
  * }
+ * ```
  */
 export type Chapter = {
-    /** @description The starting time, in milliseconds, for the chapter */
+    /**
+     * The starting time, in milliseconds, for the chapter
+     */
     end: number;
-    /** @description An ultra-short summary (just a few words) of the content spoken in the chapter */
+    /**
+     * An ultra-short summary (just a few words) of the content spoken in the chapter
+     */
     gist: string;
-    /** @description A single sentence summary of the content spoken during the chapter */
+    /**
+     * A single sentence summary of the content spoken during the chapter
+     */
     headline: string;
-    /** @description The starting time, in milliseconds, for the chapter */
+    /**
+     * The starting time, in milliseconds, for the chapter
+     */
     start: number;
-    /** @description A one paragraph summary of the content spoken during the chapter */
+    /**
+     * A one paragraph summary of the content spoken during the chapter
+     */
     summary: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "label": "disasters",
  *   "confidence": 0.8142836093902588,
  *   "severity": 0.4093044400215149
  * }
+ * ```
  */
 export type ContentSafetyLabel = {
     /**
-     * Format: double
-     * @description The confidence score for the topic being discussed, from 0 to 1
+     * The confidence score for the topic being discussed, from 0 to 1
      */
     confidence: number;
-    /** @description The label of the sensitive topic */
+    /**
+     * The label of the sensitive topic
+     */
     label: string;
     /**
-     * Format: double
-     * @description How severely the topic is discussed in the section, from 0 to 1
+     * How severely the topic is discussed in the section, from 0 to 1
      */
     severity: number;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning.",
  *   "labels": [
  *     {
@@ -307,24 +337,37 @@ export type ContentSafetyLabel = {
  *     "end": 28840
  *   }
  * }
+ * ```
  */
 export type ContentSafetyLabelResult = {
-    /** @description An array of safety labels, one per sensitive topic that was detected in the section */
+    /**
+     * An array of safety labels, one per sensitive topic that was detected in the section
+     */
     labels: ContentSafetyLabel[];
-    /** @description The sentence index at which the section ends */
+    /**
+     * The sentence index at which the section ends
+     */
     sentences_idx_end: number;
-    /** @description The sentence index at which the section begins */
+    /**
+     * The sentence index at which the section begins
+     */
     sentences_idx_start: number;
-    /** @description The transcript of the section flagged by the Content Moderation model */
+    /**
+     * The transcript of the section flagged by the Content Moderation model
+     */
     text: string;
-    /** @description Timestamp information for the section */
+    /**
+     * Timestamp information for the section
+     */
     timestamp: Timestamp;
 };
 /**
- * @description An array of results for the Content Moderation model, if it is enabled.
+ * 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.
  *
- * @example {
+ * @example
+ * ```js
+ * {
  *   "status": "success",
  *   "results": [
  *     {
@@ -361,66 +404,94 @@ export type ContentSafetyLabelResult = {
  *     }
  *   }
  * }
+ * ```
  */
 export type ContentSafetyLabelsResult = {
     results: ContentSafetyLabelResult[];
-    /** @description A summary of the Content Moderation severity results for the entire audio file */
+    /**
+     * A summary of the Content Moderation severity results for the entire audio file
+     */
     severity_score_summary: {
         [key: string]: SeverityScoreSummary;
     };
-    /** @description The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed. */
+    /**
+     * The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed.
+     */
     status: AudioIntelligenceModelStatus;
-    /** @description A summary of the Content Moderation confidence results for the entire audio file */
+    /**
+     * A summary of the Content Moderation confidence results for the entire audio file
+     */
     summary: {
         [key: string]: number;
     };
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "expires_in": 480
  * }
+ * ```
  */
 export type CreateRealtimeTemporaryTokenParams = {
-    /** @description The amount of time until the token expires in seconds */
+    /**
+     * The amount of time until the token expires in seconds
+     */
     expires_in: number;
 };
 /**
- * @description A detected entity
- * @example {
+ * A detected entity
+ * @example
+ * ```js
+ * {
  *   "entity_type": "location",
  *   "text": "Canada",
  *   "start": 2548,
  *   "end": 3130
  * }
+ * ```
  */
 export type Entity = {
-    /** @description The ending time, in milliseconds, for the detected entity in the audio file */
+    /**
+     * The ending time, in milliseconds, for the detected entity in the audio file
+     */
     end: number;
-    /** @description The type of entity for the detected entity */
+    /**
+     * The type of entity for the detected entity
+     */
     entity_type: EntityType;
-    /** @description The starting time, in milliseconds, at which the detected entity appears in the audio file */
+    /**
+     * The starting time, in milliseconds, at which the detected entity appears in the audio file
+     */
     start: number;
-    /** @description The text for the detected entity */
+    /**
+     * The text for the detected entity
+     */
     text: string;
 };
 /**
- * @description The type of entity for the detected entity
- * @enum {string}
+ * The type of entity for the detected entity
  */
 export type EntityType = "banking_information" | "blood_type" | "credit_card_cvv" | "credit_card_expiration" | "credit_card_number" | "date" | "date_of_birth" | "drivers_license" | "drug" | "email_address" | "event" | "injury" | "language" | "location" | "medical_condition" | "medical_process" | "money_amount" | "nationality" | "occupation" | "organization" | "password" | "person_age" | "person_name" | "phone_number" | "political_affiliation" | "religion" | "time" | "url" | "us_social_security_number";
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "error": "format_text must be a Boolean"
  * }
+ * ```
  */
 export type Error = {
-    /** @description Error message */
+    /**
+     * Error message
+     */
     error: string;
-    /** @constant */
     status?: "error";
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "transcript_ids": [
  *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
  *   ],
@@ -430,28 +501,36 @@ export type Error = {
  *   "temperature": 0,
  *   "max_output_size": 3000
  * }
+ * ```
  */
 export type LemurActionItemsParams = LemurBaseParams & {
     /**
-     * @description How you want the action items to be returned. This can be any text.
+     * How you want the action items to be returned. This can be any text.
      * Defaults to "Bullet Points".
      *
-     * @default Bullet Points
+     * @defaultValue "Bullet Points
      */
     answer_format?: string;
 };
 /**
- * @example {
- *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e",
+ * @example
+ * ```js
+ * {
+ *   "request_id": "5"e1b27c2-691f-4414-8bc5-f14678442f9e",
  *   "response": "Here are some potential action items based on the transcript:\n\n- Monitor air quality levels in affected areas and issue warnings as needed.\n\n- Advise vulnerable populations like children, the elderly, and those with respiratory conditions to limit time outdoors.\n\n- Have schools cancel outdoor activities when air quality is poor.\n\n- Educate the public on health impacts of smoke inhalation and precautions to take.\n\n- Track progression of smoke plumes using weather and air quality monitoring systems.\n\n- Coordinate cross-regionally to manage smoke exposure as air masses shift.\n\n- Plan for likely increase in such events due to climate change. Expand monitoring and forecasting capabilities.\n\n- Conduct research to better understand health impacts of wildfire smoke and mitigation strategies.\n\n- Develop strategies to prevent and manage wildfires to limit air quality impacts.\n"
  * }
+ * ```
  */
 export type LemurActionItemsResponse = LemurBaseResponse & {
-    /** @description The response generated by LeMUR */
+    /**
+     * The response generated by LeMUR
+     */
     response: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "transcript_ids": [
  *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
  *   ],
@@ -460,9 +539,12 @@ export type LemurActionItemsResponse = LemurBaseResponse & {
  *   "temperature": 0,
  *   "max_output_size": 3000
  * }
+ * ```
  */
 export type LemurBaseParams = {
-    /** @description Context to provide the model. This can be a string or a free-form JSON value. */
+    /**
+     * Context to provide the model. This can be a string or a free-form JSON value.
+     */
     context?: OneOf<[
         string,
         {
@@ -470,86 +552,108 @@ export type LemurBaseParams = {
         }
     ]>;
     /**
-     * @description The model that is used for the final prompt after compression is performed.
+     * The model that is used for the final prompt after compression is performed.
      * Defaults to "default".
      *
-     * @default default
+     * @defaultValue "default
      */
     final_model?: LiteralUnion<LemurModel, string>;
     /**
-     * @description Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000.
+     * Custom formatted transcript data. Maximum size is the context limit of the selected model, which defaults to 100000".
      * Use either transcript_ids or input_text as input into LeMUR.
      */
     input_text?: string;
-    /** @description Max output size in tokens, up to 4000 */
+    /**
+     * Max output size in tokens, up to 4000
+     */
     max_output_size?: number;
     /**
-     * Format: float
-     * @description The temperature to use for the model.
+     * The temperature to use for the model.
      * Higher values result in answers that are more creative, lower values are more conservative.
      * Can be any value between 0.0 and 1.0 inclusive.
      */
     temperature?: number;
     /**
-     * @description A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.
+     * A list of completed transcripts with text. Up to a maximum of 100 files or 100 hours, whichever is lower.
      * Use either transcript_ids or input_text as input into LeMUR.
      */
     transcript_ids?: string[];
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e"
  * }
+ * ```
  */
 export type LemurBaseResponse = {
     /**
-     * Format: uuid
-     * @description The ID of the LeMUR request
+     * The ID of the LeMUR request
      */
     request_id: string;
 };
 /**
- * @description The model that is used for the final prompt after compression is performed.
+ * The model that is used for the final prompt after compression is performed.
  *
- * @enum {string}
  */
 export type LemurModel = "default" | "basic" | "assemblyai/mistral-7b" | "anthropic/claude-2-1";
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "question": "Where are there wildfires?",
  *   "answer_format": "List of countries in ISO 3166-1 alpha-2 format"
  * }
+ * ```
  */
 export type LemurQuestion = {
-    /** @description How you want the answer to be returned. This can be any text. Can't be used with answer_options. Examples: "short sentence", "bullet points" */
+    /**
+     * How you want the answer to be returned. This can be any text. Can't be used with answer_options. Examples: "short sentence", "bullet points"
+     */
     answer_format?: string;
-    /** @description What discrete options to return. Useful for precise responses. Can't be used with answer_format. Example: ["Yes", "No"] */
+    /**
+     * What discrete options to return. Useful for precise responses. Can't be used with answer_format. Example: ["Yes", "No"]
+     */
     answer_options?: string[];
-    /** @description Any context about the transcripts you wish to provide. This can be a string or any object. */
+    /**
+     * Any context about the transcripts you wish to provide. This can be a string or any object.
+     */
     context?: OneOf<[
         string,
         {
             [key: string]: unknown;
         }
     ]>;
-    /** @description The question you wish to ask. For more complex questions use default model. */
+    /**
+     * The question you wish to ask. For more complex questions use default model.
+     */
     question: string;
 };
 /**
- * @description An answer generated by LeMUR and its question
- * @example {
+ * An answer generated by LeMUR and its question
+ * @example
+ * ```js
+ * {
  *   "answer": "CA, US",
  *   "question": "Where are there wildfires?"
  * }
+ * ```
  */
 export type LemurQuestionAnswer = {
-    /** @description The answer generated by LeMUR */
+    /**
+     * The answer generated by LeMUR
+     */
     answer: string;
-    /** @description The question for LeMUR to answer */
+    /**
+     * The question for LeMUR to answer
+     */
     question: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "transcript_ids": [
  *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
  *   ],
@@ -575,13 +679,18 @@ export type LemurQuestionAnswer = {
  *   "temperature": 0,
  *   "max_output_size": 3000
  * }
+ * ```
  */
 export type LemurQuestionAnswerParams = LemurBaseParams & {
-    /** @description A list of questions to ask */
+    /**
+     * A list of questions to ask
+     */
     questions: LemurQuestion[];
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e",
  *   "response": [
  *     {
@@ -594,13 +703,18 @@ export type LemurQuestionAnswerParams = LemurBaseParams & {
  *     }
  *   ]
  * }
+ * ```
  */
 export type LemurQuestionAnswerResponse = LemurBaseResponse & {
-    /** @description The answers generated by LeMUR and their questions */
+    /**
+     * The answers generated by LeMUR and their questions
+     */
     response: LemurQuestionAnswer[];
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "transcript_ids": [
  *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
  *   ],
@@ -609,23 +723,33 @@ export type LemurQuestionAnswerResponse = LemurBaseResponse & {
  *   "temperature": 0,
  *   "max_output_size": 3000
  * }
+ * ```
  */
 export type LemurSummaryParams = LemurBaseParams & {
-    /** @description How you want the summary to be returned. This can be any text. Examples: "TLDR", "bullet points" */
+    /**
+     * How you want the summary to be returned. This can be any text. Examples: "TLDR", "bullet points"
+     */
     answer_format?: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e",
  *   "response": "- Wildfires in Canada are sending smoke and air pollution across parts of the US, triggering air quality alerts from Maine to Minnesota. Concentrations of particulate matter have exceeded safety levels.\n\n- Weather systems are channeling the smoke through Pennsylvania into the Mid-Atlantic and Northeast regions. New York City has canceled outdoor activities to keep children and vulnerable groups indoors.\n\n- Very small particulate matter can enter the lungs and impact respiratory, cardiovascular and neurological health. Young children, the elderly and those with preexisting conditions are most at risk.\n\n- The conditions causing the poor air quality could get worse or shift to different areas in coming days depending on weather patterns. More wildfires may also contribute to higher concentrations.\n\n- Climate change is leading to longer and more severe fire seasons. Events of smoke traveling long distances and affecting air quality over wide areas will likely become more common in the future.\"\n"
  * }
+ * ```
  */
 export type LemurSummaryResponse = LemurBaseResponse & {
-    /** @description The response generated by LeMUR */
+    /**
+     * The response generated by LeMUR
+     */
     response: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "transcript_ids": [
  *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
  *   ],
@@ -635,23 +759,33 @@ export type LemurSummaryResponse = LemurBaseResponse & {
  *   "temperature": 0,
  *   "max_output_size": 3000
  * }
+ * ```
  */
 export type LemurTaskParams = LemurBaseParams & {
-    /** @description Your text to prompt the model to produce a desired output, including any context you want to pass into the model. */
+    /**
+     * Your text to prompt the model to produce a desired output, including any context you want to pass into the model.
+     */
     prompt: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e",
  *   "response": "Based on the transcript, the following locations were mentioned as being affected by wildfire smoke from Canada:\n\n- Maine\n- Maryland\n- Minnesota\n- Mid Atlantic region\n- Northeast region\n- New York City\n- Baltimore\n"
  * }
+ * ```
  */
 export type LemurTaskResponse = LemurBaseResponse & {
-    /** @description The response generated by LeMUR. */
+    /**
+     * The response generated by LeMUR.
+     */
     response: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "after_id": "a7c5cafd-2c2e-4bdd-b0b2-69dade2f7a1b",
  *   "before_id": "9ea68fd3-f953-42c1-9742-976c447fb463",
  *   "created_on": "2023-11-03",
@@ -659,42 +793,46 @@ export type LemurTaskResponse = LemurBaseResponse & {
  *   "status": "completed",
  *   "throttled_only": false
  * }
+ * ```
  */
 export type ListTranscriptParams = {
     /**
-     * Format: uuid
-     * @description Get transcripts that were created after this transcript ID
+     * Get transcripts that were created after this transcript ID
      */
     after_id?: string;
     /**
-     * Format: uuid
-     * @description Get transcripts that were created before this transcript ID
+     * Get transcripts that were created before this transcript ID
      */
     before_id?: string;
     /**
-     * Format: date
-     * @description Only get transcripts created on this date
+     * Only get transcripts created on this date
      */
     created_on?: string;
     /**
-     * Format: int64
-     * @description Maximum amount of transcripts to retrieve
-     * @default 10
+     * Maximum amount of transcripts to retrieve
+     * @defaultValue 10
      */
     limit?: number;
-    /** @description Filter by transcript status */
+    /**
+     * Filter by transcript status
+     */
     status?: TranscriptStatus;
-    /** @description Only get throttled transcripts, overrides the status filter */
+    /**
+     * Only get throttled transcripts, overrides the status filter
+     */
     throttled_only?: boolean;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "limit": 10,
  *   "result_count": 10,
  *   "current_url": "https://api.assemblyai.com/v2/transcript?limit=10",
  *   "prev_url": "https://api.assemblyai.com/v2/transcript?limit=10&before_id=62npeahu2b-a8ea-4112-854c-69542c20d90c",
  *   "next_url": "https://api.assemblyai.com/v2/transcript?limit=10&after_id=62nfw3mlar-01ad-4631-92f6-629929496eed"
  * }
+ * ```
  */
 export type PageDetails = {
     current_url: string;
@@ -704,7 +842,9 @@ export type PageDetails = {
     result_count: number;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "paragraphs": [
  *     {
  *       "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter Decarlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University. Good morning, professor.",
@@ -776,73 +916,86 @@ export type PageDetails = {
  *   "confidence": 0.9578730257009361,
  *   "audio_duration": 281
  * }
+ * ```
  */
 export type ParagraphsResponse = {
     audio_duration: number;
-    /** Format: double */
     confidence: number;
-    /** Format: uuid */
     id: string;
     paragraphs: TranscriptParagraph[];
 };
-/** @enum {string} */
 export type PiiPolicy = "medical_process" | "medical_condition" | "blood_type" | "drug" | "injury" | "number_sequence" | "email_address" | "date_of_birth" | "phone_number" | "us_social_security_number" | "credit_card_number" | "credit_card_expiration" | "credit_card_cvv" | "date" | "nationality" | "event" | "language" | "location" | "money_amount" | "person_name" | "person_age" | "organization" | "political_affiliation" | "occupation" | "religion" | "drivers_license" | "banking_information";
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "request_id": "914fe7e4-f10a-4364-8946-34614c2873f6",
  *   "request_id_to_purge": "b7eb03ec-1650-4181-949b-75d9de317de1",
  *   "deleted": true
  * }
+ * ```
  */
 export type PurgeLemurRequestDataResponse = {
-    /** @description Whether the request data was deleted */
+    /**
+     * Whether the request data was deleted
+     */
     deleted: boolean;
     /**
-     * Format: uuid
-     * @description The ID of the deletion request of the LeMUR request
+     * The ID of the deletion request of the LeMUR request
      */
     request_id: string;
     /**
-     * Format: uuid
-     * @description The ID of the LeMUR request to purge the data for
+     * The ID of the LeMUR request to purge the data for
      */
     request_id_to_purge: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "token": "fe4145dd1e7a2e149488dcd2d553a8018a89833fc5084837d66fd1bcf5a105d4"
  * }
+ * ```
  */
 export type RealtimeTemporaryTokenResponse = {
-    /** @description The temporary authentication token for real-time transcription */
+    /**
+     * The temporary authentication token for real-time transcription
+     */
     token: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "redacted_audio_url": "https://s3.us-west-2.amazonaws.com/api.assembly.ai.usw2/redacted-audio/785efd9e-0e20-45e1-967b-3db17770ed9f.wav?AWSAccessKeyId=ASIAVASQFLPGLUP5JD7Y&Signature=z1r2MOA46esiiAmk%2FreBkL8rl6g%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEPv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJHMEUCIHxKoUJdd5P%2Fdy4WlfvRNppQtauTy7OuAb5azR2OIoYSAiEA8iPx4xAx0pbZztT4e7fGnzPS4phvNCnYKflIijUoxDsq%2BwMIMxAEGgwzNDQ4MzkyNDg4NDQiDJxsCgo0cDg789FV0CrYAwPK3CHbRHoNPFiQ%2FO6EdHZ4OSFRcS%2FDvDyHQRNnYNSwG4JB2mUMWEVw808JWTya%2But4wEcmPiUCVJMTvh70cxhILAxP84CBTuWGM%2Fszbj4tn1thjVsqovf9YZmP17OCFa77Bc9%2F9RwtRaABEqJ2eb6%2Bsir7w0MMzhe1z%2F%2B1PUKxicJAZasBv3Ova%2BTY2eNkPZHQ4Njie4X5sh05b%2BrKnz58E7GTQ1sHZQDYHZecwb5fP0B3LR0vuqNtK%2BdpMAxw5H7BinQ4rdccLmsLLMQeVn8jdRDZNEvsdmoeQL0y0qD%2BUcyGMJoAjMT4FnXhBhVxc3bgkVUbHlZMn48FNCYcmzM8UB9wGmSnr6iQoqEaFElfQVbvAzsW7lnlfLROZxMvGXyliobPYPSaYZlVYgHcIxeWuOAXRtEtmL2jbaX4ghCVgJBVO3BBzTgub2jB0KPU6lYZLLM4kf%2B8hKX8iyxSRc6ZVEefTcyruoDppjB028pA9q75hLH1CZwhfLoM%2F3z5f0aFCl05zQnaa10nbcKj0hERELf4FXqS8yWbSutlRcd7Rr9o8jN31QGUscpsuIvl%2FpyJcZmItX8nO%2FF0s1QjrIi11DLYD9YoOh7eVkN8eKKn5w4cHldVI2sw4NCPqgY6pQE%2BM9va2ad1%2BNrXeQ9t8K41lojTN0BFmM8ERD5fF77xcTlW8VdV%2FiJeLLHDvnYYWVKcga9hSROlmsqvMyn3Tmhz7KQbIepSAOKhcHM%2FyUaLfErvCtjXGwo8nsKForL7SKiGkaRCBmwfQtkSVP6m4tGT50YdGxakh54f8uyC55SbkElknRbpl5haiZ%2F82UddFBkdPcM3t0s7vwbEy%2BbilYyetOr6htc%3D&Expires=1698966551",
  *   "status": "redacted_audio_ready"
  * }
+ * ```
  */
 export type RedactedAudioResponse = {
-    /** @description The URL of the redacted audio file */
+    /**
+     * The URL of the redacted audio file
+     */
     redacted_audio_url: string;
-    /** @description The status of the redacted audio */
+    /**
+     * The status of the redacted audio
+     */
     status: RedactedAudioStatus;
 };
 /**
- * @description The status of the redacted audio
- * @enum {string}
+ * The status of the redacted audio
  */
 export type RedactedAudioStatus = "redacted_audio_ready";
 /**
- * @description 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.
- * @default mp3
- * @example mp3
- * @enum {string}
+ * 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.
+ * @defaultValue "mp3"
+ * @example "mp3"
  */
 export type RedactPiiAudioQuality = "mp3" | "wav";
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "sentences": [
  *     {
  *       "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US.",
@@ -937,20 +1090,20 @@ export type RedactPiiAudioQuality = "mp3" | "wav";
  *   "confidence": 0.9579390654205628,
  *   "audio_duration": 281
  * }
+ * ```
  */
 export type SentencesResponse = {
     audio_duration: number;
-    /** Format: double */
     confidence: number;
-    /** Format: uuid */
     id: string;
     sentences: TranscriptSentence[];
 };
-/** @enum {unknown} */
 export type Sentiment = "POSITIVE" | "NEUTRAL" | "NEGATIVE";
 /**
- * @description The result of the sentiment analysis model
- * @example {
+ * The result of the sentiment analysis model
+ * @example
+ * ```js
+ * {
  *   "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US.",
  *   "start": 250,
  *   "end": 6350,
@@ -958,84 +1111,98 @@ export type Sentiment = "POSITIVE" | "NEUTRAL" | "NEGATIVE";
  *   "confidence": 0.8181032538414001,
  *   "speaker": null
  * }
+ * ```
  */
 export type SentimentAnalysisResult = {
     /**
-     * Format: double
-     * @description The confidence score for the detected sentiment of the sentence, from 0 to 1
+     * The confidence score for the detected sentiment of the sentence, from 0 to 1
      */
     confidence: number;
-    /** @description The ending time, in milliseconds, of the sentence */
+    /**
+     * The ending time, in milliseconds, of the sentence
+     */
     end: number;
-    /** @description The detected sentiment for the sentence, one of POSITIVE, NEUTRAL, NEGATIVE */
+    /**
+     * The detected sentiment for the sentence, one of POSITIVE, NEUTRAL, NEGATIVE
+     */
     sentiment: Sentiment;
-    /** @description 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 [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+     */
     speaker?: string | null;
-    /** @description The starting time, in milliseconds, of the sentence */
+    /**
+     * The starting time, in milliseconds, of the sentence
+     */
     start: number;
-    /** @description The transcript of the sentence */
+    /**
+     * The transcript of the sentence
+     */
     text: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "low": 0.5733263024656846,
  *   "medium": 0.42667369753431533,
  *   "high": 0
  * }
+ * ```
  */
 export type SeverityScoreSummary = {
-    /** Format: double */
     high: number;
-    /** Format: double */
     low: number;
-    /** Format: double */
     medium: number;
 };
 /**
- * @description The speech model to use for the transcription.
- * @enum {string}
+ * The speech model to use for the transcription.
  */
 export type SpeechModel = "nano";
 /**
- * @description 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.
- * @enum {string}
+ * 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.
  */
 export type SubstitutionPolicy = "entity_type" | "hash";
 /**
- * @description Format of the subtitles
- * @enum {string}
+ * Format of the subtitles
  */
 export type SubtitleFormat = "srt" | "vtt";
 /**
- * @description The model to summarize the transcript
- * @default informative
- * @enum {string}
+ * The model to summarize the transcript
+ * @defaultValue "informative
  */
 export type SummaryModel = "informative" | "conversational" | "catchy";
 /**
- * @description The type of summary
- * @default bullets
- * @enum {string}
+ * The type of summary
+ * @defaultValue bullets
  */
 export type SummaryType = "bullets" | "bullets_verbose" | "gist" | "headline" | "paragraph";
 /**
- * @description Timestamp containing a start and end property in milliseconds
- * @example {
- *   "start": 3978,
+ * Timestamp containing a start and end property in milliseconds
+ * @example
+ * ```js
+ * {
+ *   "start": 3978",
  *   "end": 5114
  * }
+ * ```
  */
 export type Timestamp = {
-    /** @description The end time in milliseconds */
+    /**
+     * The end time in milliseconds
+     */
     end: number;
-    /** @description The start time in milliseconds */
+    /**
+     * The start time in milliseconds
+     */
     start: number;
 };
 /**
- * @description The result of the Topic Detection model, if it is enabled.
+ * 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.
  *
- * @example {
+ * @example
+ * ```js
+ * {
  *   "status": "success",
  *   "results": [
  *     {
@@ -1111,20 +1278,29 @@ export type Timestamp = {
  *     "MedicalHealth>DiseasesAndConditions>Injuries>FirstAid": 0.0004885646631009877
  *   }
  * }
+ * ```
  */
 export type TopicDetectionModelResult = {
-    /** @description An array of results for the Topic Detection model */
+    /**
+     * An array of results for the Topic Detection model
+     */
     results: TopicDetectionResult[];
-    /** @description The status of the Topic Detection model. Either success, or unavailable in the rare case that the model failed. */
+    /**
+     * The status of the Topic Detection model. Either success, or unavailable in the rare case that the model failed.
+     */
     status: AudioIntelligenceModelStatus;
-    /** @description The overall relevance of topic to the entire audio file */
+    /**
+     * The overall relevance of topic to the entire audio file
+     */
     summary: {
         [key: string]: number;
     };
 };
 /**
- * @description The result of the topic detection model
- * @example {
+ * The result of the topic detection model
+ * @example
+ * ```js
+ * {
  *   "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter de Carlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University Varsity. Good morning, professor. Good morning.",
  *   "labels": [
  *     {
@@ -1173,24 +1349,30 @@ export type TopicDetectionModelResult = {
  *     "end": 28840
  *   }
  * }
+ * ```
  */
 export type TopicDetectionResult = {
     labels?: {
-        /** @description The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship */
+        /**
+         * The IAB taxonomical label for the label of the detected topic, where &gt; denotes supertopic/subtopic relationship
+         */
         label: string;
         /**
-         * Format: double
-         * @description How relevant the detected topic is of a detected topic
+         * How relevant the detected topic is of a detected topic
          */
         relevance: number;
     }[];
-    /** @description The text in the transcript in which a detected topic occurs */
+    /**
+     * The text in the transcript in which a detected topic occurs
+     */
     text: string;
     timestamp?: Timestamp;
 };
 /**
- * @description A transcript object
- * @example {
+ * A transcript object
+ * @example
+ * ```js
+ * {
  *   "id": "9ea68fd3-f953-42c1-9742-976c447fb463",
  *   "speech_model": null,
  *   "language_model": "assemblyai_default",
@@ -1874,215 +2056,291 @@ export type TopicDetectionResult = {
  *   "summary": "- Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. In some places, the air quality warnings include the warning to stay inside.\\n- Air pollution levels in Baltimore are considered unhealthy. Exposure to high levels can lead to a host of health problems. With climate change, we are seeing more wildfires. Will we be seeing more of these kinds of wide ranging air quality consequences?",
  *   "speakers_expected": 2
  * }
+ * ```
  */
 export type Transcript = {
     /**
      * @deprecated
-     * @description The acoustic model that was used for the transcript
+     * The acoustic model that was used for the transcript
      */
     acoustic_model: string;
     /**
-     * Format: float
-     * @description The duration of this transcript object's media file, in seconds
+     * The duration of this transcript object's media file, in seconds
      */
     audio_duration?: number | null;
-    /** @description The point in time, in milliseconds, in the file at which the transcription was terminated */
+    /**
+     * The point in time, in milliseconds, in the file at which the transcription was terminated
+     */
     audio_end_at?: number | null;
-    /** @description The point in time, in milliseconds, in the file at which the transcription was started */
+    /**
+     * The point in time, in milliseconds, in the file at which the transcription was started
+     */
     audio_start_from?: number | null;
-    /** @description The URL of the media that was transcribed */
+    /**
+     * The URL of the media that was transcribed
+     */
     audio_url: string;
-    /** @description Whether [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters) is enabled, can be true or false */
+    /**
+     * Whether [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters) is enabled, can be true or false
+     */
     auto_chapters?: boolean | null;
-    /** @description Whether Key Phrases is enabled, either true or false */
+    /**
+     * Whether Key Phrases is enabled, either true or false
+     */
     auto_highlights: boolean;
     /**
-     * @description An array of results for the Key Phrases model, if it is enabled.
+     * 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.
      */
     auto_highlights_result?: AutoHighlightsResult | null;
-    /** @description The word boost parameter value */
+    /**
+     * The word boost parameter value
+     */
     boost_param?: string | null;
-    /** @description An array of temporally sequential chapters for the audio file */
+    /**
+     * An array of temporally sequential chapters for the audio file
+     */
     chapters?: Chapter[] | null;
     /**
-     * Format: double
-     * @description The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)
+     * The confidence score for the transcript, between 0.0 (low confidence) and 1.0 (high confidence)
      */
     confidence?: number | null;
-    /** @description Whether [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation) is enabled, can be true or false */
+    /**
+     * Whether [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation) is enabled, can be true or false
+     */
     content_safety?: boolean | null;
     /**
-     * @description An array of results for the Content Moderation model, if it is enabled.
+     * 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.
      */
     content_safety_labels?: ContentSafetyLabelsResult | null;
-    /** @description Customize how words are spelled and formatted using to and from values */
+    /**
+     * Customize how words are spelled and formatted using to and from values
+     */
     custom_spelling?: TranscriptCustomSpelling[] | null;
-    /** @description Whether custom topics is enabled, either true or false */
+    /**
+     * Whether custom topics is enabled, either true or false
+     */
     custom_topics?: boolean | null;
-    /** @description Transcribe Filler Words, like "umm", in your media file; can be true or false */
+    /**
+     * Transcribe Filler Words, like "umm", in your media file; can be true or false
+     */
     disfluencies?: boolean | null;
-    /** @description 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 [Dual channel transcription](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) was enabled in the transcription request, either true or false
+     */
     dual_channel?: boolean | null;
     /**
-     * @description An array of results for the Entity Detection model, if it is enabled.
+     * 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.
      */
     entities?: Entity[] | null;
-    /** @description Whether [Entity Detection](https://www.assemblyai.com/docs/models/entity-detection) is enabled, can be true or false */
+    /**
+     * Whether [Entity Detection](https://www.assemblyai.com/docs/models/entity-detection) is enabled, can be true or false
+     */
     entity_detection?: boolean | null;
-    /** @description Error message of why the transcript failed */
+    /**
+     * Error message of why the transcript failed
+     */
     error?: string;
-    /** @description Whether [Profanity Filtering](https://www.assemblyai.com/docs/models/speech-recognition#profanity-filtering) is enabled, either true or false */
+    /**
+     * Whether [Profanity Filtering](https://www.assemblyai.com/docs/models/speech-recognition#profanity-filtering) is enabled, either true or false
+     */
     filter_profanity?: boolean | null;
-    /** @description Whether Text Formatting is enabled, either true or false */
+    /**
+     * Whether Text Formatting is enabled, either true or false
+     */
     format_text?: boolean | null;
-    /** @description Whether [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) is enabled, can be true or false */
+    /**
+     * Whether [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) is enabled, can be true or false
+     */
     iab_categories?: boolean | null;
     /**
-     * @description The result of the Topic Detection model, if it is enabled.
+     * 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.
      */
     iab_categories_result?: TopicDetectionModelResult | null;
     /**
-     * Format: uuid
-     * @description The unique identifier of your transcript
+     * The unique identifier of your transcript
      */
     id: string;
     /**
-     * @description The language of your audio file.
+     * The language of your audio file.
      * Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).
      * The default value is 'en_us'.
      */
     language_code?: TranscriptLanguageCode;
-    /** @description Whether [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) is enabled, either true or false */
+    /**
+     * Whether [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) is enabled, either true or false
+     */
     language_detection?: boolean | null;
     /**
      * @deprecated
-     * @description The language model that was used for the transcript
+     * The language model that was used for the transcript
      */
     language_model: string;
-    /** @description Whether Automatic Punctuation is enabled, either true or false */
+    /**
+     * Whether Automatic Punctuation is enabled, either true or false
+     */
     punctuate?: boolean | null;
-    /** @description Whether [PII Redaction](https://www.assemblyai.com/docs/models/pii-redaction) is enabled, either true or false */
+    /**
+     * Whether [PII Redaction](https://www.assemblyai.com/docs/models/pii-redaction) is enabled, either true or false
+     */
     redact_pii: boolean;
     /**
-     * @description Whether a redacted version of the audio file was generated,
+     * 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.
      */
     redact_pii_audio?: boolean | null;
     /**
-     * @description The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled.
+     * 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.
      */
     redact_pii_audio_quality?: RedactPiiAudioQuality | null;
     /**
-     * @description The list of PII Redaction policies that were enabled, if PII Redaction is enabled.
+     * 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.
      */
     redact_pii_policies?: PiiPolicy[] | null;
-    /** @description 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 [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+     */
     redact_pii_sub?: SubstitutionPolicy;
-    /** @description Whether [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis) is enabled, can be true or false */
+    /**
+     * Whether [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis) is enabled, can be true or false
+     */
     sentiment_analysis?: boolean | null;
     /**
-     * @description An array of results for the Sentiment Analysis model, if it is enabled.
+     * 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.
      */
     sentiment_analysis_results?: SentimentAnalysisResult[] | null;
-    /** @description Whether [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, can be true or false */
+    /**
+     * Whether [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, can be true or false
+     */
     speaker_labels?: boolean | null;
-    /** @description 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 [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details.
+     */
     speakers_expected?: number | null;
     /**
-     * @description The speech model used for the transcription. When `null`, the default model is used.
-     * @default null
+     * The speech model used for the transcription. When `null`, the default model is used.
+     * @defaultValue "null
      */
     speech_model: SpeechModel | null;
     /**
-     * Format: float
-     * @description Defaults to null. Reject audio files that contain less than this fraction of speech.
-     * Valid values are in the range [0, 1] inclusive.
+     * Defaults to null. Reject audio files that contain less than this fraction of speech.
+     * Valid values are in the range [0", 1] inclusive.
      */
     speech_threshold?: number | null;
     /**
      * @deprecated
-     * @description Whether speed boost is enabled
+     * Whether speed boost is enabled
      */
     speed_boost?: boolean | null;
-    /** @description The status of your transcript. Possible values are queued, processing, completed, or error. */
+    /**
+     * The status of your transcript. Possible values are queued, processing, completed, or error.
+     */
     status: TranscriptStatus;
-    /** @description Whether [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled, either true or false */
+    /**
+     * Whether [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled, either true or false
+     */
     summarization: boolean;
-    /** @description 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 [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled
+     */
     summary?: string | null;
     /**
-     * @description The Summarization model used to generate the summary,
+     * The Summarization model used to generate the summary,
      * if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled
      */
     summary_model?: string | null;
-    /** @description The type of summary generated, if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled */
+    /**
+     * The type of summary generated, if [Summarization](https://www.assemblyai.com/docs/models/summarization) is enabled
+     */
     summary_type?: string | null;
-    /** @description The textual transcript of your media file */
+    /**
+     * The textual transcript of your media file
+     */
     text?: string | null;
-    /** @description True while a request is throttled and false when a request is no longer throttled */
+    /**
+     * True while a request is throttled and false when a request is no longer throttled
+     */
     throttled?: boolean | null;
-    /** @description The list of custom topics provided if custom topics is enabled */
+    /**
+     * The list of custom topics provided if custom topics is enabled
+     */
     topics?: string[];
     /**
-     * @description When dual_channel or speaker_labels is enabled, a list of turn-by-turn utterance objects.
+     * 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.
      */
     utterances?: TranscriptUtterance[] | null;
-    /** @description Whether webhook authentication details were provided */
+    /**
+     * Whether webhook authentication details were provided
+     */
     webhook_auth: boolean;
-    /** @description The header name which should be sent back with webhook calls */
+    /**
+     * The header name which should be sent back with webhook calls
+     */
     webhook_auth_header_name?: string | null;
-    /** @description The status code we received from your server when delivering your webhook, if a webhook URL was provided */
+    /**
+     * The status code we received from your server when delivering your webhook, if a webhook URL was provided
+     */
     webhook_status_code?: number | null;
-    /** @description The URL to which we send webhooks upon trancription completion */
+    /**
+     * The URL to which we send webhooks upon trancription completion
+     */
     webhook_url?: string | null;
-    /** @description The list of custom vocabulary to boost transcription probability for */
+    /**
+     * The list of custom vocabulary to boost transcription probability for
+     */
     word_boost?: string[];
     /**
-     * @description An array of temporally-sequential word objects, one for each word in the transcript.
+     * 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.
      */
     words?: TranscriptWord[] | null;
 };
 /**
- * @description The word boost parameter value
- * @enum {string}
+ * The word boost parameter value
  */
 export type TranscriptBoostParam = "low" | "default" | "high";
 /**
- * @description Object containing words or phrases to replace, and the word or phrase to replace with
- * @example {
+ * Object containing words or phrases to replace, and the word or phrase to replace with
+ * @example
+ * ```js
+ * {
  *   "from": [
  *     "dicarlo"
  *   ],
  *   "to": "Decarlo"
  * }
+ * ```
  */
 export type TranscriptCustomSpelling = {
-    /** @description Words or phrases to replace */
+    /**
+     * Words or phrases to replace
+     */
     from: string[];
-    /** @description Word or phrase to replace with */
+    /**
+     * Word or phrase to replace with
+     */
     to: string;
 };
 /**
- * @description 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 [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).
  * The default value is 'en_us'.
  *
- * @default en_us
- * @enum {string}
+ * @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";
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "page_details": {
- *     "limit": 2,
+ *     "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",
@@ -2107,13 +2365,16 @@ export type TranscriptLanguageCode = "en" | "en_au" | "en_uk" | "en_us" | "es" |
  *     }
  *   ]
  * }
+ * ```
  */
 export type TranscriptList = {
     page_details: PageDetails;
     transcripts: TranscriptListItem[];
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "id": "9ea68fd3-f953-42c1-9742-976c447fb463",
  *   "resource_url": "https://api.assemblyai.com/v2/transcript/9ea68fd3-f953-42c1-9742-976c447fb463",
  *   "status": "completed",
@@ -2121,19 +2382,21 @@ export type TranscriptList = {
  *   "completed": "2023-11-02T21:49:25.586965",
  *   "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3"
  * }
+ * ```
  */
 export type TranscriptListItem = {
     audio_url: string;
     completed: Date | null;
     created: Date;
-    /** Format: uuid */
     id: string;
     resource_url: string;
     status: TranscriptStatus;
 };
 /**
- * @description The parameters for creating a transcript
- * @example {
+ * The parameters for creating a transcript
+ * @example
+ * ```js
+ * {
  *   "speech_model": null,
  *   "language_code": "en_us",
  *   "punctuate": true,
@@ -2177,115 +2440,171 @@ export type TranscriptListItem = {
  *   "custom_topics": true,
  *   "topics": []
  * }
+ * ```
  */
 export type TranscriptOptionalParams = {
-    /** @description The point in time, in milliseconds, to stop transcribing in your media file */
+    /**
+     * The point in time, in milliseconds, to stop transcribing in your media file
+     */
     audio_end_at?: number;
-    /** @description The point in time, in milliseconds, to begin transcribing in your media file */
+    /**
+     * The point in time, in milliseconds, to begin transcribing in your media file
+     */
     audio_start_from?: number;
-    /** @description Enable [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters), can be true or false */
+    /**
+     * Enable [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters), can be true or false
+     */
     auto_chapters?: boolean;
-    /** @description Whether Key Phrases is enabled, either true or false */
+    /**
+     * Whether Key Phrases is enabled, either true or false
+     */
     auto_highlights?: boolean;
-    /** @description The word boost parameter value */
+    /**
+     * The word boost parameter value
+     */
     boost_param?: TranscriptBoostParam;
-    /** @description Enable [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be true or false */
+    /**
+     * Enable [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be true or false
+     */
     content_safety?: boolean;
-    /** @description The confidence threshold for content moderation. Values must be between 25 and 100. */
+    /**
+     * The confidence threshold for content moderation. Values must be between 25 and 100.
+     */
     content_safety_confidence?: number;
-    /** @description Customize how words are spelled and formatted using to and from values */
+    /**
+     * Customize how words are spelled and formatted using to and from values
+     */
     custom_spelling?: TranscriptCustomSpelling[];
-    /** @description Whether custom topics is enabled, either true or false */
+    /**
+     * Whether custom topics is enabled, either true or false
+     */
     custom_topics?: boolean;
-    /** @description Transcribe Filler Words, like "umm", in your media file; can be true or false */
+    /**
+     * Transcribe Filler Words, like "umm", in your media file; can be true or false
+     */
     disfluencies?: boolean;
-    /** @description Enable [Dual Channel](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) transcription, can be true or false. */
+    /**
+     * Enable [Dual Channel](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) transcription, can be true or false.
+     */
     dual_channel?: boolean;
-    /** @description Enable [Entity Detection](https://www.assemblyai.com/docs/models/entity-detection), can be true or false */
+    /**
+     * Enable [Entity Detection](https://www.assemblyai.com/docs/models/entity-detection), can be true or false
+     */
     entity_detection?: boolean;
-    /** @description Filter profanity from the transcribed text, can be true or false */
+    /**
+     * Filter profanity from the transcribed text, can be true or false
+     */
     filter_profanity?: boolean;
-    /** @description Enable Text Formatting, can be true or false */
+    /**
+     * Enable Text Formatting, can be true or false
+     */
     format_text?: boolean;
-    /** @description Enable [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true or false */
+    /**
+     * Enable [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true or false
+     */
     iab_categories?: boolean;
     /**
-     * @description 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 [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages).
      * The default value is 'en_us'.
      */
     language_code?: TranscriptLanguageCode | null;
-    /** @description 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 [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) was enabled in the transcription request, either true or false.
+     */
     language_detection?: boolean;
-    /** @description Enable Automatic Punctuation, can be true or false */
+    /**
+     * Enable Automatic Punctuation, can be true or false
+     */
     punctuate?: boolean;
-    /** @description Redact PII from the transcribed text using the Redact PII model, can be true or false */
+    /**
+     * Redact PII from the transcribed text using the Redact PII model, can be true or false
+     */
     redact_pii?: boolean;
-    /** @description 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 [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+     */
     redact_pii_audio?: boolean;
     /**
-     * @description 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.
-     * @default mp3
+     * 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.
+     * @defaultValue "mp3"
      */
     redact_pii_audio_quality?: RedactPiiAudioQuality;
-    /** @description 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 [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+     */
     redact_pii_policies?: PiiPolicy[];
-    /** @description 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 [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+     */
     redact_pii_sub?: SubstitutionPolicy | null;
-    /** @description Enable [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis), can be true or false */
+    /**
+     * Enable [Sentiment Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis), can be true or false
+     */
     sentiment_analysis?: boolean;
-    /** @description Enable [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be true or false */
+    /**
+     * Enable [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be true or false
+     */
     speaker_labels?: boolean;
     /**
-     * @description 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.
-     * @default null
+     * 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.
+     * @defaultValue "null
      */
     speakers_expected?: number | null;
     /**
-     * @description The speech model to use for the transcription. When `null`, the default model is used.
-     * @default null
+     * The speech model to use for the transcription. When `null`, the default model is used.
+     * @defaultValue null
      */
     speech_model?: SpeechModel | null;
     /**
-     * Format: float
-     * @description Reject audio files that contain less than this fraction of speech.
-     * Valid values are in the range [0, 1] inclusive.
+     * Reject audio files that contain less than this fraction of speech.
+     * Valid values are in the range [0", 1] inclusive.
      *
-     * @default null
+     * @defaultValue "null
      */
     speech_threshold?: number | null;
-    /** @description Enable [Summarization](https://www.assemblyai.com/docs/models/summarization), can be true or false */
+    /**
+     * Enable [Summarization](https://www.assemblyai.com/docs/models/summarization), can be true or false
+     */
     summarization?: boolean;
     /**
-     * @description The model to summarize the transcript
-     * @default informative
+     * The model to summarize the transcript
+     * @defaultValue informative
      */
     summary_model?: SummaryModel;
     /**
-     * @description The type of summary
-     * @default bullets
+     * The type of summary
+     * @defaultValue bullets
      */
     summary_type?: SummaryType;
-    /** @description The list of custom topics provided, if custom topics is enabled */
+    /**
+     * The list of custom topics provided, if custom topics is enabled
+     */
     topics?: string[];
     /**
-     * @description The header name which should be sent back with webhook calls
-     * @default null
+     * The header name which should be sent back with webhook calls
+     * @defaultValue null
      */
     webhook_auth_header_name?: string | null;
     /**
-     * @description Specify a header name and value to send back with a webhook call for added security
-     * @default null
+     * Specify a header name and value to send back with a webhook call for added security
+     * @defaultValue null
      */
     webhook_auth_header_value?: string | null;
-    /** @description The URL to which AssemblyAI send webhooks upon trancription completion */
+    /**
+     * The URL to which AssemblyAI send webhooks upon trancription completion
+     */
     webhook_url?: string;
-    /** @description The list of custom vocabulary to boost transcription probability for */
+    /**
+     * The list of custom vocabulary to boost transcription probability for
+     */
     word_boost?: string[];
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US. Skylines from Maine to Maryland to Minnesota are gray and smoggy. And in some places, the air quality warnings include the warning to stay inside. We wanted to better understand what's happening here and why, so we called Peter Decarlo, an associate professor in the Department of Environmental Health and Engineering at Johns Hopkins University. Good morning, professor.",
- *   "start": 250,
+ *   "start": 250",
  *   "end": 26950,
  *   "confidence": 0.73033,
  *   "words": [
@@ -2319,24 +2638,56 @@ export type TranscriptOptionalParams = {
  *     }
  *   ]
  * }
+ * ```
  */
 export type TranscriptParagraph = {
-    /** Format: double */
     confidence: number;
     end: number;
-    /** @description 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 [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+     */
     speaker?: string | null;
     start: number;
     text: string;
     words: TranscriptWord[];
 };
-/** @description The parameters for creating a transcript */
+/**
+ * The parameters for creating a transcript
+ */
 export type TranscriptParams = TranscriptOptionalParams & {
-    /** @description The URL of the audio or video file to transcribe. */
+    /**
+     * The URL of the audio or video file to transcribe.
+     */
     audio_url: string;
 };
 /**
- * @example {
+ * The notification when the transcript status is completed or error.
+ * @example
+ * ```js
+ * {
+ *   "transcript_id": "9ea68fd3-f953-42c1-9742-976c447fb463",
+ *   "status": "completed"
+ * }
+ * ```
+ */
+export type TranscriptReadyNotification = {
+    /**
+     * The status of the transcript. Either completed or error.
+     */
+    status: TranscriptReadyStatus;
+    /**
+     * The ID of the transcript
+     */
+    transcript_id: string;
+};
+/**
+ * The status of the transcript. Either completed or error.
+ */
+export type TranscriptReadyStatus = "completed" | "error";
+/**
+ * @example
+ * ```js
+ * {
  *   "text": "Smoke from hundreds of wildfires in Canada is triggering air quality alerts throughout the US.",
  *   "start": 250,
  *   "end": 6350,
@@ -2373,24 +2724,27 @@ export type TranscriptParams = TranscriptOptionalParams & {
  *   ],
  *   "speaker": null
  * }
+ * ```
  */
 export type TranscriptSentence = {
-    /** Format: double */
     confidence: number;
     end: number;
-    /** @description 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 [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+     */
     speaker?: string | null;
     start: number;
     text: string;
     words: TranscriptWord[];
 };
 /**
- * @description The status of your transcript. Possible values are queued, processing, completed, or error.
- * @enum {string}
+ * The status of your transcript. Possible values are queued, processing, completed, or error.
  */
 export type TranscriptStatus = "queued" | "processing" | "completed" | "error";
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "confidence": 0.9359033333333334,
  *   "end": 26950,
  *   "speaker": "A",
@@ -2504,53 +2858,74 @@ export type TranscriptStatus = "queued" | "processing" | "completed" | "error";
  *     }
  *   ]
  * }
+ * ```
  */
 export type TranscriptUtterance = {
     /**
-     * Format: double
-     * @description The confidence score for the transcript of this utterance
+     * The confidence score for the transcript of this utterance
      */
     confidence: number;
-    /** @description The ending time, in milliseconds, of the utterance in the audio file */
+    /**
+     * The ending time, in milliseconds, of the utterance in the audio file
+     */
     end: number;
-    /** @description The speaker of this utterance, where each speaker is assigned a sequential capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc. */
+    /**
+     * The speaker of this utterance, where each speaker is assigned a sequential capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.
+     */
     speaker: string;
-    /** @description The starting time, in milliseconds, of the utterance in the audio file */
+    /**
+     * The starting time, in milliseconds, of the utterance in the audio file
+     */
     start: number;
-    /** @description The text for this utterance */
+    /**
+     * The text for this utterance
+     */
     text: string;
-    /** @description The words in the utterance. */
+    /**
+     * The words in the utterance.
+     */
     words: TranscriptWord[];
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "text": "Smoke",
  *   "start": 250,
  *   "end": 650,
  *   "confidence": 0.97465,
  *   "speaker": null
  * }
+ * ```
  */
 export type TranscriptWord = {
-    /** Format: double */
     confidence: number;
     end: number;
-    /** @description 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 [Speaker Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is enabled, else null
+     */
     speaker?: string | null;
     start: number;
     text: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "upload_url": "https://cdn.assemblyai.com/upload/f756988d-47e2-4ca3-96ce-04bb168f8f2a"
  * }
+ * ```
  */
 export type UploadedFile = {
-    /** @description A URL that points to your audio file, accessible only by AssemblyAI's servers */
+    /**
+     * A URL that points to your audio file, accessible only by AssemblyAI's servers
+     */
     upload_url: string;
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "text": "smoke",
  *   "count": 6,
  *   "timestamps": [
@@ -2588,19 +2963,30 @@ export type UploadedFile = {
  *     698
  *   ]
  * }
+ * ```
  */
 export type WordSearchMatch = {
-    /** @description The total amount of times the word is in the transcript */
+    /**
+     * The total amount of times the word is in the transcript
+     */
     count: number;
-    /** @description An array of all index locations for that word within the `words` array of the completed transcript */
+    /**
+     * An array of all index locations for that word within the `words` array of the completed transcript
+     */
     indexes: number[];
-    /** @description The matched word */
+    /**
+     * The matched word
+     */
     text: string;
-    /** @description An array of timestamps */
+    /**
+     * An array of timestamps
+     */
     timestamps: WordSearchTimestamp[];
 };
 /**
- * @example {
+ * @example
+ * ```js
+ * {
  *   "id": "d5a3d302-066e-43fb-b63b-8f57baf185db",
  *   "total_count": 10,
  *   "matches": [
@@ -2672,24 +3058,31 @@ export type WordSearchMatch = {
  *     }
  *   ]
  * }
+ * ```
  */
 export type WordSearchResponse = {
     /**
-     * Format: uuid
-     * @description The ID of the transcript
+     * The ID of the transcript
      */
     id: string;
-    /** @description The matches of the search */
+    /**
+     * The matches of the search
+     */
     matches: WordSearchMatch[];
-    /** @description The total count of all matched instances. For e.g., word 1 matched 2 times, and word 2 matched 3 times, `total_count` will equal 5. */
+    /**
+     * The total count of all matched instances. For e.g., word 1 matched 2 times, and word 2 matched 3 times, `total_count` will equal 5.
+     */
     total_count: number;
 };
 /**
- * @description An array of timestamps structured as [`start_time`, `end_time`] in milliseconds
- * @example [
+ * An array of timestamps structured as [`start_time`, `end_time`] in milliseconds
+ * @example
+ * ```js
+ * [
  *   250,
  *   650
  * ]
+ * ```
  */
 export type WordSearchTimestamp = number[];
 export {};