retell-sdk 5.10.2 → 5.11.0

package/src/resources/chat-agent.ts

@@ -205,6 +205,12 @@ export interface ChatAgentResponse {
    */
   guardrail_config?: ChatAgentResponse.GuardrailConfig;
 
+  /**
+   * Toggle behavior presets on/off to influence agent response style and behaviors.
+   * Voice-only presets are not available for chat agents.
+   */
+  handbook_config?: ChatAgentResponse.HandbookConfig;
+
   /**
    * Whether the agent is public. When set to true, the agent is available for public
    * agent preview link.
@@ -284,6 +290,7 @@ export interface ChatAgentResponse {
     | ChatAgentResponse.EnumAnalysisData
     | ChatAgentResponse.BooleanAnalysisData
     | ChatAgentResponse.NumberAnalysisData
+    | ChatAgentResponse.ChatPresetAnalysisData
   > | null;
 
   /**
@@ -316,6 +323,12 @@ export interface ChatAgentResponse {
    */
   signed_url_expiration_ms?: number | null;
 
+  /**
+   * IANA timezone for the agent (e.g. America/New_York). Defaults to
+   * America/Los_Angeles if not set.
+   */
+  timezone?: string | null;
+
   /**
    * The version of the chat agent.
    */
@@ -418,6 +431,32 @@ export namespace ChatAgentResponse {
     > | null;
   }
 
+  /**
+   * Toggle behavior presets on/off to influence agent response style and behaviors.
+   * Voice-only presets are not available for chat agents.
+   */
+  export interface HandbookConfig {
+    /**
+     * When asked, acknowledge being a virtual assistant.
+     */
+    ai_disclosure?: boolean;
+
+    /**
+     * Professional call center rep baseline.
+     */
+    default_personality?: boolean;
+
+    /**
+     * Warm acknowledgment of caller concerns.
+     */
+    high_empathy?: boolean;
+
+    /**
+     * Stay within prompt/context scope, don't invent details.
+     */
+    scope_boundaries?: boolean;
+  }
+
   /**
    * Configuration for PII scrubbing from transcripts and recordings.
    */
@@ -464,6 +503,13 @@ export namespace ChatAgentResponse {
      */
     type: 'string';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Examples of the variable value to teach model the style and syntax.
      */
@@ -497,6 +543,13 @@ export namespace ChatAgentResponse {
      */
     type: 'enum';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Whether this data is required. If true and the data is not extracted, the call
      * will be marked as unsuccessful.
@@ -520,6 +573,13 @@ export namespace ChatAgentResponse {
      */
     type: 'boolean';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Whether this data is required. If true and the data is not extracted, the call
      * will be marked as unsuccessful.
@@ -543,12 +603,52 @@ export namespace ChatAgentResponse {
      */
     type: 'number';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Whether this data is required. If true and the data is not extracted, the call
      * will be marked as unsuccessful.
      */
     required?: boolean;
   }
+
+  /**
+   * System preset for post-chat analysis (chat agents). Use in
+   * post_chat_analysis_data to override prompts or mark fields optional.
+   */
+  export interface ChatPresetAnalysisData {
+    /**
+     * Preset identifier for chat agent analysis.
+     */
+    name: 'chat_summary' | 'chat_successful' | 'user_sentiment';
+
+    /**
+     * Identifies this item as a system preset.
+     */
+    type: 'system-presets';
+
+    /**
+     * Optional instruction to help decide whether this field needs to be populated. If
+     * not set, the field is always included.
+     */
+    conditional_prompt?: string;
+
+    /**
+     * Prompt or description for this preset.
+     */
+    description?: string;
+
+    /**
+     * If false, this field is optional in the analysis. If true or unset, the field is
+     * required.
+     */
+    required?: boolean;
+  }
 }
 
 export type ChatAgentListResponse = Array<ChatAgentResponse>;
@@ -622,6 +722,12 @@ export interface ChatAgentCreateParams {
    */
   guardrail_config?: ChatAgentCreateParams.GuardrailConfig;
 
+  /**
+   * Toggle behavior presets on/off to influence agent response style and behaviors.
+   * Voice-only presets are not available for chat agents.
+   */
+  handbook_config?: ChatAgentCreateParams.HandbookConfig;
+
   /**
    * Whether the agent is public. When set to true, the agent is available for public
    * agent preview link.
@@ -696,6 +802,7 @@ export interface ChatAgentCreateParams {
     | ChatAgentCreateParams.EnumAnalysisData
     | ChatAgentCreateParams.BooleanAnalysisData
     | ChatAgentCreateParams.NumberAnalysisData
+    | ChatAgentCreateParams.ChatPresetAnalysisData
   > | null;
 
   /**
@@ -728,6 +835,12 @@ export interface ChatAgentCreateParams {
    */
   signed_url_expiration_ms?: number | null;
 
+  /**
+   * IANA timezone for the agent (e.g. America/New_York). Defaults to
+   * America/Los_Angeles if not set.
+   */
+  timezone?: string | null;
+
   /**
    * Which webhook events this agent should receive. If not set, defaults to
    * chat_started, chat_ended, chat_analyzed.
@@ -825,6 +938,32 @@ export namespace ChatAgentCreateParams {
     > | null;
   }
 
+  /**
+   * Toggle behavior presets on/off to influence agent response style and behaviors.
+   * Voice-only presets are not available for chat agents.
+   */
+  export interface HandbookConfig {
+    /**
+     * When asked, acknowledge being a virtual assistant.
+     */
+    ai_disclosure?: boolean;
+
+    /**
+     * Professional call center rep baseline.
+     */
+    default_personality?: boolean;
+
+    /**
+     * Warm acknowledgment of caller concerns.
+     */
+    high_empathy?: boolean;
+
+    /**
+     * Stay within prompt/context scope, don't invent details.
+     */
+    scope_boundaries?: boolean;
+  }
+
   /**
    * Configuration for PII scrubbing from transcripts and recordings.
    */
@@ -871,6 +1010,13 @@ export namespace ChatAgentCreateParams {
      */
     type: 'string';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Examples of the variable value to teach model the style and syntax.
      */
@@ -904,6 +1050,13 @@ export namespace ChatAgentCreateParams {
      */
     type: 'enum';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Whether this data is required. If true and the data is not extracted, the call
      * will be marked as unsuccessful.
@@ -927,6 +1080,13 @@ export namespace ChatAgentCreateParams {
      */
     type: 'boolean';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Whether this data is required. If true and the data is not extracted, the call
      * will be marked as unsuccessful.
@@ -950,12 +1110,52 @@ export namespace ChatAgentCreateParams {
      */
     type: 'number';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Whether this data is required. If true and the data is not extracted, the call
      * will be marked as unsuccessful.
      */
     required?: boolean;
   }
+
+  /**
+   * System preset for post-chat analysis (chat agents). Use in
+   * post_chat_analysis_data to override prompts or mark fields optional.
+   */
+  export interface ChatPresetAnalysisData {
+    /**
+     * Preset identifier for chat agent analysis.
+     */
+    name: 'chat_summary' | 'chat_successful' | 'user_sentiment';
+
+    /**
+     * Identifies this item as a system preset.
+     */
+    type: 'system-presets';
+
+    /**
+     * Optional instruction to help decide whether this field needs to be populated. If
+     * not set, the field is always included.
+     */
+    conditional_prompt?: string;
+
+    /**
+     * Prompt or description for this preset.
+     */
+    description?: string;
+
+    /**
+     * If false, this field is optional in the analysis. If true or unset, the field is
+     * required.
+     */
+    required?: boolean;
+  }
 }
 
 export interface ChatAgentRetrieveParams {
@@ -1031,6 +1231,12 @@ export interface ChatAgentUpdateParams {
    */
   guardrail_config?: ChatAgentUpdateParams.GuardrailConfig;
 
+  /**
+   * Body param: Toggle behavior presets on/off to influence agent response style and
+   * behaviors. Voice-only presets are not available for chat agents.
+   */
+  handbook_config?: ChatAgentUpdateParams.HandbookConfig;
+
   /**
    * Body param: Whether the agent is public. When set to true, the agent is
    * available for public agent preview link.
@@ -1105,6 +1311,7 @@ export interface ChatAgentUpdateParams {
     | ChatAgentUpdateParams.EnumAnalysisData
     | ChatAgentUpdateParams.BooleanAnalysisData
     | ChatAgentUpdateParams.NumberAnalysisData
+    | ChatAgentUpdateParams.ChatPresetAnalysisData
   > | null;
 
   /**
@@ -1147,6 +1354,12 @@ export interface ChatAgentUpdateParams {
    */
   signed_url_expiration_ms?: number | null;
 
+  /**
+   * Body param: IANA timezone for the agent (e.g. America/New_York). Defaults to
+   * America/Los_Angeles if not set.
+   */
+  timezone?: string | null;
+
   /**
    * Body param: Which webhook events this agent should receive. If not set, defaults
    * to chat_started, chat_ended, chat_analyzed.
@@ -1198,6 +1411,32 @@ export namespace ChatAgentUpdateParams {
     > | null;
   }
 
+  /**
+   * Toggle behavior presets on/off to influence agent response style and behaviors.
+   * Voice-only presets are not available for chat agents.
+   */
+  export interface HandbookConfig {
+    /**
+     * When asked, acknowledge being a virtual assistant.
+     */
+    ai_disclosure?: boolean;
+
+    /**
+     * Professional call center rep baseline.
+     */
+    default_personality?: boolean;
+
+    /**
+     * Warm acknowledgment of caller concerns.
+     */
+    high_empathy?: boolean;
+
+    /**
+     * Stay within prompt/context scope, don't invent details.
+     */
+    scope_boundaries?: boolean;
+  }
+
   /**
    * Configuration for PII scrubbing from transcripts and recordings.
    */
@@ -1244,6 +1483,13 @@ export namespace ChatAgentUpdateParams {
      */
     type: 'string';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Examples of the variable value to teach model the style and syntax.
      */
@@ -1277,6 +1523,13 @@ export namespace ChatAgentUpdateParams {
      */
     type: 'enum';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Whether this data is required. If true and the data is not extracted, the call
      * will be marked as unsuccessful.
@@ -1300,6 +1553,13 @@ export namespace ChatAgentUpdateParams {
      */
     type: 'boolean';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Whether this data is required. If true and the data is not extracted, the call
      * will be marked as unsuccessful.
@@ -1323,6 +1583,13 @@ export namespace ChatAgentUpdateParams {
      */
     type: 'number';
 
+    /**
+     * Optional instruction to help decide whether this field needs to be populated in
+     * the analysis. If not set, the field is always included. If required is true,
+     * this is ignored.
+     */
+    conditional_prompt?: string;
+
     /**
      * Whether this data is required. If true and the data is not extracted, the call
      * will be marked as unsuccessful.
@@ -1330,6 +1597,39 @@ export namespace ChatAgentUpdateParams {
     required?: boolean;
   }
 
+  /**
+   * System preset for post-chat analysis (chat agents). Use in
+   * post_chat_analysis_data to override prompts or mark fields optional.
+   */
+  export interface ChatPresetAnalysisData {
+    /**
+     * Preset identifier for chat agent analysis.
+     */
+    name: 'chat_summary' | 'chat_successful' | 'user_sentiment';
+
+    /**
+     * Identifies this item as a system preset.
+     */
+    type: 'system-presets';
+
+    /**
+     * Optional instruction to help decide whether this field needs to be populated. If
+     * not set, the field is always included.
+     */
+    conditional_prompt?: string;
+
+    /**
+     * Prompt or description for this preset.
+     */
+    description?: string;
+
+    /**
+     * If false, this field is optional in the analysis. If true or unset, the field is
+     * required.
+     */
+    required?: boolean;
+  }
+
   export interface ResponseEngineRetellLm {
     /**
      * id of the Retell LLM Response Engine.