retell-sdk 4.32.0 → 4.34.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 +39 -0
- package/README.md +24 -36
- package/package.json +1 -1
- package/resources/agent.d.ts +3 -3
- package/resources/agent.d.ts.map +1 -1
- package/resources/call.d.ts +17 -1
- package/resources/call.d.ts.map +1 -1
- package/resources/call.js +1 -1
- package/resources/call.mjs +1 -1
- package/resources/chat.d.ts +3 -1
- package/resources/chat.d.ts.map +1 -1
- package/resources/llm.d.ts +324 -126
- package/resources/llm.d.ts.map +1 -1
- package/src/resources/agent.ts +6 -0
- package/src/resources/call.ts +19 -1
- package/src/resources/chat.ts +3 -1
- package/src/resources/llm.ts +402 -156
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/resources/llm.d.ts
CHANGED
|
@@ -174,25 +174,13 @@ export declare namespace LlmResponse {
|
|
|
174
174
|
*/
|
|
175
175
|
name: string;
|
|
176
176
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
177
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
177
178
|
type: 'transfer_call';
|
|
178
179
|
/**
|
|
179
180
|
* Describes what the tool does, sometimes can also include information about when
|
|
180
181
|
* to call the tool.
|
|
181
182
|
*/
|
|
182
183
|
description?: string;
|
|
183
|
-
/**
|
|
184
|
-
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
185
|
-
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
186
|
-
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
187
|
-
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
188
|
-
*/
|
|
189
|
-
show_transferee_as_caller?: boolean | null;
|
|
190
|
-
/**
|
|
191
|
-
* If set, when transfer is successful, will perform a warm handoff. Can leave
|
|
192
|
-
* either a static message or a dynamic one based on prompt. Set to null to disable
|
|
193
|
-
* warm handoff.
|
|
194
|
-
*/
|
|
195
|
-
warm_transfer_option?: TransferCallTool.WarmTransferPrompt | TransferCallTool.WarmTransferStaticMessage | null;
|
|
196
184
|
}
|
|
197
185
|
namespace TransferCallTool {
|
|
198
186
|
interface TransferDestinationPredefined {
|
|
@@ -218,19 +206,46 @@ export declare namespace LlmResponse {
|
|
|
218
206
|
*/
|
|
219
207
|
type: 'inferred';
|
|
220
208
|
}
|
|
221
|
-
interface
|
|
209
|
+
interface TransferOptionColdTransfer {
|
|
210
|
+
/**
|
|
211
|
+
* The type of the transfer.
|
|
212
|
+
*/
|
|
213
|
+
type: 'cold_transfer';
|
|
222
214
|
/**
|
|
223
|
-
*
|
|
215
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
216
|
+
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
217
|
+
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
218
|
+
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
224
219
|
*/
|
|
225
|
-
|
|
226
|
-
type?: 'prompt';
|
|
220
|
+
show_transferee_as_caller?: boolean;
|
|
227
221
|
}
|
|
228
|
-
interface
|
|
222
|
+
interface TransferOptionWarmTransfer {
|
|
223
|
+
/**
|
|
224
|
+
* The type of the transfer.
|
|
225
|
+
*/
|
|
226
|
+
type: 'warm_transfer';
|
|
229
227
|
/**
|
|
230
|
-
*
|
|
228
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
229
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
230
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
231
231
|
*/
|
|
232
|
-
|
|
233
|
-
|
|
232
|
+
public_handoff_option?: TransferOptionWarmTransfer.WarmTransferPrompt | TransferOptionWarmTransfer.WarmTransferStaticMessage;
|
|
233
|
+
}
|
|
234
|
+
namespace TransferOptionWarmTransfer {
|
|
235
|
+
interface WarmTransferPrompt {
|
|
236
|
+
/**
|
|
237
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
238
|
+
*/
|
|
239
|
+
prompt?: string;
|
|
240
|
+
type?: 'prompt';
|
|
241
|
+
}
|
|
242
|
+
interface WarmTransferStaticMessage {
|
|
243
|
+
/**
|
|
244
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
245
|
+
*/
|
|
246
|
+
message?: string;
|
|
247
|
+
type?: 'static_message';
|
|
248
|
+
}
|
|
234
249
|
}
|
|
235
250
|
}
|
|
236
251
|
interface CheckAvailabilityCalTool {
|
|
@@ -355,6 +370,14 @@ export declare namespace LlmResponse {
|
|
|
355
370
|
* tool. Make sure it fits into the conversation smoothly.".
|
|
356
371
|
*/
|
|
357
372
|
execution_message_description?: string;
|
|
373
|
+
/**
|
|
374
|
+
* Headers to add to the request.
|
|
375
|
+
*/
|
|
376
|
+
headers?: Record<string, string>;
|
|
377
|
+
/**
|
|
378
|
+
* Method to use for the request, default to POST.
|
|
379
|
+
*/
|
|
380
|
+
method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
358
381
|
/**
|
|
359
382
|
* The parameters the functions accepts, described as a JSON Schema object. See
|
|
360
383
|
* [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
|
|
@@ -362,6 +385,16 @@ export declare namespace LlmResponse {
|
|
|
362
385
|
* empty parameter list.
|
|
363
386
|
*/
|
|
364
387
|
parameters?: CustomTool.Parameters;
|
|
388
|
+
/**
|
|
389
|
+
* Query parameters to append to the request URL.
|
|
390
|
+
*/
|
|
391
|
+
query_params?: Record<string, string>;
|
|
392
|
+
/**
|
|
393
|
+
* A mapping of variable names to JSON paths in the response body. These values
|
|
394
|
+
* will be extracted from the response and made available as dynamic variables for
|
|
395
|
+
* use.
|
|
396
|
+
*/
|
|
397
|
+
response_variables?: Record<string, string>;
|
|
365
398
|
/**
|
|
366
399
|
* The maximum time in milliseconds the tool can run before it's considered
|
|
367
400
|
* timeout. If the tool times out, the agent would have that info. The minimum
|
|
@@ -495,25 +528,13 @@ export declare namespace LlmResponse {
|
|
|
495
528
|
*/
|
|
496
529
|
name: string;
|
|
497
530
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
531
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
498
532
|
type: 'transfer_call';
|
|
499
533
|
/**
|
|
500
534
|
* Describes what the tool does, sometimes can also include information about when
|
|
501
535
|
* to call the tool.
|
|
502
536
|
*/
|
|
503
537
|
description?: string;
|
|
504
|
-
/**
|
|
505
|
-
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
506
|
-
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
507
|
-
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
508
|
-
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
509
|
-
*/
|
|
510
|
-
show_transferee_as_caller?: boolean | null;
|
|
511
|
-
/**
|
|
512
|
-
* If set, when transfer is successful, will perform a warm handoff. Can leave
|
|
513
|
-
* either a static message or a dynamic one based on prompt. Set to null to disable
|
|
514
|
-
* warm handoff.
|
|
515
|
-
*/
|
|
516
|
-
warm_transfer_option?: TransferCallTool.WarmTransferPrompt | TransferCallTool.WarmTransferStaticMessage | null;
|
|
517
538
|
}
|
|
518
539
|
namespace TransferCallTool {
|
|
519
540
|
interface TransferDestinationPredefined {
|
|
@@ -539,19 +560,46 @@ export declare namespace LlmResponse {
|
|
|
539
560
|
*/
|
|
540
561
|
type: 'inferred';
|
|
541
562
|
}
|
|
542
|
-
interface
|
|
563
|
+
interface TransferOptionColdTransfer {
|
|
543
564
|
/**
|
|
544
|
-
* The
|
|
565
|
+
* The type of the transfer.
|
|
545
566
|
*/
|
|
546
|
-
|
|
547
|
-
|
|
567
|
+
type: 'cold_transfer';
|
|
568
|
+
/**
|
|
569
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
570
|
+
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
571
|
+
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
572
|
+
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
573
|
+
*/
|
|
574
|
+
show_transferee_as_caller?: boolean;
|
|
548
575
|
}
|
|
549
|
-
interface
|
|
576
|
+
interface TransferOptionWarmTransfer {
|
|
550
577
|
/**
|
|
551
|
-
* The
|
|
578
|
+
* The type of the transfer.
|
|
552
579
|
*/
|
|
553
|
-
|
|
554
|
-
|
|
580
|
+
type: 'warm_transfer';
|
|
581
|
+
/**
|
|
582
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
583
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
584
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
585
|
+
*/
|
|
586
|
+
public_handoff_option?: TransferOptionWarmTransfer.WarmTransferPrompt | TransferOptionWarmTransfer.WarmTransferStaticMessage;
|
|
587
|
+
}
|
|
588
|
+
namespace TransferOptionWarmTransfer {
|
|
589
|
+
interface WarmTransferPrompt {
|
|
590
|
+
/**
|
|
591
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
592
|
+
*/
|
|
593
|
+
prompt?: string;
|
|
594
|
+
type?: 'prompt';
|
|
595
|
+
}
|
|
596
|
+
interface WarmTransferStaticMessage {
|
|
597
|
+
/**
|
|
598
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
599
|
+
*/
|
|
600
|
+
message?: string;
|
|
601
|
+
type?: 'static_message';
|
|
602
|
+
}
|
|
555
603
|
}
|
|
556
604
|
}
|
|
557
605
|
interface CheckAvailabilityCalTool {
|
|
@@ -676,6 +724,14 @@ export declare namespace LlmResponse {
|
|
|
676
724
|
* tool. Make sure it fits into the conversation smoothly.".
|
|
677
725
|
*/
|
|
678
726
|
execution_message_description?: string;
|
|
727
|
+
/**
|
|
728
|
+
* Headers to add to the request.
|
|
729
|
+
*/
|
|
730
|
+
headers?: Record<string, string>;
|
|
731
|
+
/**
|
|
732
|
+
* Method to use for the request, default to POST.
|
|
733
|
+
*/
|
|
734
|
+
method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
679
735
|
/**
|
|
680
736
|
* The parameters the functions accepts, described as a JSON Schema object. See
|
|
681
737
|
* [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
|
|
@@ -683,6 +739,16 @@ export declare namespace LlmResponse {
|
|
|
683
739
|
* empty parameter list.
|
|
684
740
|
*/
|
|
685
741
|
parameters?: CustomTool.Parameters;
|
|
742
|
+
/**
|
|
743
|
+
* Query parameters to append to the request URL.
|
|
744
|
+
*/
|
|
745
|
+
query_params?: Record<string, string>;
|
|
746
|
+
/**
|
|
747
|
+
* A mapping of variable names to JSON paths in the response body. These values
|
|
748
|
+
* will be extracted from the response and made available as dynamic variables for
|
|
749
|
+
* use.
|
|
750
|
+
*/
|
|
751
|
+
response_variables?: Record<string, string>;
|
|
686
752
|
/**
|
|
687
753
|
* The maximum time in milliseconds the tool can run before it's considered
|
|
688
754
|
* timeout. If the tool times out, the agent would have that info. The minimum
|
|
@@ -823,25 +889,13 @@ export declare namespace LlmCreateParams {
|
|
|
823
889
|
*/
|
|
824
890
|
name: string;
|
|
825
891
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
892
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
826
893
|
type: 'transfer_call';
|
|
827
894
|
/**
|
|
828
895
|
* Describes what the tool does, sometimes can also include information about when
|
|
829
896
|
* to call the tool.
|
|
830
897
|
*/
|
|
831
898
|
description?: string;
|
|
832
|
-
/**
|
|
833
|
-
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
834
|
-
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
835
|
-
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
836
|
-
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
837
|
-
*/
|
|
838
|
-
show_transferee_as_caller?: boolean | null;
|
|
839
|
-
/**
|
|
840
|
-
* If set, when transfer is successful, will perform a warm handoff. Can leave
|
|
841
|
-
* either a static message or a dynamic one based on prompt. Set to null to disable
|
|
842
|
-
* warm handoff.
|
|
843
|
-
*/
|
|
844
|
-
warm_transfer_option?: TransferCallTool.WarmTransferPrompt | TransferCallTool.WarmTransferStaticMessage | null;
|
|
845
899
|
}
|
|
846
900
|
namespace TransferCallTool {
|
|
847
901
|
interface TransferDestinationPredefined {
|
|
@@ -867,19 +921,46 @@ export declare namespace LlmCreateParams {
|
|
|
867
921
|
*/
|
|
868
922
|
type: 'inferred';
|
|
869
923
|
}
|
|
870
|
-
interface
|
|
924
|
+
interface TransferOptionColdTransfer {
|
|
925
|
+
/**
|
|
926
|
+
* The type of the transfer.
|
|
927
|
+
*/
|
|
928
|
+
type: 'cold_transfer';
|
|
871
929
|
/**
|
|
872
|
-
*
|
|
930
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
931
|
+
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
932
|
+
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
933
|
+
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
873
934
|
*/
|
|
874
|
-
|
|
875
|
-
type?: 'prompt';
|
|
935
|
+
show_transferee_as_caller?: boolean;
|
|
876
936
|
}
|
|
877
|
-
interface
|
|
937
|
+
interface TransferOptionWarmTransfer {
|
|
938
|
+
/**
|
|
939
|
+
* The type of the transfer.
|
|
940
|
+
*/
|
|
941
|
+
type: 'warm_transfer';
|
|
878
942
|
/**
|
|
879
|
-
*
|
|
943
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
944
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
945
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
880
946
|
*/
|
|
881
|
-
|
|
882
|
-
|
|
947
|
+
public_handoff_option?: TransferOptionWarmTransfer.WarmTransferPrompt | TransferOptionWarmTransfer.WarmTransferStaticMessage;
|
|
948
|
+
}
|
|
949
|
+
namespace TransferOptionWarmTransfer {
|
|
950
|
+
interface WarmTransferPrompt {
|
|
951
|
+
/**
|
|
952
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
953
|
+
*/
|
|
954
|
+
prompt?: string;
|
|
955
|
+
type?: 'prompt';
|
|
956
|
+
}
|
|
957
|
+
interface WarmTransferStaticMessage {
|
|
958
|
+
/**
|
|
959
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
960
|
+
*/
|
|
961
|
+
message?: string;
|
|
962
|
+
type?: 'static_message';
|
|
963
|
+
}
|
|
883
964
|
}
|
|
884
965
|
}
|
|
885
966
|
interface CheckAvailabilityCalTool {
|
|
@@ -1004,6 +1085,14 @@ export declare namespace LlmCreateParams {
|
|
|
1004
1085
|
* tool. Make sure it fits into the conversation smoothly.".
|
|
1005
1086
|
*/
|
|
1006
1087
|
execution_message_description?: string;
|
|
1088
|
+
/**
|
|
1089
|
+
* Headers to add to the request.
|
|
1090
|
+
*/
|
|
1091
|
+
headers?: Record<string, string>;
|
|
1092
|
+
/**
|
|
1093
|
+
* Method to use for the request, default to POST.
|
|
1094
|
+
*/
|
|
1095
|
+
method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
1007
1096
|
/**
|
|
1008
1097
|
* The parameters the functions accepts, described as a JSON Schema object. See
|
|
1009
1098
|
* [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
|
|
@@ -1011,6 +1100,16 @@ export declare namespace LlmCreateParams {
|
|
|
1011
1100
|
* empty parameter list.
|
|
1012
1101
|
*/
|
|
1013
1102
|
parameters?: CustomTool.Parameters;
|
|
1103
|
+
/**
|
|
1104
|
+
* Query parameters to append to the request URL.
|
|
1105
|
+
*/
|
|
1106
|
+
query_params?: Record<string, string>;
|
|
1107
|
+
/**
|
|
1108
|
+
* A mapping of variable names to JSON paths in the response body. These values
|
|
1109
|
+
* will be extracted from the response and made available as dynamic variables for
|
|
1110
|
+
* use.
|
|
1111
|
+
*/
|
|
1112
|
+
response_variables?: Record<string, string>;
|
|
1014
1113
|
/**
|
|
1015
1114
|
* The maximum time in milliseconds the tool can run before it's considered
|
|
1016
1115
|
* timeout. If the tool times out, the agent would have that info. The minimum
|
|
@@ -1144,25 +1243,13 @@ export declare namespace LlmCreateParams {
|
|
|
1144
1243
|
*/
|
|
1145
1244
|
name: string;
|
|
1146
1245
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
1246
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
1147
1247
|
type: 'transfer_call';
|
|
1148
1248
|
/**
|
|
1149
1249
|
* Describes what the tool does, sometimes can also include information about when
|
|
1150
1250
|
* to call the tool.
|
|
1151
1251
|
*/
|
|
1152
1252
|
description?: string;
|
|
1153
|
-
/**
|
|
1154
|
-
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
1155
|
-
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
1156
|
-
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
1157
|
-
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
1158
|
-
*/
|
|
1159
|
-
show_transferee_as_caller?: boolean | null;
|
|
1160
|
-
/**
|
|
1161
|
-
* If set, when transfer is successful, will perform a warm handoff. Can leave
|
|
1162
|
-
* either a static message or a dynamic one based on prompt. Set to null to disable
|
|
1163
|
-
* warm handoff.
|
|
1164
|
-
*/
|
|
1165
|
-
warm_transfer_option?: TransferCallTool.WarmTransferPrompt | TransferCallTool.WarmTransferStaticMessage | null;
|
|
1166
1253
|
}
|
|
1167
1254
|
namespace TransferCallTool {
|
|
1168
1255
|
interface TransferDestinationPredefined {
|
|
@@ -1188,19 +1275,46 @@ export declare namespace LlmCreateParams {
|
|
|
1188
1275
|
*/
|
|
1189
1276
|
type: 'inferred';
|
|
1190
1277
|
}
|
|
1191
|
-
interface
|
|
1278
|
+
interface TransferOptionColdTransfer {
|
|
1192
1279
|
/**
|
|
1193
|
-
* The
|
|
1280
|
+
* The type of the transfer.
|
|
1194
1281
|
*/
|
|
1195
|
-
|
|
1196
|
-
|
|
1282
|
+
type: 'cold_transfer';
|
|
1283
|
+
/**
|
|
1284
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
1285
|
+
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
1286
|
+
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
1287
|
+
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
1288
|
+
*/
|
|
1289
|
+
show_transferee_as_caller?: boolean;
|
|
1197
1290
|
}
|
|
1198
|
-
interface
|
|
1291
|
+
interface TransferOptionWarmTransfer {
|
|
1199
1292
|
/**
|
|
1200
|
-
* The
|
|
1293
|
+
* The type of the transfer.
|
|
1201
1294
|
*/
|
|
1202
|
-
|
|
1203
|
-
|
|
1295
|
+
type: 'warm_transfer';
|
|
1296
|
+
/**
|
|
1297
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
1298
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
1299
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
1300
|
+
*/
|
|
1301
|
+
public_handoff_option?: TransferOptionWarmTransfer.WarmTransferPrompt | TransferOptionWarmTransfer.WarmTransferStaticMessage;
|
|
1302
|
+
}
|
|
1303
|
+
namespace TransferOptionWarmTransfer {
|
|
1304
|
+
interface WarmTransferPrompt {
|
|
1305
|
+
/**
|
|
1306
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
1307
|
+
*/
|
|
1308
|
+
prompt?: string;
|
|
1309
|
+
type?: 'prompt';
|
|
1310
|
+
}
|
|
1311
|
+
interface WarmTransferStaticMessage {
|
|
1312
|
+
/**
|
|
1313
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
1314
|
+
*/
|
|
1315
|
+
message?: string;
|
|
1316
|
+
type?: 'static_message';
|
|
1317
|
+
}
|
|
1204
1318
|
}
|
|
1205
1319
|
}
|
|
1206
1320
|
interface CheckAvailabilityCalTool {
|
|
@@ -1325,6 +1439,14 @@ export declare namespace LlmCreateParams {
|
|
|
1325
1439
|
* tool. Make sure it fits into the conversation smoothly.".
|
|
1326
1440
|
*/
|
|
1327
1441
|
execution_message_description?: string;
|
|
1442
|
+
/**
|
|
1443
|
+
* Headers to add to the request.
|
|
1444
|
+
*/
|
|
1445
|
+
headers?: Record<string, string>;
|
|
1446
|
+
/**
|
|
1447
|
+
* Method to use for the request, default to POST.
|
|
1448
|
+
*/
|
|
1449
|
+
method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
1328
1450
|
/**
|
|
1329
1451
|
* The parameters the functions accepts, described as a JSON Schema object. See
|
|
1330
1452
|
* [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
|
|
@@ -1332,6 +1454,16 @@ export declare namespace LlmCreateParams {
|
|
|
1332
1454
|
* empty parameter list.
|
|
1333
1455
|
*/
|
|
1334
1456
|
parameters?: CustomTool.Parameters;
|
|
1457
|
+
/**
|
|
1458
|
+
* Query parameters to append to the request URL.
|
|
1459
|
+
*/
|
|
1460
|
+
query_params?: Record<string, string>;
|
|
1461
|
+
/**
|
|
1462
|
+
* A mapping of variable names to JSON paths in the response body. These values
|
|
1463
|
+
* will be extracted from the response and made available as dynamic variables for
|
|
1464
|
+
* use.
|
|
1465
|
+
*/
|
|
1466
|
+
response_variables?: Record<string, string>;
|
|
1335
1467
|
/**
|
|
1336
1468
|
* The maximum time in milliseconds the tool can run before it's considered
|
|
1337
1469
|
* timeout. If the tool times out, the agent would have that info. The minimum
|
|
@@ -1485,25 +1617,13 @@ export declare namespace LlmUpdateParams {
|
|
|
1485
1617
|
*/
|
|
1486
1618
|
name: string;
|
|
1487
1619
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
1620
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
1488
1621
|
type: 'transfer_call';
|
|
1489
1622
|
/**
|
|
1490
1623
|
* Describes what the tool does, sometimes can also include information about when
|
|
1491
1624
|
* to call the tool.
|
|
1492
1625
|
*/
|
|
1493
1626
|
description?: string;
|
|
1494
|
-
/**
|
|
1495
|
-
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
1496
|
-
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
1497
|
-
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
1498
|
-
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
1499
|
-
*/
|
|
1500
|
-
show_transferee_as_caller?: boolean | null;
|
|
1501
|
-
/**
|
|
1502
|
-
* If set, when transfer is successful, will perform a warm handoff. Can leave
|
|
1503
|
-
* either a static message or a dynamic one based on prompt. Set to null to disable
|
|
1504
|
-
* warm handoff.
|
|
1505
|
-
*/
|
|
1506
|
-
warm_transfer_option?: TransferCallTool.WarmTransferPrompt | TransferCallTool.WarmTransferStaticMessage | null;
|
|
1507
1627
|
}
|
|
1508
1628
|
namespace TransferCallTool {
|
|
1509
1629
|
interface TransferDestinationPredefined {
|
|
@@ -1529,19 +1649,46 @@ export declare namespace LlmUpdateParams {
|
|
|
1529
1649
|
*/
|
|
1530
1650
|
type: 'inferred';
|
|
1531
1651
|
}
|
|
1532
|
-
interface
|
|
1652
|
+
interface TransferOptionColdTransfer {
|
|
1533
1653
|
/**
|
|
1534
|
-
* The
|
|
1654
|
+
* The type of the transfer.
|
|
1535
1655
|
*/
|
|
1536
|
-
|
|
1537
|
-
|
|
1656
|
+
type: 'cold_transfer';
|
|
1657
|
+
/**
|
|
1658
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
1659
|
+
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
1660
|
+
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
1661
|
+
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
1662
|
+
*/
|
|
1663
|
+
show_transferee_as_caller?: boolean;
|
|
1538
1664
|
}
|
|
1539
|
-
interface
|
|
1665
|
+
interface TransferOptionWarmTransfer {
|
|
1540
1666
|
/**
|
|
1541
|
-
* The
|
|
1667
|
+
* The type of the transfer.
|
|
1542
1668
|
*/
|
|
1543
|
-
|
|
1544
|
-
|
|
1669
|
+
type: 'warm_transfer';
|
|
1670
|
+
/**
|
|
1671
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
1672
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
1673
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
1674
|
+
*/
|
|
1675
|
+
public_handoff_option?: TransferOptionWarmTransfer.WarmTransferPrompt | TransferOptionWarmTransfer.WarmTransferStaticMessage;
|
|
1676
|
+
}
|
|
1677
|
+
namespace TransferOptionWarmTransfer {
|
|
1678
|
+
interface WarmTransferPrompt {
|
|
1679
|
+
/**
|
|
1680
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
1681
|
+
*/
|
|
1682
|
+
prompt?: string;
|
|
1683
|
+
type?: 'prompt';
|
|
1684
|
+
}
|
|
1685
|
+
interface WarmTransferStaticMessage {
|
|
1686
|
+
/**
|
|
1687
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
1688
|
+
*/
|
|
1689
|
+
message?: string;
|
|
1690
|
+
type?: 'static_message';
|
|
1691
|
+
}
|
|
1545
1692
|
}
|
|
1546
1693
|
}
|
|
1547
1694
|
interface CheckAvailabilityCalTool {
|
|
@@ -1666,6 +1813,14 @@ export declare namespace LlmUpdateParams {
|
|
|
1666
1813
|
* tool. Make sure it fits into the conversation smoothly.".
|
|
1667
1814
|
*/
|
|
1668
1815
|
execution_message_description?: string;
|
|
1816
|
+
/**
|
|
1817
|
+
* Headers to add to the request.
|
|
1818
|
+
*/
|
|
1819
|
+
headers?: Record<string, string>;
|
|
1820
|
+
/**
|
|
1821
|
+
* Method to use for the request, default to POST.
|
|
1822
|
+
*/
|
|
1823
|
+
method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
1669
1824
|
/**
|
|
1670
1825
|
* The parameters the functions accepts, described as a JSON Schema object. See
|
|
1671
1826
|
* [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
|
|
@@ -1673,6 +1828,16 @@ export declare namespace LlmUpdateParams {
|
|
|
1673
1828
|
* empty parameter list.
|
|
1674
1829
|
*/
|
|
1675
1830
|
parameters?: CustomTool.Parameters;
|
|
1831
|
+
/**
|
|
1832
|
+
* Query parameters to append to the request URL.
|
|
1833
|
+
*/
|
|
1834
|
+
query_params?: Record<string, string>;
|
|
1835
|
+
/**
|
|
1836
|
+
* A mapping of variable names to JSON paths in the response body. These values
|
|
1837
|
+
* will be extracted from the response and made available as dynamic variables for
|
|
1838
|
+
* use.
|
|
1839
|
+
*/
|
|
1840
|
+
response_variables?: Record<string, string>;
|
|
1676
1841
|
/**
|
|
1677
1842
|
* The maximum time in milliseconds the tool can run before it's considered
|
|
1678
1843
|
* timeout. If the tool times out, the agent would have that info. The minimum
|
|
@@ -1806,25 +1971,13 @@ export declare namespace LlmUpdateParams {
|
|
|
1806
1971
|
*/
|
|
1807
1972
|
name: string;
|
|
1808
1973
|
transfer_destination: TransferCallTool.TransferDestinationPredefined | TransferCallTool.TransferDestinationInferred;
|
|
1974
|
+
transfer_option: TransferCallTool.TransferOptionColdTransfer | TransferCallTool.TransferOptionWarmTransfer;
|
|
1809
1975
|
type: 'transfer_call';
|
|
1810
1976
|
/**
|
|
1811
1977
|
* Describes what the tool does, sometimes can also include information about when
|
|
1812
1978
|
* to call the tool.
|
|
1813
1979
|
*/
|
|
1814
1980
|
description?: string;
|
|
1815
|
-
/**
|
|
1816
|
-
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
1817
|
-
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
1818
|
-
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
1819
|
-
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
1820
|
-
*/
|
|
1821
|
-
show_transferee_as_caller?: boolean | null;
|
|
1822
|
-
/**
|
|
1823
|
-
* If set, when transfer is successful, will perform a warm handoff. Can leave
|
|
1824
|
-
* either a static message or a dynamic one based on prompt. Set to null to disable
|
|
1825
|
-
* warm handoff.
|
|
1826
|
-
*/
|
|
1827
|
-
warm_transfer_option?: TransferCallTool.WarmTransferPrompt | TransferCallTool.WarmTransferStaticMessage | null;
|
|
1828
1981
|
}
|
|
1829
1982
|
namespace TransferCallTool {
|
|
1830
1983
|
interface TransferDestinationPredefined {
|
|
@@ -1850,19 +2003,46 @@ export declare namespace LlmUpdateParams {
|
|
|
1850
2003
|
*/
|
|
1851
2004
|
type: 'inferred';
|
|
1852
2005
|
}
|
|
1853
|
-
interface
|
|
2006
|
+
interface TransferOptionColdTransfer {
|
|
1854
2007
|
/**
|
|
1855
|
-
* The
|
|
2008
|
+
* The type of the transfer.
|
|
1856
2009
|
*/
|
|
1857
|
-
|
|
1858
|
-
|
|
2010
|
+
type: 'cold_transfer';
|
|
2011
|
+
/**
|
|
2012
|
+
* If set to true, will show transferee (the user, not the AI agent) as caller when
|
|
2013
|
+
* transferring, requires the telephony side to support SIP REFER to PSTN. This is
|
|
2014
|
+
* only applicable for cold transfer, so if warm transfer option is specified, this
|
|
2015
|
+
* field will be ignored. Default to false (default to show AI agent as caller).
|
|
2016
|
+
*/
|
|
2017
|
+
show_transferee_as_caller?: boolean;
|
|
1859
2018
|
}
|
|
1860
|
-
interface
|
|
2019
|
+
interface TransferOptionWarmTransfer {
|
|
1861
2020
|
/**
|
|
1862
|
-
* The
|
|
2021
|
+
* The type of the transfer.
|
|
1863
2022
|
*/
|
|
1864
|
-
|
|
1865
|
-
|
|
2023
|
+
type: 'warm_transfer';
|
|
2024
|
+
/**
|
|
2025
|
+
* If set, when transfer is successful, will say the handoff message to both the
|
|
2026
|
+
* transferee and the agent receiving the transfer. Can leave either a static
|
|
2027
|
+
* message or a dynamic one based on prompt. Set to null to disable warm handoff.
|
|
2028
|
+
*/
|
|
2029
|
+
public_handoff_option?: TransferOptionWarmTransfer.WarmTransferPrompt | TransferOptionWarmTransfer.WarmTransferStaticMessage;
|
|
2030
|
+
}
|
|
2031
|
+
namespace TransferOptionWarmTransfer {
|
|
2032
|
+
interface WarmTransferPrompt {
|
|
2033
|
+
/**
|
|
2034
|
+
* The prompt to be used for warm handoff. Can contain dynamic variables.
|
|
2035
|
+
*/
|
|
2036
|
+
prompt?: string;
|
|
2037
|
+
type?: 'prompt';
|
|
2038
|
+
}
|
|
2039
|
+
interface WarmTransferStaticMessage {
|
|
2040
|
+
/**
|
|
2041
|
+
* The static message to be used for warm handoff. Can contain dynamic variables.
|
|
2042
|
+
*/
|
|
2043
|
+
message?: string;
|
|
2044
|
+
type?: 'static_message';
|
|
2045
|
+
}
|
|
1866
2046
|
}
|
|
1867
2047
|
}
|
|
1868
2048
|
interface CheckAvailabilityCalTool {
|
|
@@ -1987,6 +2167,14 @@ export declare namespace LlmUpdateParams {
|
|
|
1987
2167
|
* tool. Make sure it fits into the conversation smoothly.".
|
|
1988
2168
|
*/
|
|
1989
2169
|
execution_message_description?: string;
|
|
2170
|
+
/**
|
|
2171
|
+
* Headers to add to the request.
|
|
2172
|
+
*/
|
|
2173
|
+
headers?: Record<string, string>;
|
|
2174
|
+
/**
|
|
2175
|
+
* Method to use for the request, default to POST.
|
|
2176
|
+
*/
|
|
2177
|
+
method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
1990
2178
|
/**
|
|
1991
2179
|
* The parameters the functions accepts, described as a JSON Schema object. See
|
|
1992
2180
|
* [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
|
|
@@ -1994,6 +2182,16 @@ export declare namespace LlmUpdateParams {
|
|
|
1994
2182
|
* empty parameter list.
|
|
1995
2183
|
*/
|
|
1996
2184
|
parameters?: CustomTool.Parameters;
|
|
2185
|
+
/**
|
|
2186
|
+
* Query parameters to append to the request URL.
|
|
2187
|
+
*/
|
|
2188
|
+
query_params?: Record<string, string>;
|
|
2189
|
+
/**
|
|
2190
|
+
* A mapping of variable names to JSON paths in the response body. These values
|
|
2191
|
+
* will be extracted from the response and made available as dynamic variables for
|
|
2192
|
+
* use.
|
|
2193
|
+
*/
|
|
2194
|
+
response_variables?: Record<string, string>;
|
|
1997
2195
|
/**
|
|
1998
2196
|
* The maximum time in milliseconds the tool can run before it's considered
|
|
1999
2197
|
* timeout. If the tool times out, the agent would have that info. The minimum
|