@arbidocs/client 0.3.18 → 0.3.19

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/dist/index.d.cts CHANGED
@@ -1479,6 +1479,16 @@ interface components {
1479
1479
  * @description Lifecycle step (planning, answering, reviewing). Absent for tool calls.
1480
1480
  */
1481
1481
  step?: string | null;
1482
+ /**
1483
+ * Label
1484
+ * @description Display label for the step (e.g. 'Searching documents'). Backend-driven.
1485
+ */
1486
+ label?: string | null;
1487
+ /**
1488
+ * Icon
1489
+ * @description Lucide icon name for the step (e.g. 'search'). Backend-driven.
1490
+ */
1491
+ icon?: string | null;
1482
1492
  /**
1483
1493
  * Focus
1484
1494
  * @description Agent's current focus (single sentence). Present on tool call steps.
@@ -1498,8 +1508,23 @@ interface components {
1498
1508
  }[] | null;
1499
1509
  /** @description Token usage for the LLM call in this step. */
1500
1510
  usage?: components['schemas']['StepUsage'] | null;
1511
+ /**
1512
+ * Total Tokens
1513
+ * @description Cumulative total tokens across all steps in the agent loop.
1514
+ */
1515
+ total_tokens?: number | null;
1516
+ /**
1517
+ * Step Tokens
1518
+ * @description Per-step token cost (input + output + reasoning) for the LLM call that produced this step.
1519
+ */
1520
+ step_tokens?: number | null;
1501
1521
  /** @description Token budget context snapshot. Present when retrieval counts change. */
1502
1522
  context?: components['schemas']['TokenBudgetContext'] | null;
1523
+ /**
1524
+ * Outcome
1525
+ * @description Tool execution outcome (e.g. '15 chunks retrieved'). Sent as a follow-up event with the same index after tool execution.
1526
+ */
1527
+ outcome?: string | null;
1503
1528
  };
1504
1529
  /**
1505
1530
  * AgentsConfig
@@ -3220,6 +3245,23 @@ interface components {
3220
3245
  * @description End reference (page.chunk)
3221
3246
  */
3222
3247
  to_ref: string;
3248
+ /**
3249
+ * Label
3250
+ * @description Display label for the tool step
3251
+ * @default Reading document
3252
+ */
3253
+ label: string;
3254
+ /**
3255
+ * Icon
3256
+ * @description Lucide icon name for the tool step
3257
+ * @default file-text
3258
+ */
3259
+ icon: string;
3260
+ /**
3261
+ * Summary
3262
+ * @description Human-readable summary (e.g. 'Reading {doc-abc12345} pp. 5–10')
3263
+ */
3264
+ summary?: string | null;
3223
3265
  };
3224
3266
  /**
3225
3267
  * GetFullDocumentDetail
@@ -3259,6 +3301,23 @@ interface components {
3259
3301
  * @description Document external IDs
3260
3302
  */
3261
3303
  doc_ext_ids: string[];
3304
+ /**
3305
+ * Label
3306
+ * @description Display label for the tool step
3307
+ * @default Getting table of contents
3308
+ */
3309
+ label: string;
3310
+ /**
3311
+ * Icon
3312
+ * @description Lucide icon name for the tool step
3313
+ * @default list
3314
+ */
3315
+ icon: string;
3316
+ /**
3317
+ * Summary
3318
+ * @description Human-readable summary (e.g. 'Table of contents: {doc-abc12345}')
3319
+ */
3320
+ summary?: string | null;
3262
3321
  };
3263
3322
  /** HTTPValidationError */
