@talqing/sdk 0.5.0 → 0.6.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.
@@ -1358,7 +1358,7 @@ export type CallDetailResponse = {
1358
1358
  /**
1359
1359
  * Transcript
1360
1360
  */
1361
- transcript: Array<TranscriptItemResponse>;
1361
+ transcript: Array<ConversationItemResponse>;
1362
1362
  usage: UsageResponse;
1363
1363
  /**
1364
1364
  * Vars
@@ -1773,6 +1773,27 @@ export type CatalogResponse = {
1773
1773
  turn_detector_languages: Array<LanguageOption>;
1774
1774
  };
1775
1775
 
1776
+ /**
1777
+ * ChatDetailResponse
1778
+ *
1779
+ * One chat with what explains it: health, priced lines, vars and trace.
1780
+ */
1781
+ export type ChatDetailResponse = {
1782
+ chat: ChatResponse;
1783
+ cost: CostDetailResponse | null;
1784
+ /**
1785
+ * Events
1786
+ */
1787
+ events: Array<SessionEventResponse>;
1788
+ snapshot: HealthSnapshotResponse;
1789
+ /**
1790
+ * Vars
1791
+ */
1792
+ vars: {
1793
+ [key: string]: string;
1794
+ };
1795
+ };
1796
+
1776
1797
  /**
1777
1798
  * ChatMessageRequest
1778
1799
  *
@@ -2083,7 +2104,7 @@ export type ConversationItemResponse = {
2083
2104
  /**
2084
2105
  * Agent Version
2085
2106
  */
2086
- agent_version: number | null;
2107
+ agent_version: number | 'draft' | null;
2087
2108
  /**
2088
2109
  * Attachments
2089
2110
  */
@@ -2113,6 +2134,7 @@ export type ConversationItemResponse = {
2113
2134
  * Id
2114
2135
  */
2115
2136
  id: string;
2137
+ latency: ReplyLatency | null;
2116
2138
  /**
2117
2139
  * Metadata
2118
2140
  */
@@ -2120,6 +2142,10 @@ export type ConversationItemResponse = {
2120
2142
  [key: string]: unknown;
2121
2143
  };
2122
2144
  metrics: TurnMetrics | null;
2145
+ /**
2146
+ * Origin
2147
+ */
2148
+ origin: 'speech' | 'typed' | 'keypad' | null;
2123
2149
  /**
2124
2150
  * Provider Message Id
2125
2151
  */
@@ -2281,14 +2307,16 @@ export type ConversationResponse = {
2281
2307
  * One agent execution within a conversation: a call, or a chat.
2282
2308
  */
2283
2309
  export type ConversationSessionResponse = {
2310
+ agent: AgentMetadata;
2284
2311
  /**
2285
- * Agent Id
2312
+ * Agent Version
2286
2313
  */
2287
- agent_id: string | null;
2314
+ agent_version: number | 'draft' | null;
2288
2315
  /**
2289
2316
  * Agent Version Id
2290
2317
  */
2291
2318
  agent_version_id: string | null;
2319
+ analysis: AnalysisResponse;
2292
2320
  /**
2293
2321
  * Channel
2294
2322
  */
@@ -2297,6 +2325,10 @@ export type ConversationSessionResponse = {
2297
2325
  * Close Reason
2298
2326
  */
2299
2327
  close_reason: string | null;
2328
+ /**
2329
+ * Close Reason Label
2330
+ */
2331
+ close_reason_label: string | null;
2300
2332
  /**
2301
2333
  * Conversation Id
2302
2334
  */
@@ -2305,11 +2337,15 @@ export type ConversationSessionResponse = {
2305
2337
  * Conversation Ref Id
2306
2338
  */
2307
2339
  conversation_ref_id: string | null;
2308
- cost: SessionCostResponse | null;
2340
+ cost: CostResponse | null;
2309
2341
  /**
2310
2342
  * Created At
2311
2343
  */
2312
2344
  created_at: string;
2345
+ /**
2346
+ * Duration S
2347
+ */
2348
+ duration_s: number | null;
2313
2349
  /**
2314
2350
  * Ended At
2315
2351
  */
@@ -2324,18 +2360,6 @@ export type ConversationSessionResponse = {
2324
2360
  */
2325
2361
  integration_id: string | null;
2326
2362
  metrics: SessionMetrics;
2327
- /**
2328
- * Outcome
2329
- */
2330
- outcome: 'success' | 'failure' | 'unknown' | null;
2331
- /**
2332
- * Output Item Ids
2333
- */
2334
- output_item_ids: Array<string>;
2335
- /**
2336
- * Session Id
2337
- */
2338
- session_id: string | null;
2339
2363
  /**
2340
2364
  * Started At
2341
2365
  */
@@ -2344,18 +2368,10 @@ export type ConversationSessionResponse = {
2344
2368
  * Status
2345
2369
  */
2346
2370
  status: string;
2347
- /**
2348
- * Summary
2349
- */
2350
- summary: string | null;
2351
2371
  /**
2352
2372
  * Trigger Id
2353
2373
  */
2354
2374
  trigger_id: string | null;
2355
- /**
2356
- * Trigger Item Ids
2357
- */
2358
- trigger_item_ids: Array<string>;
2359
2375
  /**
2360
2376
  * Type
2361
2377
  */
@@ -2443,6 +2459,48 @@ export type ConversationSpecOverride = {
2443
2459
  summary_limit?: number | null;
2444
2460
  };
2445
2461
 
2462
+ /**
2463
+ * ConversationTraceEventResponse
2464
+ *
2465
+ * One trace row of a conversation, and the session it belongs to.
2466
+ */
2467
+ export type ConversationTraceEventResponse = {
2468
+ /**
2469
+ * Created At
2470
+ */
2471
+ created_at: string;
2472
+ /**
2473
+ * Payload
2474
+ */
2475
+ payload: {
2476
+ [key: string]: unknown;
2477
+ };
2478
+ /**
2479
+ * Seq
2480
+ */
2481
+ seq: number;
2482
+ /**
2483
+ * Session Id
2484
+ */
2485
+ session_id: string;
2486
+ /**
2487
+ * Type
2488
+ */
2489
+ type: string;
2490
+ };
2491
+
2492
+ /**
2493
+ * ConversationTraceResponse
2494
+ *
2495
+ * A conversation's trace over one window, oldest first.
2496
+ */
2497
+ export type ConversationTraceResponse = {
2498
+ /**
2499
+ * Events
2500
+ */
2501
+ events: Array<ConversationTraceEventResponse>;
2502
+ };
2503
+
2446
2504
  /**
2447
2505
  * CopilotFunctionCallItem
2448
2506
  *
@@ -4389,6 +4447,22 @@ export type HandoffTarget = {
4389
4447
  summary_prompt?: string | null;
4390
4448
  };
4391
4449
 
4450
+ /**
4451
+ * HealthIssue
4452
+ *
4453
+ * One problem found, and what kind it is.
4454
+ */
4455
+ export type HealthIssue = {
4456
+ /**
4457
+ * Kind
4458
+ */
4459
+ kind: 'failed' | 'never_ready' | 'provider_errors' | 'provider_failover' | 'tool_failures' | 'tools_unfinished' | 'slow_tools' | 'slow_responses' | 'slow_after_filler' | 'connection' | 'noise_cancellation' | 'unpriceable';
4460
+ /**
4461
+ * Message
4462
+ */
4463
+ message: string;
4464
+ };
4465
+
4392
4466
  /**
4393
4467
  * HealthResponse
4394
4468
  *
@@ -4438,10 +4512,6 @@ export type HealthSnapshotResponse = {
4438
4512
  * Duration Seconds
4439
4513
  */
4440
4514
  duration_seconds: number | null;
4441
- /**
4442
- * End Of Turn Avg Ms
4443
- */
4444
- end_of_turn_avg_ms: number | null;
4445
4515
  /**
4446
4516
  * Errors
4447
4517
  */
@@ -4465,7 +4535,7 @@ export type HealthSnapshotResponse = {
4465
4535
  /**
4466
4536
  * Issues
4467
4537
  */
4468
- issues: Array<string>;
4538
+ issues: Array<HealthIssue>;
4469
4539
  /**
4470
4540
  * Noise Cancellation Failed
4471
4541
  */
@@ -4492,6 +4562,14 @@ export type HealthSnapshotResponse = {
4492
4562
  */
4493
4563
  providers: Array<string>;
4494
4564
  response_latency: LatencyStats;
4565
+ /**
4566
+ * Response Stages
4567
+ */
4568
+ response_stages: Array<LatencyStage>;
4569
+ /**
4570
+ * Slow Replies After Filler
4571
+ */
4572
+ slow_replies_after_filler: number;
4495
4573
  /**
4496
4574
  * Slow Response Threshold Ms
4497
4575
  */
@@ -4528,18 +4606,6 @@ export type HealthSnapshotResponse = {
4528
4606
  * Total Cost Usd
4529
4607
  */
4530
4608
  total_cost_usd: number | null;
4531
- /**
4532
- * Transcription Avg Ms
4533
- */
4534
- transcription_avg_ms: number | null;
4535
- /**
4536
- * Ttfb Avg Ms
4537
- */
4538
- ttfb_avg_ms: number | null;
4539
- /**
4540
- * Ttft Avg Ms
4541
- */
4542
- ttft_avg_ms: number | null;
4543
4609
  /**
4544
4610
  * Tts Audio Ms
4545
4611
  */
@@ -5236,7 +5302,7 @@ export type ItemCreatedEvent = {
5236
5302
  /**
5237
5303
  * Agent Version
5238
5304
  */
5239
- agent_version: number | null;
5305
+ agent_version: number | 'draft' | null;
5240
5306
  /**
5241
5307
  * Attachments
5242
5308
  */
@@ -5270,6 +5336,7 @@ export type ItemCreatedEvent = {
5270
5336
  * Id
5271
5337
  */
5272
5338
  id: string;
5339
+ latency: ReplyLatency | null;
5273
5340
  /**
5274
5341
  * Metadata
5275
5342
  */
@@ -5277,6 +5344,10 @@ export type ItemCreatedEvent = {
5277
5344
  [key: string]: unknown;
5278
5345
  };
5279
5346
  metrics: TurnMetrics | null;
5347
+ /**
5348
+ * Origin
5349
+ */
5350
+ origin: 'speech' | 'typed' | 'keypad' | null;
5280
5351
  /**
5281
5352
  * Provider Message Id
5282
5353
  */
@@ -6124,6 +6195,26 @@ export type LanguageOption = {
6124
6195
  name: string;
6125
6196
  };
6126
6197
 
6198
+ /**
6199
+ * LatencyStage
6200
+ *
6201
+ * One leg of a wait: what the time went on.
6202
+ */
6203
+ export type LatencyStage = {
6204
+ /**
6205
+ * Kind
6206
+ */
6207
+ kind: 'stt' | 'endpoint' | 'hook' | 'llm_step' | 'tool' | 'llm' | 'tts' | 'other';
6208
+ /**
6209
+ * Label
6210
+ */
6211
+ label: string;
6212
+ /**
6213
+ * Ms
6214
+ */
6215
+ ms: number;
6216
+ };
6217
+
6127
6218
  /**
6128
6219
  * LatencyStats
6129
6220
  */
@@ -9314,6 +9405,26 @@ export type RemoteNumber = {
9314
9405
  provider_number_id?: string | null;
9315
9406
  };
9316
9407
 
9408
+ /**
9409
+ * ReplyLatency
9410
+ *
9411
+ * How long the caller waited for this reply, in the order it was spent.
9412
+ */
9413
+ export type ReplyLatency = {
9414
+ /**
9415
+ * Kind
9416
+ */
9417
+ kind: 'response' | 'reply' | 'after_filler';
9418
+ /**
9419
+ * Stages
9420
+ */
9421
+ stages: Array<LatencyStage>;
9422
+ /**
9423
+ * Total Ms
9424
+ */
9425
+ total_ms: number;
9426
+ };
9427
+
9317
9428
  /**
9318
9429
  * RunStepResponse
9319
9430
  *
@@ -9899,30 +10010,6 @@ export type SendWhatsAppBatchRequest = {
9899
10010
  window?: TimeWindow | null;
9900
10011
  };
9901
10012
 
9902
- /**
9903
- * SessionCostResponse
9904
- *
9905
- * Priced money columns for one session. Absent when billing has not run.
9906
- */
9907
- export type SessionCostResponse = {
9908
- /**
9909
- * Duration S
9910
- */
9911
- duration_s?: number | null;
9912
- /**
9913
- * Platform Fee
9914
- */
9915
- platform_fee: number;
9916
- /**
9917
- * Provider Cost
9918
- */
9919
- provider_cost: number;
9920
- /**
9921
- * Total Charge
9922
- */
9923
- total_charge: number;
9924
- };
9925
-
9926
10013
  /**
9927
10014
  * SessionError
9928
10015
  *
@@ -9975,6 +10062,7 @@ export type SessionEventResponse = {
9975
10062
  * Latency averages are milliseconds over every message that reported the
9976
10063
  * metric (same rule as call detail / workspace observability). Turn-level
9977
10064
  * samples live on conversation_items.metrics for workspace daily aggregates.
10065
+ * On a chat, `e2e_latency` is a message arriving → the first token back.
9978
10066
  */
9979
10067
  export type SessionMetrics = {
9980
10068
  /**
@@ -11638,52 +11726,6 @@ export type TraceStepResponse = {
11638
11726
  truncated?: boolean;
11639
11727
  };
11640
11728
 
11641
- /**
11642
- * TranscriptItemResponse
11643
- */
11644
- export type TranscriptItemResponse = {
11645
- /**
11646
- * Agent Id
11647
- */
11648
- agent_id: string | null;
11649
- /**
11650
- * Agent Version
11651
- */
11652
- agent_version: number | 'draft' | null;
11653
- /**
11654
- * Attachments
11655
- */
11656
- attachments: Array<ConversationAttachment>;
11657
- /**
11658
- * Data
11659
- */
11660
- data: {
11661
- [key: string]: unknown;
11662
- } | null;
11663
- /**
11664
- * Id
11665
- */
11666
- id: string;
11667
- /**
11668
- * Item Id
11669
- */
11670
- item_id: string;
11671
- /**
11672
- * Metrics
11673
- */
11674
- metrics: {
11675
- [key: string]: unknown;
11676
- } | null;
11677
- /**
11678
- * Timestamp
11679
- */
11680
- timestamp: string;
11681
- /**
11682
- * Type
11683
- */
11684
- type: 'message' | 'function_call' | 'function_call_output' | 'agent_handoff' | 'agent_config_update';
11685
- };
11686
-
11687
11729
  /**
11688
11730
  * TransferConfig
11689
11731
  */
@@ -15113,6 +15155,156 @@ export type ChatsGetResults = {
15113
15155
 
15114
15156
  export type ChatsGetResult = ChatsGetResults[keyof ChatsGetResults];
15115
15157
 
15158
+ export type ChatsAnalysisRerunData = {
15159
+ body?: never;
15160
+ path: {
15161
+ /**
15162
+ * Chat Id
15163
+ */
15164
+ chat_id: string;
15165
+ };
15166
+ query?: never;
15167
+ url: '/v1/chats/{chat_id}/analysis';
15168
+ };
15169
+
15170
+ export type ChatsAnalysisRerunErrors = {
15171
+ /**
15172
+ * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
15173
+ */
15174
+ 400: ErrorResponse;
15175
+ /**
15176
+ * Missing credential, or one that is revoked or no longer a member of this organization.
15177
+ */
15178
+ 401: ErrorResponse;
15179
+ /**
15180
+ * Authenticated, but this organization role may not perform the operation.
15181
+ */
15182
+ 403: ErrorResponse;
15183
+ /**
15184
+ * No such resource in this organization.
15185
+ */
15186
+ 404: ErrorResponse;
15187
+ /**
15188
+ * The resource's current state forbids this — a name already taken, a job already running.
15189
+ */
15190
+ 409: ErrorResponse;
15191
+ /**
15192
+ * The request did not match this operation's schema; `detail.errors` lists each field.
15193
+ */
15194
+ 422: ErrorResponse;
15195
+ /**
15196
+ * Unexpected error. Every error this API returns carries this body.
15197
+ */
15198
+ default: ErrorResponse;
15199
+ };
15200
+
15201
+ export type ChatsAnalysisRerunError = ChatsAnalysisRerunErrors[keyof ChatsAnalysisRerunErrors];
15202
+
15203
+ export type ChatsAnalysisRerunResults = {
15204
+ /**
15205
+ * Successful Response
15206
+ */
15207
+ 200: ChatResponse;
15208
+ };
15209
+
15210
+ export type ChatsAnalysisRerunResult = ChatsAnalysisRerunResults[keyof ChatsAnalysisRerunResults];
15211
+
15212
+ export type ChatsAnalysisPreviewData = {
15213
+ body: PreviewAnalysisRequest;
15214
+ path: {
15215
+ /**
15216
+ * Chat Id
15217
+ */
15218
+ chat_id: string;
15219
+ };
15220
+ query?: never;
15221
+ url: '/v1/chats/{chat_id}/analysis/preview';
15222
+ };
15223
+
15224
+ export type ChatsAnalysisPreviewErrors = {
15225
+ /**
15226
+ * Well-formed, but rejected by a rule; `detail.errors` lists each problem.
15227
+ */
15228
+ 400: ErrorResponse;
15229
+ /**
15230
+ * Missing credential, or one that is revoked or no longer a member of this organization.
15231
+ */
15232
+ 401: ErrorResponse;
15233
+ /**
15234
+ * Authenticated, but this organization role may not perform the operation.
15235
+ */
15236
+ 403: ErrorResponse;
15237
+ /**
15238
+ * No such resource in this organization.
15239
+ */
15240
+ 404: ErrorResponse;
15241
+ /**
15242
+ * The resource's current state forbids this — a name already taken, a job already running.
15243
+ */
15244
+ 409: ErrorResponse;
15245
+ /**
15246
+ * The request did not match this operation's schema; `detail.errors` lists each field.
15247
+ */
15248
+ 422: ErrorResponse;
15249
+ /**
15250
+ * Unexpected error. Every error this API returns carries this body.
15251
+ */
15252
+ default: ErrorResponse;
15253
+ };
15254
+
15255
+ export type ChatsAnalysisPreviewError = ChatsAnalysisPreviewErrors[keyof ChatsAnalysisPreviewErrors];
15256
+
15257
+ export type ChatsAnalysisPreviewResults = {
15258
+ /**
15259
+ * Successful Response
15260
+ */
15261
+ 200: PreviewAnalysisResponse;
15262
+ };
15263
+
15264
+ export type ChatsAnalysisPreviewResult = ChatsAnalysisPreviewResults[keyof ChatsAnalysisPreviewResults];
15265
+
15266
+ export type ChatsDetailData = {
15267
+ body?: never;
15268
+ path: {
15269
+ /**
15270
+ * Chat Id
15271
+ */
15272
+ chat_id: string;
15273
+ };
15274
+ query?: never;
15275
+ url: '/v1/chats/{chat_id}/detail';
15276
+ };
15277
+
15278
+ export type ChatsDetailErrors = {
15279
+ /**
15280
+ * Missing credential, or one that is revoked or no longer a member of this organization.
15281
+ */
15282
+ 401: ErrorResponse;
15283
+ /**
15284
+ * No such resource in this organization.
15285
+ */
15286
+ 404: ErrorResponse;
15287
+ /**
15288
+ * The request did not match this operation's schema; `detail.errors` lists each field.
15289
+ */
15290
+ 422: ErrorResponse;
15291
+ /**
15292
+ * Unexpected error. Every error this API returns carries this body.
15293
+ */
15294
+ default: ErrorResponse;
15295
+ };
15296
+
15297
+ export type ChatsDetailError = ChatsDetailErrors[keyof ChatsDetailErrors];
15298
+
15299
+ export type ChatsDetailResults = {
15300
+ /**
15301
+ * Successful Response
15302
+ */
15303
+ 200: ChatDetailResponse;
15304
+ };
15305
+
15306
+ export type ChatsDetailResult = ChatsDetailResults[keyof ChatsDetailResults];
15307
+
15116
15308
  export type ChatsEndData = {
15117
15309
  body?: never;
15118
15310
  path: {
@@ -15696,6 +15888,61 @@ export type ConversationsSnapshotResults = {
15696
15888
 
15697
15889
  export type ConversationsSnapshotResult = ConversationsSnapshotResults[keyof ConversationsSnapshotResults];
15698
15890
 
15891
+ export type ConversationsTraceData = {
15892
+ body?: never;
15893
+ path: {
15894
+ /**
15895
+ * Conversation Id
15896
+ */
15897
+ conversation_id: string;
15898
+ };
15899
+ query?: {
15900
+ /**
15901
+ * After
15902
+ *
15903
+ * Only events at or after this.
15904
+ */
15905
+ after?: string | null;
15906
+ /**
15907
+ * Before
15908
+ *
15909
+ * Only events before this.
15910
+ */
15911
+ before?: string | null;
15912
+ };
15913
+ url: '/v1/conversations/{conversation_id}/trace';
15914
+ };
15915
+
15916
+ export type ConversationsTraceErrors = {
15917
+ /**
15918
+ * Missing credential, or one that is revoked or no longer a member of this organization.
15919
+ */
15920
+ 401: ErrorResponse;
15921
+ /**
15922
+ * No such resource in this organization.
15923
+ */
15924
+ 404: ErrorResponse;
15925
+ /**
15926
+ * The request did not match this operation's schema; `detail.errors` lists each field.
15927
+ */
15928
+ 422: ErrorResponse;
15929
+ /**
15930
+ * Unexpected error. Every error this API returns carries this body.
15931
+ */
15932
+ default: ErrorResponse;
15933
+ };
15934
+
15935
+ export type ConversationsTraceError = ConversationsTraceErrors[keyof ConversationsTraceErrors];
15936
+
15937
+ export type ConversationsTraceResults = {
15938
+ /**
15939
+ * Successful Response
15940
+ */
15941
+ 200: ConversationTraceResponse;
15942
+ };
15943
+
15944
+ export type ConversationsTraceResult = ConversationsTraceResults[keyof ConversationsTraceResults];
15945
+
15699
15946
  export type CopilotAgentsSendData = {
15700
15947
  body: SendMessageRequest;
15701
15948
  path: {