retell-sdk 4.42.0 → 4.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -169,6 +169,11 @@ export interface LlmResponse {
169
169
  */
170
170
  is_published?: boolean;
171
171
 
172
+ /**
173
+ * Knowledge base configuration for RAG retrieval.
174
+ */
175
+ kb_config?: LlmResponse.KBConfig | null;
176
+
172
177
  /**
173
178
  * A list of knowledge base ids to use for this resource. Set to null to remove all
174
179
  * knowledge bases.
@@ -176,9 +181,12 @@ export interface LlmResponse {
176
181
  knowledge_base_ids?: Array<string> | null;
177
182
 
178
183
  /**
179
- * Select the underlying text LLM. If not set, would default to gpt-4o.
184
+ * Select the underlying text LLM. If not set, would default to gpt-4.1.
180
185
  */
181
186
  model?:
187
+ | 'gpt-5'
188
+ | 'gpt-5-mini'
189
+ | 'gpt-5-nano'
182
190
  | 'gpt-4o'
183
191
  | 'gpt-4o-mini'
184
192
  | 'gpt-4.1'
@@ -188,6 +196,8 @@ export interface LlmResponse {
188
196
  | 'claude-3.5-haiku'
189
197
  | 'gemini-2.0-flash'
190
198
  | 'gemini-2.0-flash-lite'
199
+ | 'gemini-2.5-flash'
200
+ | 'gemini-2.5-flash-lite'
191
201
  | null;
192
202
 
193
203
  /**
@@ -209,7 +219,7 @@ export interface LlmResponse {
209
219
  * Select the underlying speech to speech model. Can only set this or model, not
210
220
  * both.
211
221
  */
212
- s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | null;
222
+ s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
213
223
 
214
224
  /**
215
225
  * Name of the starting state. Required if states is not empty.
@@ -299,6 +309,12 @@ export namespace LlmResponse {
299
309
  * The type of transfer destination.
300
310
  */
301
311
  type: 'predefined';
312
+
313
+ /**
314
+ * Extension digits to dial after the main number connects. Sent via DTMF. Allow
315
+ * digits, '\*', '#'.
316
+ */
317
+ extension?: string;
302
318
  }
303
319
 
304
320
  export interface TransferDestinationInferred {
@@ -786,14 +802,38 @@ export namespace LlmResponse {
786
802
  type: 'mcp';
787
803
 
788
804
  /**
789
- * The input schema of the MCP tool.
805
+ * The description for the sentence agent say during execution. Only applicable
806
+ * when speak_during_execution is true. Can write what to say or even provide
807
+ * examples. The default is "The message you will say to callee when calling this
808
+ * tool. Make sure it fits into the conversation smoothly.".
790
809
  */
791
- input_schema?: { [key: string]: string };
810
+ execution_message_description?: string;
792
811
 
793
812
  /**
794
813
  * Unique id of the MCP.
795
814
  */
796
815
  mcp_id?: string;
816
+
817
+ /**
818
+ * Response variables to add to dynamic variables, key is the variable name, value
819
+ * is the path to the variable in the response
820
+ */
821
+ response_variables?: { [key: string]: string };
822
+
823
+ /**
824
+ * Determines whether the agent would call LLM another time and speak when the
825
+ * result of function is obtained. Usually this needs to get turned on so user can
826
+ * get update for the function call.
827
+ */
828
+ speak_after_execution?: boolean;
829
+
830
+ /**
831
+ * Determines whether the agent would say sentence like "One moment, let me check
832
+ * that." when executing the function. Recommend to turn on if your function call
833
+ * takes over 1s (including network) to complete, so that your agent remains
834
+ * responsive.
835
+ */
836
+ speak_during_execution?: boolean;
797
837
  }
798
838
 
799
839
  export interface SendSMSTool {
@@ -836,6 +876,21 @@ export namespace LlmResponse {
836
876
  }
837
877
  }
838
878
 
879
+ /**
880
+ * Knowledge base configuration for RAG retrieval.
881
+ */
882
+ export interface KBConfig {
883
+ /**
884
+ * Similarity threshold for filtering search results
885
+ */
886
+ filter_score?: number;
887
+
888
+ /**
889
+ * Max number of knowledge base chunks to retrieve
890
+ */
891
+ top_k?: number;
892
+ }
893
+
839
894
  export interface State {
840
895
  /**
841
896
  * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -994,6 +1049,12 @@ export namespace LlmResponse {
994
1049
  * The type of transfer destination.
995
1050
  */
996
1051
  type: 'predefined';
1052
+
1053
+ /**
1054
+ * Extension digits to dial after the main number connects. Sent via DTMF. Allow
1055
+ * digits, '\*', '#'.
1056
+ */
1057
+ extension?: string;
997
1058
  }
998
1059
 
999
1060
  export interface TransferDestinationInferred {
@@ -1481,14 +1542,38 @@ export namespace LlmResponse {
1481
1542
  type: 'mcp';
1482
1543
 
1483
1544
  /**
1484
- * The input schema of the MCP tool.
1545
+ * The description for the sentence agent say during execution. Only applicable
1546
+ * when speak_during_execution is true. Can write what to say or even provide
1547
+ * examples. The default is "The message you will say to callee when calling this
1548
+ * tool. Make sure it fits into the conversation smoothly.".
1485
1549
  */
1486
- input_schema?: { [key: string]: string };
1550
+ execution_message_description?: string;
1487
1551
 
1488
1552
  /**
1489
1553
  * Unique id of the MCP.
1490
1554
  */
1491
1555
  mcp_id?: string;
1556
+
1557
+ /**
1558
+ * Response variables to add to dynamic variables, key is the variable name, value
1559
+ * is the path to the variable in the response
1560
+ */
1561
+ response_variables?: { [key: string]: string };
1562
+
1563
+ /**
1564
+ * Determines whether the agent would call LLM another time and speak when the
1565
+ * result of function is obtained. Usually this needs to get turned on so user can
1566
+ * get update for the function call.
1567
+ */
1568
+ speak_after_execution?: boolean;
1569
+
1570
+ /**
1571
+ * Determines whether the agent would say sentence like "One moment, let me check
1572
+ * that." when executing the function. Recommend to turn on if your function call
1573
+ * takes over 1s (including network) to complete, so that your agent remains
1574
+ * responsive.
1575
+ */
1576
+ speak_during_execution?: boolean;
1492
1577
  }
1493
1578
 
1494
1579
  export interface SendSMSTool {
@@ -1580,6 +1665,11 @@ export interface LlmCreateParams {
1580
1665
  | LlmCreateParams.SendSMSTool
1581
1666
  > | null;
1582
1667
 
1668
+ /**
1669
+ * Knowledge base configuration for RAG retrieval.
1670
+ */
1671
+ kb_config?: LlmCreateParams.KBConfig | null;
1672
+
1583
1673
  /**
1584
1674
  * A list of knowledge base ids to use for this resource. Set to null to remove all
1585
1675
  * knowledge bases.
@@ -1587,9 +1677,12 @@ export interface LlmCreateParams {
1587
1677
  knowledge_base_ids?: Array<string> | null;
1588
1678
 
1589
1679
  /**
1590
- * Select the underlying text LLM. If not set, would default to gpt-4o.
1680
+ * Select the underlying text LLM. If not set, would default to gpt-4.1.
1591
1681
  */
1592
1682
  model?:
1683
+ | 'gpt-5'
1684
+ | 'gpt-5-mini'
1685
+ | 'gpt-5-nano'
1593
1686
  | 'gpt-4o'
1594
1687
  | 'gpt-4o-mini'
1595
1688
  | 'gpt-4.1'
@@ -1599,6 +1692,8 @@ export interface LlmCreateParams {
1599
1692
  | 'claude-3.5-haiku'
1600
1693
  | 'gemini-2.0-flash'
1601
1694
  | 'gemini-2.0-flash-lite'
1695
+ | 'gemini-2.5-flash'
1696
+ | 'gemini-2.5-flash-lite'
1602
1697
  | null;
1603
1698
 
1604
1699
  /**
@@ -1620,7 +1715,7 @@ export interface LlmCreateParams {
1620
1715
  * Select the underlying speech to speech model. Can only set this or model, not
1621
1716
  * both.
1622
1717
  */
1623
- s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | null;
1718
+ s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
1624
1719
 
1625
1720
  /**
1626
1721
  * Name of the starting state. Required if states is not empty.
@@ -1710,6 +1805,12 @@ export namespace LlmCreateParams {
1710
1805
  * The type of transfer destination.
1711
1806
  */
1712
1807
  type: 'predefined';
1808
+
1809
+ /**
1810
+ * Extension digits to dial after the main number connects. Sent via DTMF. Allow
1811
+ * digits, '\*', '#'.
1812
+ */
1813
+ extension?: string;
1713
1814
  }
1714
1815
 
1715
1816
  export interface TransferDestinationInferred {
@@ -2197,14 +2298,38 @@ export namespace LlmCreateParams {
2197
2298
  type: 'mcp';
2198
2299
 
2199
2300
  /**
2200
- * The input schema of the MCP tool.
2301
+ * The description for the sentence agent say during execution. Only applicable
2302
+ * when speak_during_execution is true. Can write what to say or even provide
2303
+ * examples. The default is "The message you will say to callee when calling this
2304
+ * tool. Make sure it fits into the conversation smoothly.".
2201
2305
  */
2202
- input_schema?: { [key: string]: string };
2306
+ execution_message_description?: string;
2203
2307
 
2204
2308
  /**
2205
2309
  * Unique id of the MCP.
2206
2310
  */
2207
2311
  mcp_id?: string;
2312
+
2313
+ /**
2314
+ * Response variables to add to dynamic variables, key is the variable name, value
2315
+ * is the path to the variable in the response
2316
+ */
2317
+ response_variables?: { [key: string]: string };
2318
+
2319
+ /**
2320
+ * Determines whether the agent would call LLM another time and speak when the
2321
+ * result of function is obtained. Usually this needs to get turned on so user can
2322
+ * get update for the function call.
2323
+ */
2324
+ speak_after_execution?: boolean;
2325
+
2326
+ /**
2327
+ * Determines whether the agent would say sentence like "One moment, let me check
2328
+ * that." when executing the function. Recommend to turn on if your function call
2329
+ * takes over 1s (including network) to complete, so that your agent remains
2330
+ * responsive.
2331
+ */
2332
+ speak_during_execution?: boolean;
2208
2333
  }
2209
2334
 
2210
2335
  export interface SendSMSTool {
@@ -2247,6 +2372,21 @@ export namespace LlmCreateParams {
2247
2372
  }
2248
2373
  }
2249
2374
 
2375
+ /**
2376
+ * Knowledge base configuration for RAG retrieval.
2377
+ */
2378
+ export interface KBConfig {
2379
+ /**
2380
+ * Similarity threshold for filtering search results
2381
+ */
2382
+ filter_score?: number;
2383
+
2384
+ /**
2385
+ * Max number of knowledge base chunks to retrieve
2386
+ */
2387
+ top_k?: number;
2388
+ }
2389
+
2250
2390
  export interface State {
2251
2391
  /**
2252
2392
  * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -2405,6 +2545,12 @@ export namespace LlmCreateParams {
2405
2545
  * The type of transfer destination.
2406
2546
  */
2407
2547
  type: 'predefined';
2548
+
2549
+ /**
2550
+ * Extension digits to dial after the main number connects. Sent via DTMF. Allow
2551
+ * digits, '\*', '#'.
2552
+ */
2553
+ extension?: string;
2408
2554
  }
2409
2555
 
2410
2556
  export interface TransferDestinationInferred {
@@ -2892,14 +3038,38 @@ export namespace LlmCreateParams {
2892
3038
  type: 'mcp';
2893
3039
 
2894
3040
  /**
2895
- * The input schema of the MCP tool.
3041
+ * The description for the sentence agent say during execution. Only applicable
3042
+ * when speak_during_execution is true. Can write what to say or even provide
3043
+ * examples. The default is "The message you will say to callee when calling this
3044
+ * tool. Make sure it fits into the conversation smoothly.".
2896
3045
  */
2897
- input_schema?: { [key: string]: string };
3046
+ execution_message_description?: string;
2898
3047
 
2899
3048
  /**
2900
3049
  * Unique id of the MCP.
2901
3050
  */
2902
3051
  mcp_id?: string;
3052
+
3053
+ /**
3054
+ * Response variables to add to dynamic variables, key is the variable name, value
3055
+ * is the path to the variable in the response
3056
+ */
3057
+ response_variables?: { [key: string]: string };
3058
+
3059
+ /**
3060
+ * Determines whether the agent would call LLM another time and speak when the
3061
+ * result of function is obtained. Usually this needs to get turned on so user can
3062
+ * get update for the function call.
3063
+ */
3064
+ speak_after_execution?: boolean;
3065
+
3066
+ /**
3067
+ * Determines whether the agent would say sentence like "One moment, let me check
3068
+ * that." when executing the function. Recommend to turn on if your function call
3069
+ * takes over 1s (including network) to complete, so that your agent remains
3070
+ * responsive.
3071
+ */
3072
+ speak_during_execution?: boolean;
2903
3073
  }
2904
3074
 
2905
3075
  export interface SendSMSTool {
@@ -3005,6 +3175,11 @@ export interface LlmUpdateParams {
3005
3175
  | LlmUpdateParams.SendSMSTool
3006
3176
  > | null;
3007
3177
 
3178
+ /**
3179
+ * Body param: Knowledge base configuration for RAG retrieval.
3180
+ */
3181
+ kb_config?: LlmUpdateParams.KBConfig | null;
3182
+
3008
3183
  /**
3009
3184
  * Body param: A list of knowledge base ids to use for this resource. Set to null
3010
3185
  * to remove all knowledge bases.
@@ -3012,9 +3187,13 @@ export interface LlmUpdateParams {
3012
3187
  knowledge_base_ids?: Array<string> | null;
3013
3188
 
3014
3189
  /**
3015
- * Body param: Select the underlying text LLM. If not set, would default to gpt-4o.
3190
+ * Body param: Select the underlying text LLM. If not set, would default to
3191
+ * gpt-4.1.
3016
3192
  */
3017
3193
  model?:
3194
+ | 'gpt-5'
3195
+ | 'gpt-5-mini'
3196
+ | 'gpt-5-nano'
3018
3197
  | 'gpt-4o'
3019
3198
  | 'gpt-4o-mini'
3020
3199
  | 'gpt-4.1'
@@ -3024,6 +3203,8 @@ export interface LlmUpdateParams {
3024
3203
  | 'claude-3.5-haiku'
3025
3204
  | 'gemini-2.0-flash'
3026
3205
  | 'gemini-2.0-flash-lite'
3206
+ | 'gemini-2.5-flash'
3207
+ | 'gemini-2.5-flash-lite'
3027
3208
  | null;
3028
3209
 
3029
3210
  /**
@@ -3045,7 +3226,7 @@ export interface LlmUpdateParams {
3045
3226
  * Body param: Select the underlying speech to speech model. Can only set this or
3046
3227
  * model, not both.
3047
3228
  */
3048
- s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | null;
3229
+ s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | 'gpt-realtime' | null;
3049
3230
 
3050
3231
  /**
3051
3232
  * Body param: Name of the starting state. Required if states is not empty.
@@ -3135,6 +3316,12 @@ export namespace LlmUpdateParams {
3135
3316
  * The type of transfer destination.
3136
3317
  */
3137
3318
  type: 'predefined';
3319
+
3320
+ /**
3321
+ * Extension digits to dial after the main number connects. Sent via DTMF. Allow
3322
+ * digits, '\*', '#'.
3323
+ */
3324
+ extension?: string;
3138
3325
  }
3139
3326
 
3140
3327
  export interface TransferDestinationInferred {
@@ -3622,14 +3809,38 @@ export namespace LlmUpdateParams {
3622
3809
  type: 'mcp';
3623
3810
 
3624
3811
  /**
3625
- * The input schema of the MCP tool.
3812
+ * The description for the sentence agent say during execution. Only applicable
3813
+ * when speak_during_execution is true. Can write what to say or even provide
3814
+ * examples. The default is "The message you will say to callee when calling this
3815
+ * tool. Make sure it fits into the conversation smoothly.".
3626
3816
  */
3627
- input_schema?: { [key: string]: string };
3817
+ execution_message_description?: string;
3628
3818
 
3629
3819
  /**
3630
3820
  * Unique id of the MCP.
3631
3821
  */
3632
3822
  mcp_id?: string;
3823
+
3824
+ /**
3825
+ * Response variables to add to dynamic variables, key is the variable name, value
3826
+ * is the path to the variable in the response
3827
+ */
3828
+ response_variables?: { [key: string]: string };
3829
+
3830
+ /**
3831
+ * Determines whether the agent would call LLM another time and speak when the
3832
+ * result of function is obtained. Usually this needs to get turned on so user can
3833
+ * get update for the function call.
3834
+ */
3835
+ speak_after_execution?: boolean;
3836
+
3837
+ /**
3838
+ * Determines whether the agent would say sentence like "One moment, let me check
3839
+ * that." when executing the function. Recommend to turn on if your function call
3840
+ * takes over 1s (including network) to complete, so that your agent remains
3841
+ * responsive.
3842
+ */
3843
+ speak_during_execution?: boolean;
3633
3844
  }
3634
3845
 
3635
3846
  export interface SendSMSTool {
@@ -3672,6 +3883,21 @@ export namespace LlmUpdateParams {
3672
3883
  }
3673
3884
  }
3674
3885
 
3886
+ /**
3887
+ * Knowledge base configuration for RAG retrieval.
3888
+ */
3889
+ export interface KBConfig {
3890
+ /**
3891
+ * Similarity threshold for filtering search results
3892
+ */
3893
+ filter_score?: number;
3894
+
3895
+ /**
3896
+ * Max number of knowledge base chunks to retrieve
3897
+ */
3898
+ top_k?: number;
3899
+ }
3900
+
3675
3901
  export interface State {
3676
3902
  /**
3677
3903
  * Name of the state, must be unique for each state. Must be consisted of a-z, A-Z,
@@ -3830,6 +4056,12 @@ export namespace LlmUpdateParams {
3830
4056
  * The type of transfer destination.
3831
4057
  */
3832
4058
  type: 'predefined';
4059
+
4060
+ /**
4061
+ * Extension digits to dial after the main number connects. Sent via DTMF. Allow
4062
+ * digits, '\*', '#'.
4063
+ */
4064
+ extension?: string;
3833
4065
  }
3834
4066
 
3835
4067
  export interface TransferDestinationInferred {
@@ -4317,14 +4549,38 @@ export namespace LlmUpdateParams {
4317
4549
  type: 'mcp';
4318
4550
 
4319
4551
  /**
4320
- * The input schema of the MCP tool.
4552
+ * The description for the sentence agent say during execution. Only applicable
4553
+ * when speak_during_execution is true. Can write what to say or even provide
4554
+ * examples. The default is "The message you will say to callee when calling this
4555
+ * tool. Make sure it fits into the conversation smoothly.".
4321
4556
  */
4322
- input_schema?: { [key: string]: string };
4557
+ execution_message_description?: string;
4323
4558
 
4324
4559
  /**
4325
4560
  * Unique id of the MCP.
4326
4561
  */
4327
4562
  mcp_id?: string;
4563
+
4564
+ /**
4565
+ * Response variables to add to dynamic variables, key is the variable name, value
4566
+ * is the path to the variable in the response
4567
+ */
4568
+ response_variables?: { [key: string]: string };
4569
+
4570
+ /**
4571
+ * Determines whether the agent would call LLM another time and speak when the
4572
+ * result of function is obtained. Usually this needs to get turned on so user can
4573
+ * get update for the function call.
4574
+ */
4575
+ speak_after_execution?: boolean;
4576
+
4577
+ /**
4578
+ * Determines whether the agent would say sentence like "One moment, let me check
4579
+ * that." when executing the function. Recommend to turn on if your function call
4580
+ * takes over 1s (including network) to complete, so that your agent remains
4581
+ * responsive.
4582
+ */
4583
+ speak_during_execution?: boolean;
4328
4584
  }
4329
4585
 
4330
4586
  export interface SendSMSTool {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '4.42.0'; // x-release-please-version
1
+ export const VERSION = '4.44.0'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "4.42.0";
1
+ export declare const VERSION = "4.44.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '4.42.0'; // x-release-please-version
4
+ exports.VERSION = '4.44.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '4.42.0'; // x-release-please-version
1
+ export const VERSION = '4.44.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map