3264
3323
  HTTPValidationError: {
@@ -5150,6 +5209,23 @@ interface components {
5150
5209
  * @description Search mode: hybrid, semantic, keyword
5151
5210
  */
5152
5211
  search_mode: string;
5212
+ /**
5213
+ * Label
5214
+ * @description Display label for the tool step
5215
+ * @default Searching documents
5216
+ */
5217
+ label: string;
5218
+ /**
5219
+ * Icon
5220
+ * @description Lucide icon name for the tool step
5221
+ * @default search
5222
+ */
5223
+ icon: string;
5224
+ /**
5225
+ * Summary
5226
+ * @description Human-readable summary (e.g. 'Search: "query" (hybrid)')
5227
+ */
5228
+ summary?: string | null;
5153
5229
  };
5154
5230
  /**
5155
5231
  * SearchMode
package/dist/index.d.ts CHANGED
@@ -1479,6 +1479,16 @@ interface components {
1479
1479
  * @description Lifecycle step (planning, answering, reviewing). Absent for tool calls.
1480
1480
  */
1481
1481
  step?: string | null;
1482
+ /**
1483
+ * Label
1484
+ * @description Display label for the step (e.g. 'Searching documents'). Backend-driven.
1485
+ */
1486
+ label?: string | null;
1487
+ /**
1488
+ * Icon
1489
+ * @description Lucide icon name for the step (e.g. 'search'). Backend-driven.
1490
+ */
1491
+ icon?: string | null;
1482
1492
  /**
1483
1493
  * Focus
1484
1494
  * @description Agent's current focus (single sentence). Present on tool call steps.
@@ -1498,8 +1508,23 @@ interface components {
1498
1508
  }[] | null;
1499
1509
  /** @description Token usage for the LLM call in this step. */
1500
1510
  usage?: components['schemas']['StepUsage'] | null;
1511
+ /**
1512
+ * Total Tokens
1513
+ * @description Cumulative total tokens across all steps in the agent loop.
1514
+ */
1515
+ total_tokens?: number | null;
1516
+ /**
1517
+ * Step Tokens
1518
+ * @description Per-step token cost (input + output + reasoning) for the LLM call that produced this step.
1519
+ */
1520
+ step_tokens?: number | null;
1501
1521
  /** @description Token budget context snapshot. Present when retrieval counts change. */
1502
1522
  context?: components['schemas']['TokenBudgetContext'] | null;
1523
+ /**
1524
+ * Outcome
1525
+ * @description Tool execution outcome (e.g. '15 chunks retrieved'). Sent as a follow-up event with the same index after tool execution.
1526
+ */
1527
+ outcome?: string | null;
1503
1528
  };
1504
1529
  /**
1505
1530
  * AgentsConfig
@@ -3220,6 +3245,23 @@ interface components {
3220
3245
  * @description End reference (page.chunk)
3221
3246
  */
3222
3247
  to_ref: string;
3248
+ /**
3249
+ * Label
3250
+ * @description Display label for the tool step
3251
+ * @default Reading document
3252
+ */
3253
+ label: string;
3254
+ /**
3255
+ * Icon
3256
+ * @description Lucide icon name for the tool step
3257
+ * @default file-text
3258
+ */
3259
+ icon: string;
3260
+ /**
3261
+ * Summary
3262
+ * @description Human-readable summary (e.g. 'Reading {doc-abc12345} pp. 5–10')
3263
+ */
3264
+ summary?: string | null;
3223
3265
  };
3224
3266
  /**
3225
3267
  * GetFullDocumentDetail
@@ -3259,6 +3301,23 @@ interface components {
3259
3301
  * @description Document external IDs
3260
3302
  */
3261
3303
  doc_ext_ids: string[];
3304
+ /**
3305
+ * Label
3306
+ * @description Display label for the tool step
3307
+ * @default Getting table of contents
3308
+ */
3309
+ label: string;
3310
+ /**
3311
+ * Icon
3312
+ * @description Lucide icon name for the tool step
3313
+ * @default list
3314
+ */
3315
+ icon: string;
3316
+ /**
3317
+ * Summary
3318
+ * @description Human-readable summary (e.g. 'Table of contents: {doc-abc12345}')
3319
+ */
3320
+ summary?: string | null;
3262
3321
  };
3263
3322
  /** HTTPValidationError */
3264
3323
  HTTPValidationError: {
@@ -5150,6 +5209,23 @@ interface components {
5150
5209
  * @description Search mode: hybrid, semantic, keyword
5151
5210
  */
5152
5211
  search_mode: string;
5212
+ /**
5213
+ * Label
5214
+ * @description Display label for the tool step
5215
+ * @default Searching documents
5216
+ */
5217
+ label: string;
5218
+ /**
5219
+ * Icon
5220
+ * @description Lucide icon name for the tool step
5221
+ * @default search
5222
+ */
5223
+ icon: string;
5224
+ /**
5225
+ * Summary
5226
+ * @description Human-readable summary (e.g. 'Search: "query" (hybrid)')
5227
+ */
5228
+ summary?: string | null;
5153
5229
  };
5154
5230
  /**
5155
5231
  * SearchMode
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arbidocs/client",
3
- "version": "0.3.18",
3
+ "version": "0.3.19",
4
4
  "description": "TypeScript SDK for the ARBI API — zero-knowledge auth, E2E encryption, and type-safe REST client",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",