assemblyai 4.5.0 → 4.6.1

package/src/types/openapi.generated.ts

@@ -596,12 +596,7 @@ export type LemurActionItemsParams = LemurBaseParams & {
  * }
  * ```
  */
-export type LemurActionItemsResponse = LemurBaseResponse & {
-  /**
-   * The response generated by LeMUR
-   */
-  response: string;
-};
+export type LemurActionItemsResponse = LemurStringResponse;
 
 /**
  * @example
@@ -632,7 +627,6 @@ export type LemurBaseParams = {
   >;
   /**
    * The model that is used for the final prompt after compression is performed.
-   * Defaults to "default".
    *
    * @defaultValue "default
    */
@@ -687,10 +681,16 @@ export type LemurBaseResponse = {
  *
  */
 export type LemurModel =
+  | "anthropic/claude-3-5-sonnet"
+  | "anthropic/claude-3-opus"
+  | "anthropic/claude-3-haiku"
+  | "anthropic/claude-3-sonnet"
+  | "anthropic/claude-2-1"
+  | "anthropic/claude-2"
   | "default"
+  | "anthropic/claude-instant-1-2"
   | "basic"
-  | "assemblyai/mistral-7b"
-  | "anthropic/claude-2-1";
+  | "assemblyai/mistral-7b";
 
 /**
  * @example
@@ -815,11 +815,27 @@ export type LemurQuestionAnswerResponse = LemurBaseResponse & {
   response: LemurQuestionAnswer[];
 };
 
-export type LemurResponse =
-  | LemurTaskResponse
-  | LemurSummaryResponse
-  | LemurQuestionAnswerResponse
-  | LemurActionItemsResponse;
+export type LemurResponse = LemurStringResponse | LemurQuestionAnswerResponse;
+
+/**
+ * @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",
+ *   "usage": {
+ *     "input_tokens": 27,
+ *     "output_tokens": 3
+ *   }
+ * }
+ * ```
+ */
+export type LemurStringResponse = {
+  /**
+   * The response generated by LeMUR.
+   */
+  response: string;
+} & LemurBaseResponse;
 
 /**
  * @example
@@ -855,12 +871,7 @@ export type LemurSummaryParams = LemurBaseParams & {
  * }
  * ```
  */
-export type LemurSummaryResponse = LemurBaseResponse & {
-  /**
-   * The response generated by LeMUR
-   */
-  response: string;
-};
+export type LemurSummaryResponse = LemurStringResponse;
 
 /**
  * @example
@@ -897,12 +908,7 @@ export type LemurTaskParams = {
  * }
  * ```
  */
-export type LemurTaskResponse = {
-  /**
-   * The response generated by LeMUR.
-   */
-  response: string;
-} & LemurBaseResponse;
+export type LemurTaskResponse = LemurStringResponse;
 
 /**
  * The usage numbers for the LeMUR request
@@ -1168,6 +1174,11 @@ export type RealtimeTemporaryTokenResponse = {
   token: string;
 };
 
+/**
+ * The notification when the redacted audio is ready.
+ */
+export type RedactedAudioNotification = RedactedAudioResponse;
+
 /**
  * @example
  * ```js
@@ -1369,7 +1380,7 @@ export type SeverityScoreSummary = {
 /**
  * The speech model to use for the transcription.
  */
-export type SpeechModel = "best" | "nano" | "conformer-2";
+export type SpeechModel = "best" | "nano";
 
 /**
  * The replacement logic for detected PII, can be "entity_name" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
@@ -2506,15 +2517,17 @@ export type Transcript = {
    */
   webhook_auth: boolean;
   /**
-   * The header name which should be sent back with webhook calls
+   * The header name to be sent with the transcript completed or failed webhook requests
    */
   webhook_auth_header_name?: string | null;
   /**
-   * 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 the transcript completed or failed webhook request, if a webhook URL was provided
    */
   webhook_status_code?: number | null;
   /**
-   * The URL to which we send webhooks upon transcription completion
+   * The URL to which we send webhook requests.
+   * We sends two different types of webhook requests.
+   * One request when a transcript is completed or failed, and one request when the redacted audio is ready if redact_pii_audio is enabled.
    */
   webhook_url?: string | null;
   /**
@@ -2931,17 +2944,17 @@ export type TranscriptOptionalParams = {
    */
   topics?: string[];
   /**
-   * The header name which should be sent back with webhook calls
+   * The header name to be sent with the transcript completed or failed webhook requests
    * @defaultValue null
    */
   webhook_auth_header_name?: string | null;
   /**
-   * Specify a header name and value to send back with a webhook call for added security
+   * The header value to send back with the transcript completed or failed webhook requests for added security
    * @defaultValue null
    */
   webhook_auth_header_value?: string | null;
   /**
-   * The URL to which AssemblyAI send webhooks upon transcription completion
+   * The URL to which we send webhook requests. We sends two different types of webhook requests. One request when a transcript is completed or failed, and one request when the redacted audio is ready if redact_pii_audio is enabled.
    */
   webhook_url?: string;
   /**
@@ -3292,6 +3305,13 @@ export type TranscriptUtterance = {
   words: TranscriptWord[];
 };
 
+/**
+ * The notifications sent to the webhook URL.
+ */
+export type TranscriptWebhookNotification =
+  | TranscriptReadyNotification
+  | RedactedAudioNotification;
+
 /**
  * @example
  * ```js