retell-sdk 4.2.0 → 4.4.0

package/src/resources/call.ts

@@ -99,11 +99,9 @@ export interface PhoneCallResponse {
   to_number: string;
 
   /**
-   * - BETA feature, schema might change, might not always be populated. Please do
-   *   not rely on this object schema for post processing. Post conversation
-   *   evaluation of the call. Including information such as sentiment, intent, call
-   *   completion status and other metrics. Available after call ends. Subscribe to
-   *   `call_analyzed` webhook event type to receive it once ready.
+   * Post call analysis that includes information such as sentiment, status, summary,
+   * and custom defined data to extract. Available after call ends. Subscribe to
+   * `call_analyzed` webhook event type to receive it once ready.
    */
   call_analysis?: PhoneCallResponse.CallAnalysis;
 
@@ -116,6 +114,7 @@ export interface PhoneCallResponse {
     | 'user_hangup'
     | 'agent_hangup'
     | 'call_transfer'
+    | 'voicemail_reached'
     | 'inactivity'
     | 'machine_detected'
     | 'concurrency_limit_reached'
@@ -222,47 +221,37 @@ export interface PhoneCallResponse {
 
 export namespace PhoneCallResponse {
   /**
-   * - BETA feature, schema might change, might not always be populated. Please do
-   *   not rely on this object schema for post processing. Post conversation
-   *   evaluation of the call. Including information such as sentiment, intent, call
-   *   completion status and other metrics. Available after call ends. Subscribe to
-   *   `call_analyzed` webhook event type to receive it once ready.
+   * Post call analysis that includes information such as sentiment, status, summary,
+   * and custom defined data to extract. Available after call ends. Subscribe to
+   * `call_analyzed` webhook event type to receive it once ready.
    */
   export interface CallAnalysis {
     /**
-     * Sentiment of the agent in the call.
+     * Whether the agent seems to have a successful call with the user, where the agent
+     * finishes the task, and the call was complete without being cutoff.
      */
-    agent_sentiment?: 'Negative' | 'Positive' | 'Neutral';
+    call_successful?: boolean;
 
     /**
-     * Evaluate agent task completion status, whether the agent has completed his task.
-     */
-    agent_task_completion_rating?: 'Complete' | 'Incomplete' | 'Partial';
-
-    /**
-     * Reason for the agent task completion status.
-     */
-    agent_task_completion_rating_reason?: string;
-
-    /**
-     * Evaluate whether the call ended normally or was cut off.
+     * A high level summary of the call.
      */
-    call_completion_rating?: 'Complete' | 'Incomplete' | 'Partial';
+    call_summary?: string;
 
     /**
-     * Reason for the call completion status.
+     * Custom analysis data that was extracted based on the schema defined in agent
+     * post call analysis data. Can be empty if nothing is specified.
      */
-    call_completion_rating_reason?: string;
+    custom_analysis_data?: unknown;
 
     /**
-     * A high level summary of the call.
+     * Whether the call is entered voicemail.
      */
-    call_summary?: string;
+    in_voicemail?: boolean;
 
     /**
      * Sentiment of the user in the call.
      */
-    user_sentiment?: 'Negative' | 'Positive' | 'Neutral';
+    user_sentiment?: 'Negative' | 'Positive' | 'Neutral' | 'Unknown';
   }
 
   /**
@@ -550,11 +539,9 @@ export interface WebCallResponse {
   call_type: 'web_call';
 
   /**
-   * - BETA feature, schema might change, might not always be populated. Please do
-   *   not rely on this object schema for post processing. Post conversation
-   *   evaluation of the call. Including information such as sentiment, intent, call
-   *   completion status and other metrics. Available after call ends. Subscribe to
-   *   `call_analyzed` webhook event type to receive it once ready.
+   * Post call analysis that includes information such as sentiment, status, summary,
+   * and custom defined data to extract. Available after call ends. Subscribe to
+   * `call_analyzed` webhook event type to receive it once ready.
    */
   call_analysis?: WebCallResponse.CallAnalysis;
 
@@ -567,6 +554,7 @@ export interface WebCallResponse {
     | 'user_hangup'
     | 'agent_hangup'
     | 'call_transfer'
+    | 'voicemail_reached'
     | 'inactivity'
     | 'machine_detected'
     | 'concurrency_limit_reached'
@@ -673,47 +661,37 @@ export interface WebCallResponse {
 
 export namespace WebCallResponse {
   /**
-   * - BETA feature, schema might change, might not always be populated. Please do
-   *   not rely on this object schema for post processing. Post conversation
-   *   evaluation of the call. Including information such as sentiment, intent, call
-   *   completion status and other metrics. Available after call ends. Subscribe to
-   *   `call_analyzed` webhook event type to receive it once ready.
+   * Post call analysis that includes information such as sentiment, status, summary,
+   * and custom defined data to extract. Available after call ends. Subscribe to
+   * `call_analyzed` webhook event type to receive it once ready.
    */
   export interface CallAnalysis {
     /**
-     * Sentiment of the agent in the call.
+     * Whether the agent seems to have a successful call with the user, where the agent
+     * finishes the task, and the call was complete without being cutoff.
      */
-    agent_sentiment?: 'Negative' | 'Positive' | 'Neutral';
+    call_successful?: boolean;
 
     /**
-     * Evaluate agent task completion status, whether the agent has completed his task.
-     */
-    agent_task_completion_rating?: 'Complete' | 'Incomplete' | 'Partial';
-
-    /**
-     * Reason for the agent task completion status.
-     */
-    agent_task_completion_rating_reason?: string;
-
-    /**
-     * Evaluate whether the call ended normally or was cut off.
+     * A high level summary of the call.
      */
-    call_completion_rating?: 'Complete' | 'Incomplete' | 'Partial';
+    call_summary?: string;
 
     /**
-     * Reason for the call completion status.
+     * Custom analysis data that was extracted based on the schema defined in agent
+     * post call analysis data. Can be empty if nothing is specified.
      */
-    call_completion_rating_reason?: string;
+    custom_analysis_data?: unknown;
 
     /**
-     * A high level summary of the call.
+     * Whether the call is entered voicemail.
      */
-    call_summary?: string;
+    in_voicemail?: boolean;
 
     /**
      * Sentiment of the user in the call.
      */
-    user_sentiment?: 'Negative' | 'Positive' | 'Neutral';
+    user_sentiment?: 'Negative' | 'Positive' | 'Neutral' | 'Unknown';
   }
 
   /**

package/src/resources/llm.ts

@@ -96,16 +96,16 @@ export interface LlmResponse {
   > | null;
 
   /**
-   * For inbound phone calls with Retell numbers, if this webhook is set, will POST
-   * to it to retrieve dynamic variables to use for the call. Without this, there's
-   * no way to pass dynamic variables to inbound calls of Retell numbers.
+   * For inbound phone calls, if this webhook is set, will POST to it to retrieve
+   * dynamic variables to use for the call. Without this, there's no way to pass
+   * dynamic variables for inbound calls.
    */
   inbound_dynamic_variables_webhook_url?: string | null;
 
   /**
-   * Select the underlying LLM. If not set, would default to gpt-3.5-turbo.
+   * Select the underlying LLM. If not set, would default to gpt-4o.
    */
-  model?: 'gpt-3.5-turbo' | 'gpt-4-turbo' | 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku';
+  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku';
 
   /**
    * Name of the starting state. Required if states is not empty.
@@ -687,16 +687,16 @@ export interface LlmCreateParams {
   > | null;
 
   /**
-   * For inbound phone calls with Retell numbers, if this webhook is set, will POST
-   * to it to retrieve dynamic variables to use for the call. Without this, there's
-   * no way to pass dynamic variables to inbound calls of Retell numbers.
+   * For inbound phone calls, if this webhook is set, will POST to it to retrieve
+   * dynamic variables to use for the call. Without this, there's no way to pass
+   * dynamic variables for inbound calls.
    */
   inbound_dynamic_variables_webhook_url?: string | null;
 
   /**
-   * Select the underlying LLM. If not set, would default to gpt-3.5-turbo.
+   * Select the underlying LLM. If not set, would default to gpt-4o.
    */
-  model?: 'gpt-3.5-turbo' | 'gpt-4-turbo' | 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku';
+  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku';
 
   /**
    * Name of the starting state. Required if states is not empty.
@@ -1276,16 +1276,16 @@ export interface LlmUpdateParams {
   > | null;
 
   /**
-   * For inbound phone calls with Retell numbers, if this webhook is set, will POST
-   * to it to retrieve dynamic variables to use for the call. Without this, there's
-   * no way to pass dynamic variables to inbound calls of Retell numbers.
+   * For inbound phone calls, if this webhook is set, will POST to it to retrieve
+   * dynamic variables to use for the call. Without this, there's no way to pass
+   * dynamic variables for inbound calls.
    */
   inbound_dynamic_variables_webhook_url?: string | null;
 
   /**
-   * Select the underlying LLM. If not set, would default to gpt-3.5-turbo.
+   * Select the underlying LLM. If not set, would default to gpt-4o.
    */
-  model?: 'gpt-3.5-turbo' | 'gpt-4-turbo' | 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku';
+  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku';
 
   /**
    * Name of the starting state. Required if states is not empty.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.2.0'; // x-release-please-version
+export const VERSION = '4.4.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.2.0";
+export declare const VERSION = "4.4.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.2.0'; // x-release-please-version
+exports.VERSION = '4.4.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.2.0'; // x-release-please-version
+export const VERSION = '4.4.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map