retell-sdk 5.2.0 → 5.3.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.
- package/CHANGELOG.md +14 -0
- package/package.json +1 -1
- package/resources/agent.d.mts +39 -3
- package/resources/agent.d.mts.map +1 -1
- package/resources/agent.d.ts +39 -3
- package/resources/agent.d.ts.map +1 -1
- package/resources/batch-call.d.mts +13 -1
- package/resources/batch-call.d.mts.map +1 -1
- package/resources/batch-call.d.ts +13 -1
- package/resources/batch-call.d.ts.map +1 -1
- package/resources/call.d.mts +58 -6
- package/resources/call.d.mts.map +1 -1
- package/resources/call.d.ts +58 -6
- package/resources/call.d.ts.map +1 -1
- package/resources/chat-agent.d.mts +34 -0
- package/resources/chat-agent.d.mts.map +1 -1
- package/resources/chat-agent.d.ts +34 -0
- package/resources/chat-agent.d.ts.map +1 -1
- package/resources/chat.d.mts +8 -0
- package/resources/chat.d.mts.map +1 -1
- package/resources/chat.d.ts +8 -0
- package/resources/chat.d.ts.map +1 -1
- package/resources/conversation-flow-component.d.mts +1927 -16
- package/resources/conversation-flow-component.d.mts.map +1 -1
- package/resources/conversation-flow-component.d.ts +1927 -16
- package/resources/conversation-flow-component.d.ts.map +1 -1
- package/resources/conversation-flow.d.mts +3958 -136
- package/resources/conversation-flow.d.mts.map +1 -1
- package/resources/conversation-flow.d.ts +3958 -136
- package/resources/conversation-flow.d.ts.map +1 -1
- package/resources/phone-number.d.mts +57 -38
- package/resources/phone-number.d.mts.map +1 -1
- package/resources/phone-number.d.ts +57 -38
- package/resources/phone-number.d.ts.map +1 -1
- package/resources/voice.d.mts +6 -6
- package/resources/voice.d.mts.map +1 -1
- package/resources/voice.d.ts +6 -6
- package/resources/voice.d.ts.map +1 -1
- package/src/resources/agent.ts +45 -0
- package/src/resources/batch-call.ts +15 -0
- package/src/resources/call.ts +65 -3
- package/src/resources/chat-agent.ts +40 -0
- package/src/resources/chat.ts +10 -0
- package/src/resources/conversation-flow-component.ts +2808 -0
- package/src/resources/conversation-flow.ts +5801 -185
- package/src/resources/phone-number.ts +57 -38
- package/src/resources/voice.ts +6 -6
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -281,6 +281,13 @@ export namespace BatchCallCreateBatchCallParams {
|
|
|
281
281
|
*/
|
|
282
282
|
analysis_summary_prompt?: string | null;
|
|
283
283
|
|
|
284
|
+
/**
|
|
285
|
+
* Prompt to guide how the post call or chat analysis should evaluate user
|
|
286
|
+
* sentiment. When unset, the default system prompt is used. Set to null to use the
|
|
287
|
+
* default prompt.
|
|
288
|
+
*/
|
|
289
|
+
analysis_user_sentiment_prompt?: string | null;
|
|
290
|
+
|
|
284
291
|
/**
|
|
285
292
|
* Only applicable when enable_backchannel is true. Controls how often the agent
|
|
286
293
|
* would backchannel when a backchannel is possible. Value ranging from [0,1].
|
|
@@ -319,6 +326,13 @@ export namespace BatchCallCreateBatchCallParams {
|
|
|
319
326
|
*/
|
|
320
327
|
custom_stt_config?: Agent.CustomSttConfig;
|
|
321
328
|
|
|
329
|
+
/**
|
|
330
|
+
* Number of days to retain call/chat data before automatic deletion. Must be
|
|
331
|
+
* between 1 and 730 days. If not set, data is retained forever (no automatic
|
|
332
|
+
* deletion).
|
|
333
|
+
*/
|
|
334
|
+
data_storage_retention_days?: number | null;
|
|
335
|
+
|
|
322
336
|
/**
|
|
323
337
|
* Granular setting to manage how Retell stores sensitive data (transcripts,
|
|
324
338
|
* recordings, logs, etc.). This replaces the deprecated
|
|
@@ -639,6 +653,7 @@ export namespace BatchCallCreateBatchCallParams {
|
|
|
639
653
|
| 'gpt-4o-mini-tts'
|
|
640
654
|
| 'speech-02-turbo'
|
|
641
655
|
| 'speech-2.8-turbo'
|
|
656
|
+
| 's1'
|
|
642
657
|
| null;
|
|
643
658
|
|
|
644
659
|
/**
|
package/src/resources/call.ts
CHANGED
|
@@ -223,7 +223,6 @@ export interface PhoneCallResponse {
|
|
|
223
223
|
| 'agent_hangup'
|
|
224
224
|
| 'call_transfer'
|
|
225
225
|
| 'voicemail_reached'
|
|
226
|
-
| 'ivr_reached'
|
|
227
226
|
| 'inactivity'
|
|
228
227
|
| 'max_duration_reached'
|
|
229
228
|
| 'concurrency_limit_reached'
|
|
@@ -965,6 +964,11 @@ export namespace PhoneCallResponse {
|
|
|
965
964
|
* Tool call id, globally unique.
|
|
966
965
|
*/
|
|
967
966
|
tool_call_id: string;
|
|
967
|
+
|
|
968
|
+
/**
|
|
969
|
+
* Whether the tool call was successful.
|
|
970
|
+
*/
|
|
971
|
+
successful?: boolean;
|
|
968
972
|
}
|
|
969
973
|
|
|
970
974
|
export interface NodeTransitionUtterance {
|
|
@@ -1141,6 +1145,11 @@ export namespace PhoneCallResponse {
|
|
|
1141
1145
|
* Tool call id, globally unique.
|
|
1142
1146
|
*/
|
|
1143
1147
|
tool_call_id: string;
|
|
1148
|
+
|
|
1149
|
+
/**
|
|
1150
|
+
* Whether the tool call was successful.
|
|
1151
|
+
*/
|
|
1152
|
+
successful?: boolean;
|
|
1144
1153
|
}
|
|
1145
1154
|
|
|
1146
1155
|
export interface NodeTransitionUtterance {
|
|
@@ -1267,7 +1276,6 @@ export interface WebCallResponse {
|
|
|
1267
1276
|
| 'agent_hangup'
|
|
1268
1277
|
| 'call_transfer'
|
|
1269
1278
|
| 'voicemail_reached'
|
|
1270
|
-
| 'ivr_reached'
|
|
1271
1279
|
| 'inactivity'
|
|
1272
1280
|
| 'max_duration_reached'
|
|
1273
1281
|
| 'concurrency_limit_reached'
|
|
@@ -2003,6 +2011,11 @@ export namespace WebCallResponse {
|
|
|
2003
2011
|
* Tool call id, globally unique.
|
|
2004
2012
|
*/
|
|
2005
2013
|
tool_call_id: string;
|
|
2014
|
+
|
|
2015
|
+
/**
|
|
2016
|
+
* Whether the tool call was successful.
|
|
2017
|
+
*/
|
|
2018
|
+
successful?: boolean;
|
|
2006
2019
|
}
|
|
2007
2020
|
|
|
2008
2021
|
export interface NodeTransitionUtterance {
|
|
@@ -2168,6 +2181,11 @@ export namespace WebCallResponse {
|
|
|
2168
2181
|
* Tool call id, globally unique.
|
|
2169
2182
|
*/
|
|
2170
2183
|
tool_call_id: string;
|
|
2184
|
+
|
|
2185
|
+
/**
|
|
2186
|
+
* Whether the tool call was successful.
|
|
2187
|
+
*/
|
|
2188
|
+
successful?: boolean;
|
|
2171
2189
|
}
|
|
2172
2190
|
|
|
2173
2191
|
export interface NodeTransitionUtterance {
|
|
@@ -2314,7 +2332,6 @@ export namespace CallListParams {
|
|
|
2314
2332
|
| 'agent_hangup'
|
|
2315
2333
|
| 'call_transfer'
|
|
2316
2334
|
| 'voicemail_reached'
|
|
2317
|
-
| 'ivr_reached'
|
|
2318
2335
|
| 'inactivity'
|
|
2319
2336
|
| 'max_duration_reached'
|
|
2320
2337
|
| 'concurrency_limit_reached'
|
|
@@ -2589,6 +2606,13 @@ export namespace CallCreatePhoneCallParams {
|
|
|
2589
2606
|
*/
|
|
2590
2607
|
analysis_summary_prompt?: string | null;
|
|
2591
2608
|
|
|
2609
|
+
/**
|
|
2610
|
+
* Prompt to guide how the post call or chat analysis should evaluate user
|
|
2611
|
+
* sentiment. When unset, the default system prompt is used. Set to null to use the
|
|
2612
|
+
* default prompt.
|
|
2613
|
+
*/
|
|
2614
|
+
analysis_user_sentiment_prompt?: string | null;
|
|
2615
|
+
|
|
2592
2616
|
/**
|
|
2593
2617
|
* Only applicable when enable_backchannel is true. Controls how often the agent
|
|
2594
2618
|
* would backchannel when a backchannel is possible. Value ranging from [0,1].
|
|
@@ -2627,6 +2651,13 @@ export namespace CallCreatePhoneCallParams {
|
|
|
2627
2651
|
*/
|
|
2628
2652
|
custom_stt_config?: Agent.CustomSttConfig;
|
|
2629
2653
|
|
|
2654
|
+
/**
|
|
2655
|
+
* Number of days to retain call/chat data before automatic deletion. Must be
|
|
2656
|
+
* between 1 and 730 days. If not set, data is retained forever (no automatic
|
|
2657
|
+
* deletion).
|
|
2658
|
+
*/
|
|
2659
|
+
data_storage_retention_days?: number | null;
|
|
2660
|
+
|
|
2630
2661
|
/**
|
|
2631
2662
|
* Granular setting to manage how Retell stores sensitive data (transcripts,
|
|
2632
2663
|
* recordings, logs, etc.). This replaces the deprecated
|
|
@@ -2947,6 +2978,7 @@ export namespace CallCreatePhoneCallParams {
|
|
|
2947
2978
|
| 'gpt-4o-mini-tts'
|
|
2948
2979
|
| 'speech-02-turbo'
|
|
2949
2980
|
| 'speech-2.8-turbo'
|
|
2981
|
+
| 's1'
|
|
2950
2982
|
| null;
|
|
2951
2983
|
|
|
2952
2984
|
/**
|
|
@@ -3652,6 +3684,13 @@ export namespace CallCreateWebCallParams {
|
|
|
3652
3684
|
*/
|
|
3653
3685
|
analysis_summary_prompt?: string | null;
|
|
3654
3686
|
|
|
3687
|
+
/**
|
|
3688
|
+
* Prompt to guide how the post call or chat analysis should evaluate user
|
|
3689
|
+
* sentiment. When unset, the default system prompt is used. Set to null to use the
|
|
3690
|
+
* default prompt.
|
|
3691
|
+
*/
|
|
3692
|
+
analysis_user_sentiment_prompt?: string | null;
|
|
3693
|
+
|
|
3655
3694
|
/**
|
|
3656
3695
|
* Only applicable when enable_backchannel is true. Controls how often the agent
|
|
3657
3696
|
* would backchannel when a backchannel is possible. Value ranging from [0,1].
|
|
@@ -3690,6 +3729,13 @@ export namespace CallCreateWebCallParams {
|
|
|
3690
3729
|
*/
|
|
3691
3730
|
custom_stt_config?: Agent.CustomSttConfig;
|
|
3692
3731
|
|
|
3732
|
+
/**
|
|
3733
|
+
* Number of days to retain call/chat data before automatic deletion. Must be
|
|
3734
|
+
* between 1 and 730 days. If not set, data is retained forever (no automatic
|
|
3735
|
+
* deletion).
|
|
3736
|
+
*/
|
|
3737
|
+
data_storage_retention_days?: number | null;
|
|
3738
|
+
|
|
3693
3739
|
/**
|
|
3694
3740
|
* Granular setting to manage how Retell stores sensitive data (transcripts,
|
|
3695
3741
|
* recordings, logs, etc.). This replaces the deprecated
|
|
@@ -4010,6 +4056,7 @@ export namespace CallCreateWebCallParams {
|
|
|
4010
4056
|
| 'gpt-4o-mini-tts'
|
|
4011
4057
|
| 'speech-02-turbo'
|
|
4012
4058
|
| 'speech-2.8-turbo'
|
|
4059
|
+
| 's1'
|
|
4013
4060
|
| null;
|
|
4014
4061
|
|
|
4015
4062
|
/**
|
|
@@ -4729,6 +4776,13 @@ export namespace CallRegisterPhoneCallParams {
|
|
|
4729
4776
|
*/
|
|
4730
4777
|
analysis_summary_prompt?: string | null;
|
|
4731
4778
|
|
|
4779
|
+
/**
|
|
4780
|
+
* Prompt to guide how the post call or chat analysis should evaluate user
|
|
4781
|
+
* sentiment. When unset, the default system prompt is used. Set to null to use the
|
|
4782
|
+
* default prompt.
|
|
4783
|
+
*/
|
|
4784
|
+
analysis_user_sentiment_prompt?: string | null;
|
|
4785
|
+
|
|
4732
4786
|
/**
|
|
4733
4787
|
* Only applicable when enable_backchannel is true. Controls how often the agent
|
|
4734
4788
|
* would backchannel when a backchannel is possible. Value ranging from [0,1].
|
|
@@ -4767,6 +4821,13 @@ export namespace CallRegisterPhoneCallParams {
|
|
|
4767
4821
|
*/
|
|
4768
4822
|
custom_stt_config?: Agent.CustomSttConfig;
|
|
4769
4823
|
|
|
4824
|
+
/**
|
|
4825
|
+
* Number of days to retain call/chat data before automatic deletion. Must be
|
|
4826
|
+
* between 1 and 730 days. If not set, data is retained forever (no automatic
|
|
4827
|
+
* deletion).
|
|
4828
|
+
*/
|
|
4829
|
+
data_storage_retention_days?: number | null;
|
|
4830
|
+
|
|
4770
4831
|
/**
|
|
4771
4832
|
* Granular setting to manage how Retell stores sensitive data (transcripts,
|
|
4772
4833
|
* recordings, logs, etc.). This replaces the deprecated
|
|
@@ -5087,6 +5148,7 @@ export namespace CallRegisterPhoneCallParams {
|
|
|
5087
5148
|
| 'gpt-4o-mini-tts'
|
|
5088
5149
|
| 'speech-02-turbo'
|
|
5089
5150
|
| 'speech-2.8-turbo'
|
|
5151
|
+
| 's1'
|
|
5090
5152
|
| null;
|
|
5091
5153
|
|
|
5092
5154
|
/**
|
|
@@ -166,11 +166,24 @@ export interface ChatAgentResponse {
|
|
|
166
166
|
*/
|
|
167
167
|
analysis_summary_prompt?: string | null;
|
|
168
168
|
|
|
169
|
+
/**
|
|
170
|
+
* Prompt to guide how the post chat analysis should evaluate user sentiment. When
|
|
171
|
+
* unset, the default system prompt is used. Set to null to use the default prompt.
|
|
172
|
+
*/
|
|
173
|
+
analysis_user_sentiment_prompt?: string | null;
|
|
174
|
+
|
|
169
175
|
/**
|
|
170
176
|
* Message to display when the chat is automatically closed.
|
|
171
177
|
*/
|
|
172
178
|
auto_close_message?: string | null;
|
|
173
179
|
|
|
180
|
+
/**
|
|
181
|
+
* Number of days to retain call/chat data before automatic deletion. Must be
|
|
182
|
+
* between 1 and 730 days. If not set, data is retained forever (no automatic
|
|
183
|
+
* deletion).
|
|
184
|
+
*/
|
|
185
|
+
data_storage_retention_days?: number | null;
|
|
186
|
+
|
|
174
187
|
/**
|
|
175
188
|
* Controls what data is stored for this agent. "everything" stores all data
|
|
176
189
|
* including transcripts and recordings. "everything_except_pii" stores data but
|
|
@@ -542,11 +555,24 @@ export interface ChatAgentCreateParams {
|
|
|
542
555
|
*/
|
|
543
556
|
analysis_summary_prompt?: string | null;
|
|
544
557
|
|
|
558
|
+
/**
|
|
559
|
+
* Prompt to guide how the post chat analysis should evaluate user sentiment. When
|
|
560
|
+
* unset, the default system prompt is used. Set to null to use the default prompt.
|
|
561
|
+
*/
|
|
562
|
+
analysis_user_sentiment_prompt?: string | null;
|
|
563
|
+
|
|
545
564
|
/**
|
|
546
565
|
* Message to display when the chat is automatically closed.
|
|
547
566
|
*/
|
|
548
567
|
auto_close_message?: string | null;
|
|
549
568
|
|
|
569
|
+
/**
|
|
570
|
+
* Number of days to retain call/chat data before automatic deletion. Must be
|
|
571
|
+
* between 1 and 730 days. If not set, data is retained forever (no automatic
|
|
572
|
+
* deletion).
|
|
573
|
+
*/
|
|
574
|
+
data_storage_retention_days?: number | null;
|
|
575
|
+
|
|
550
576
|
/**
|
|
551
577
|
* Controls what data is stored for this agent. "everything" stores all data
|
|
552
578
|
* including transcripts and recordings. "everything_except_pii" stores data but
|
|
@@ -908,11 +934,25 @@ export interface ChatAgentUpdateParams {
|
|
|
908
934
|
*/
|
|
909
935
|
analysis_summary_prompt?: string | null;
|
|
910
936
|
|
|
937
|
+
/**
|
|
938
|
+
* Body param: Prompt to guide how the post chat analysis should evaluate user
|
|
939
|
+
* sentiment. When unset, the default system prompt is used. Set to null to use the
|
|
940
|
+
* default prompt.
|
|
941
|
+
*/
|
|
942
|
+
analysis_user_sentiment_prompt?: string | null;
|
|
943
|
+
|
|
911
944
|
/**
|
|
912
945
|
* Body param: Message to display when the chat is automatically closed.
|
|
913
946
|
*/
|
|
914
947
|
auto_close_message?: string | null;
|
|
915
948
|
|
|
949
|
+
/**
|
|
950
|
+
* Body param: Number of days to retain call/chat data before automatic deletion.
|
|
951
|
+
* Must be between 1 and 730 days. If not set, data is retained forever (no
|
|
952
|
+
* automatic deletion).
|
|
953
|
+
*/
|
|
954
|
+
data_storage_retention_days?: number | null;
|
|
955
|
+
|
|
916
956
|
/**
|
|
917
957
|
* Body param: Controls what data is stored for this agent. "everything" stores all
|
|
918
958
|
* data including transcripts and recordings. "everything_except_pii" stores data
|
package/src/resources/chat.ts
CHANGED
|
@@ -376,6 +376,11 @@ export namespace ChatResponse {
|
|
|
376
376
|
* Tool call id, globally unique.
|
|
377
377
|
*/
|
|
378
378
|
tool_call_id: string;
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* Whether the tool call was successful.
|
|
382
|
+
*/
|
|
383
|
+
successful?: boolean;
|
|
379
384
|
}
|
|
380
385
|
|
|
381
386
|
export interface NodeTransitionMessage {
|
|
@@ -546,6 +551,11 @@ export namespace ChatCreateChatCompletionResponse {
|
|
|
546
551
|
* Tool call id, globally unique.
|
|
547
552
|
*/
|
|
548
553
|
tool_call_id: string;
|
|
554
|
+
|
|
555
|
+
/**
|
|
556
|
+
* Whether the tool call was successful.
|
|
557
|
+
*/
|
|
558
|
+
successful?: boolean;
|
|
549
559
|
}
|
|
550
560
|
|
|
551
561
|
export interface NodeTransitionMessage {
|