@knowledge-stack/ksapi 1.120.1 → 1.122.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.
Files changed (113) hide show
  1. package/.openapi-generator/FILES +22 -8
  2. package/README.md +13 -6
  3. package/dist/esm/models/CreateThreadMessageRequest.d.ts +3 -3
  4. package/dist/esm/models/CreateThreadMessageRequest.js +3 -3
  5. package/dist/esm/models/DocEditPart.d.ts +122 -0
  6. package/dist/esm/models/DocEditPart.js +92 -0
  7. package/dist/esm/models/Input.d.ts +41 -0
  8. package/dist/esm/models/Input.js +32 -0
  9. package/dist/esm/models/MessageUsage.d.ts +53 -0
  10. package/dist/esm/models/MessageUsage.js +57 -0
  11. package/dist/esm/models/ReasoningPart.d.ts +84 -0
  12. package/dist/esm/models/ReasoningPart.js +71 -0
  13. package/dist/esm/models/{StepInput.d.ts → Step.d.ts} +16 -22
  14. package/dist/esm/models/{StepInput.js → Step.js} +9 -11
  15. package/dist/esm/models/StepKind.d.ts +0 -1
  16. package/dist/esm/models/StepKind.js +1 -2
  17. package/dist/esm/models/TextPart.d.ts +91 -0
  18. package/dist/esm/models/TextPart.js +74 -0
  19. package/dist/esm/models/TextPartOrReasoningPartOrToolPartOrDocEditPart.d.ts +33 -0
  20. package/dist/esm/models/TextPartOrReasoningPartOrToolPartOrDocEditPart.js +57 -0
  21. package/dist/esm/models/ThreadMessageDetails.d.ts +75 -0
  22. package/dist/esm/models/ThreadMessageDetails.js +58 -0
  23. package/dist/esm/models/ThreadMessageResponse.d.ts +10 -3
  24. package/dist/esm/models/ThreadMessageResponse.js +6 -3
  25. package/dist/esm/models/ToolPart.d.ts +130 -0
  26. package/dist/esm/models/ToolPart.js +89 -0
  27. package/dist/esm/models/ToolStatus.d.ts +27 -0
  28. package/dist/esm/models/ToolStatus.js +45 -0
  29. package/dist/esm/models/WorkflowRunAsset.d.ts +87 -0
  30. package/dist/esm/models/WorkflowRunAsset.js +66 -0
  31. package/dist/esm/models/WorkflowRunResponse.d.ts +22 -3
  32. package/dist/esm/models/WorkflowRunResponse.js +12 -3
  33. package/dist/esm/models/index.d.ts +11 -4
  34. package/dist/esm/models/index.js +11 -4
  35. package/dist/models/CreateThreadMessageRequest.d.ts +3 -3
  36. package/dist/models/CreateThreadMessageRequest.js +3 -3
  37. package/dist/models/DocEditPart.d.ts +122 -0
  38. package/dist/models/DocEditPart.js +100 -0
  39. package/dist/models/Input.d.ts +41 -0
  40. package/dist/models/Input.js +40 -0
  41. package/dist/models/MessageUsage.d.ts +53 -0
  42. package/dist/models/MessageUsage.js +65 -0
  43. package/dist/models/ReasoningPart.d.ts +84 -0
  44. package/dist/models/ReasoningPart.js +79 -0
  45. package/dist/models/{StepInput.d.ts → Step.d.ts} +16 -22
  46. package/dist/models/{StepInput.js → Step.js} +15 -17
  47. package/dist/models/StepKind.d.ts +0 -1
  48. package/dist/models/StepKind.js +1 -2
  49. package/dist/models/TextPart.d.ts +91 -0
  50. package/dist/models/TextPart.js +82 -0
  51. package/dist/models/TextPartOrReasoningPartOrToolPartOrDocEditPart.d.ts +33 -0
  52. package/dist/models/TextPartOrReasoningPartOrToolPartOrDocEditPart.js +63 -0
  53. package/dist/models/ThreadMessageDetails.d.ts +75 -0
  54. package/dist/models/ThreadMessageDetails.js +66 -0
  55. package/dist/models/ThreadMessageResponse.d.ts +10 -3
  56. package/dist/models/ThreadMessageResponse.js +6 -3
  57. package/dist/models/ToolPart.d.ts +130 -0
  58. package/dist/models/ToolPart.js +97 -0
  59. package/dist/models/ToolStatus.d.ts +27 -0
  60. package/dist/models/ToolStatus.js +53 -0
  61. package/dist/models/WorkflowRunAsset.d.ts +87 -0
  62. package/dist/models/WorkflowRunAsset.js +74 -0
  63. package/dist/models/WorkflowRunResponse.d.ts +22 -3
  64. package/dist/models/WorkflowRunResponse.js +12 -3
  65. package/dist/models/index.d.ts +11 -4
  66. package/dist/models/index.js +11 -4
  67. package/docs/CreateThreadMessageRequest.md +1 -1
  68. package/docs/DocEditPart.md +54 -0
  69. package/docs/FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md +8 -2
  70. package/docs/{ThreadMessageDetailsInput.md → Input.md} +4 -10
  71. package/docs/MessageUsage.md +37 -0
  72. package/docs/{StepOutput.md → ReasoningPart.md} +10 -14
  73. package/docs/{StepInput.md → Step.md} +4 -6
  74. package/docs/TextPart.md +46 -0
  75. package/docs/TextPartOrReasoningPartOrToolPartOrDocEditPart.md +72 -0
  76. package/docs/{ThreadMessageDetailsOutput.md → ThreadMessageDetails.md} +9 -5
  77. package/docs/ThreadMessageResponse.md +3 -1
  78. package/docs/ToolPart.md +58 -0
  79. package/docs/ToolStatus.md +32 -0
  80. package/docs/WorkflowRunAsset.md +45 -0
  81. package/docs/WorkflowRunResponse.md +8 -2
  82. package/package.json +1 -1
  83. package/src/models/CreateThreadMessageRequest.ts +11 -11
  84. package/src/models/DocEditPart.ts +191 -0
  85. package/src/models/Input.ts +63 -0
  86. package/src/models/MessageUsage.ts +100 -0
  87. package/src/models/ReasoningPart.ts +140 -0
  88. package/src/models/{StepInput.ts → Step.ts} +18 -26
  89. package/src/models/StepKind.ts +1 -2
  90. package/src/models/TextPart.ts +156 -0
  91. package/src/models/TextPartOrReasoningPartOrToolPartOrDocEditPart.ts +94 -0
  92. package/src/models/ThreadMessageDetails.ts +146 -0
  93. package/src/models/ThreadMessageResponse.ts +25 -10
  94. package/src/models/ToolPart.ts +212 -0
  95. package/src/models/ToolStatus.ts +55 -0
  96. package/src/models/WorkflowRunAsset.ts +153 -0
  97. package/src/models/WorkflowRunResponse.ts +38 -6
  98. package/src/models/index.ts +11 -4
  99. package/dist/esm/models/StepOutput.d.ts +0 -91
  100. package/dist/esm/models/StepOutput.js +0 -66
  101. package/dist/esm/models/ThreadMessageDetailsInput.d.ts +0 -61
  102. package/dist/esm/models/ThreadMessageDetailsInput.js +0 -52
  103. package/dist/esm/models/ThreadMessageDetailsOutput.d.ts +0 -61
  104. package/dist/esm/models/ThreadMessageDetailsOutput.js +0 -52
  105. package/dist/models/StepOutput.d.ts +0 -91
  106. package/dist/models/StepOutput.js +0 -74
  107. package/dist/models/ThreadMessageDetailsInput.d.ts +0 -61
  108. package/dist/models/ThreadMessageDetailsInput.js +0 -60
  109. package/dist/models/ThreadMessageDetailsOutput.d.ts +0 -61
  110. package/dist/models/ThreadMessageDetailsOutput.js +0 -60
  111. package/src/models/StepOutput.ts +0 -159
  112. package/src/models/ThreadMessageDetailsInput.ts +0 -116
  113. package/src/models/ThreadMessageDetailsOutput.ts +0 -116
@@ -20,6 +20,7 @@ exports.WorkflowRunResponseFromJSONTyped = WorkflowRunResponseFromJSONTyped;
20
20
  exports.WorkflowRunResponseToJSON = WorkflowRunResponseToJSON;
21
21
  exports.WorkflowRunResponseToJSONTyped = WorkflowRunResponseToJSONTyped;
22
22
  const ItemPermissions_1 = require("./ItemPermissions");
23
+ const WorkflowRunAsset_1 = require("./WorkflowRunAsset");
23
24
  const WorkflowRunSnapshot_1 = require("./WorkflowRunSnapshot");
24
25
  const WorkflowExecutionState_1 = require("./WorkflowExecutionState");
25
26
  const ExcludedCommonFile_1 = require("./ExcludedCommonFile");
@@ -72,7 +73,9 @@ function instanceOfWorkflowRunResponse(value) {
72
73
  return false;
73
74
  if (!('discussionsPathPartId' in value) || value['discussionsPathPartId'] === undefined)
74
75
  return false;
75
- if (!('outputsPathPartIds' in value) || value['outputsPathPartIds'] === undefined)
76
+ if (!('inputsPath' in value) || value['inputsPath'] === undefined)
77
+ return false;
78
+ if (!('outputsPath' in value) || value['outputsPath'] === undefined)
76
79
  return false;
77
80
  if (!('createdAt' in value) || value['createdAt'] === undefined)
78
81
  return false;
@@ -109,7 +112,10 @@ function WorkflowRunResponseFromJSONTyped(json, ignoreDiscriminator) {
109
112
  'outputsPathPartId': json['outputs_path_part_id'],
110
113
  'discussionsPathPartId': json['discussions_path_part_id'],
111
114
  'inputPathPartIds': json['input_path_part_ids'] == null ? undefined : json['input_path_part_ids'],
112
- 'outputsPathPartIds': json['outputs_path_part_ids'],
115
+ 'outputAssets': json['output_assets'] == null ? undefined : (json['output_assets'].map(WorkflowRunAsset_1.WorkflowRunAssetFromJSON)),
116
+ 'inputAssets': json['input_assets'] == null ? undefined : (json['input_assets'].map(WorkflowRunAsset_1.WorkflowRunAssetFromJSON)),
117
+ 'inputsPath': json['inputs_path'],
118
+ 'outputsPath': json['outputs_path'],
113
119
  'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : (json['excluded_common_files'].map(ExcludedCommonFile_1.ExcludedCommonFileFromJSON)),
114
120
  'runThreadId': json['run_thread_id'] == null ? undefined : json['run_thread_id'],
115
121
  'owner': json['owner'] == null ? undefined : (0, UserInfo_1.UserInfoFromJSON)(json['owner']),
@@ -147,7 +153,10 @@ function WorkflowRunResponseToJSONTyped(value, ignoreDiscriminator = false) {
147
153
  'outputs_path_part_id': value['outputsPathPartId'],
148
154
  'discussions_path_part_id': value['discussionsPathPartId'],
149
155
  'input_path_part_ids': value['inputPathPartIds'],
150
- 'outputs_path_part_ids': value['outputsPathPartIds'],
156
+ 'output_assets': value['outputAssets'] == null ? undefined : (value['outputAssets'].map(WorkflowRunAsset_1.WorkflowRunAssetToJSON)),
157
+ 'input_assets': value['inputAssets'] == null ? undefined : (value['inputAssets'].map(WorkflowRunAsset_1.WorkflowRunAssetToJSON)),
158
+ 'inputs_path': value['inputsPath'],
159
+ 'outputs_path': value['outputsPath'],
151
160
  'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : (value['excludedCommonFiles'].map(ExcludedCommonFile_1.ExcludedCommonFileToJSON)),
152
161
  'run_thread_id': value['runThreadId'],
153
162
  'owner': (0, UserInfo_1.UserInfoToJSON)(value['owner']),
@@ -83,6 +83,7 @@ export * from './DiffSpan';
83
83
  export * from './DirectorySyncResponse';
84
84
  export * from './DisplayNameFormat';
85
85
  export * from './DissolveSectionResponse';
86
+ export * from './DocEditPart';
86
87
  export * from './DocumentBlockChange';
87
88
  export * from './DocumentCheckoutResponse';
88
89
  export * from './DocumentDiff';
@@ -133,6 +134,7 @@ export * from './ImageTaxonomy';
133
134
  export * from './InformationStatistics';
134
135
  export * from './IngestDocumentResponse';
135
136
  export * from './IngestionMode';
137
+ export * from './Input';
136
138
  export * from './InputOrigin';
137
139
  export * from './InputSnapshot';
138
140
  export * from './InstantiateWorkflowTemplateRequest';
@@ -154,6 +156,7 @@ export * from './MemoryChunkResponse';
154
156
  export * from './MemoryKind';
155
157
  export * from './MemoryScope';
156
158
  export * from './MessageRole';
159
+ export * from './MessageUsage';
157
160
  export * from './MeteredQuotaStatus';
158
161
  export * from './ModelTableRequest';
159
162
  export * from './ModelTableResult';
@@ -208,6 +211,7 @@ export * from './Polygon';
208
211
  export * from './PolygonReference';
209
212
  export * from './ProposeMemoryChunkRequest';
210
213
  export * from './ProposedMemoryChunkResponse';
214
+ export * from './ReasoningPart';
211
215
  export * from './ReferenceType';
212
216
  export * from './RequestPhoneChangeRequest';
213
217
  export * from './ResolvedReferenceInput';
@@ -232,9 +236,8 @@ export * from './SheetVisibilityChange';
232
236
  export * from './SignInRequest';
233
237
  export * from './SortDirection';
234
238
  export * from './StartWorkflowRunRequest';
235
- export * from './StepInput';
239
+ export * from './Step';
236
240
  export * from './StepKind';
237
- export * from './StepOutput';
238
241
  export * from './StructuredChange';
239
242
  export * from './StructuredChangeType';
240
243
  export * from './StructuredDiff';
@@ -260,12 +263,15 @@ export * from './TenantUserOrder';
260
263
  export * from './TenantUserResponse';
261
264
  export * from './TenantUserRole';
262
265
  export * from './TextDiff';
266
+ export * from './TextPart';
267
+ export * from './TextPartOrReasoningPartOrToolPartOrDocEditPart';
263
268
  export * from './ThreadMessageContent';
264
- export * from './ThreadMessageDetailsInput';
265
- export * from './ThreadMessageDetailsOutput';
269
+ export * from './ThreadMessageDetails';
266
270
  export * from './ThreadMessageResponse';
267
271
  export * from './ThreadOrder';
268
272
  export * from './ThreadResponse';
273
+ export * from './ToolPart';
274
+ export * from './ToolStatus';
269
275
  export * from './TransferOwnerRequest';
270
276
  export * from './TransferOwnerResponse';
271
277
  export * from './TrashItemResponse';
@@ -305,6 +311,7 @@ export * from './WorkflowDefinitionOrder';
305
311
  export * from './WorkflowDefinitionResponse';
306
312
  export * from './WorkflowDetailResponse';
307
313
  export * from './WorkflowExecutionState';
314
+ export * from './WorkflowRunAsset';
308
315
  export * from './WorkflowRunCallbackRequest';
309
316
  export * from './WorkflowRunOrder';
310
317
  export * from './WorkflowRunResponse';
@@ -101,6 +101,7 @@ __exportStar(require("./DiffSpan"), exports);
101
101
  __exportStar(require("./DirectorySyncResponse"), exports);
102
102
  __exportStar(require("./DisplayNameFormat"), exports);
103
103
  __exportStar(require("./DissolveSectionResponse"), exports);
104
+ __exportStar(require("./DocEditPart"), exports);
104
105
  __exportStar(require("./DocumentBlockChange"), exports);
105
106
  __exportStar(require("./DocumentCheckoutResponse"), exports);
106
107
  __exportStar(require("./DocumentDiff"), exports);
@@ -151,6 +152,7 @@ __exportStar(require("./ImageTaxonomy"), exports);
151
152
  __exportStar(require("./InformationStatistics"), exports);
152
153
  __exportStar(require("./IngestDocumentResponse"), exports);
153
154
  __exportStar(require("./IngestionMode"), exports);
155
+ __exportStar(require("./Input"), exports);
154
156
  __exportStar(require("./InputOrigin"), exports);
155
157
  __exportStar(require("./InputSnapshot"), exports);
156
158
  __exportStar(require("./InstantiateWorkflowTemplateRequest"), exports);
@@ -172,6 +174,7 @@ __exportStar(require("./MemoryChunkResponse"), exports);
172
174
  __exportStar(require("./MemoryKind"), exports);
173
175
  __exportStar(require("./MemoryScope"), exports);
174
176
  __exportStar(require("./MessageRole"), exports);
177
+ __exportStar(require("./MessageUsage"), exports);
175
178
  __exportStar(require("./MeteredQuotaStatus"), exports);
176
179
  __exportStar(require("./ModelTableRequest"), exports);
177
180
  __exportStar(require("./ModelTableResult"), exports);
@@ -226,6 +229,7 @@ __exportStar(require("./Polygon"), exports);
226
229
  __exportStar(require("./PolygonReference"), exports);
227
230
  __exportStar(require("./ProposeMemoryChunkRequest"), exports);
228
231
  __exportStar(require("./ProposedMemoryChunkResponse"), exports);
232
+ __exportStar(require("./ReasoningPart"), exports);
229
233
  __exportStar(require("./ReferenceType"), exports);
230
234
  __exportStar(require("./RequestPhoneChangeRequest"), exports);
231
235
  __exportStar(require("./ResolvedReferenceInput"), exports);
@@ -250,9 +254,8 @@ __exportStar(require("./SheetVisibilityChange"), exports);
250
254
  __exportStar(require("./SignInRequest"), exports);
251
255
  __exportStar(require("./SortDirection"), exports);
252
256
  __exportStar(require("./StartWorkflowRunRequest"), exports);
253
- __exportStar(require("./StepInput"), exports);
257
+ __exportStar(require("./Step"), exports);
254
258
  __exportStar(require("./StepKind"), exports);
255
- __exportStar(require("./StepOutput"), exports);
256
259
  __exportStar(require("./StructuredChange"), exports);
257
260
  __exportStar(require("./StructuredChangeType"), exports);
258
261
  __exportStar(require("./StructuredDiff"), exports);
@@ -278,12 +281,15 @@ __exportStar(require("./TenantUserOrder"), exports);
278
281
  __exportStar(require("./TenantUserResponse"), exports);
279
282
  __exportStar(require("./TenantUserRole"), exports);
280
283
  __exportStar(require("./TextDiff"), exports);
284
+ __exportStar(require("./TextPart"), exports);
285
+ __exportStar(require("./TextPartOrReasoningPartOrToolPartOrDocEditPart"), exports);
281
286
  __exportStar(require("./ThreadMessageContent"), exports);
282
- __exportStar(require("./ThreadMessageDetailsInput"), exports);
283
- __exportStar(require("./ThreadMessageDetailsOutput"), exports);
287
+ __exportStar(require("./ThreadMessageDetails"), exports);
284
288
  __exportStar(require("./ThreadMessageResponse"), exports);
285
289
  __exportStar(require("./ThreadOrder"), exports);
286
290
  __exportStar(require("./ThreadResponse"), exports);
291
+ __exportStar(require("./ToolPart"), exports);
292
+ __exportStar(require("./ToolStatus"), exports);
287
293
  __exportStar(require("./TransferOwnerRequest"), exports);
288
294
  __exportStar(require("./TransferOwnerResponse"), exports);
289
295
  __exportStar(require("./TrashItemResponse"), exports);
@@ -323,6 +329,7 @@ __exportStar(require("./WorkflowDefinitionOrder"), exports);
323
329
  __exportStar(require("./WorkflowDefinitionResponse"), exports);
324
330
  __exportStar(require("./WorkflowDetailResponse"), exports);
325
331
  __exportStar(require("./WorkflowExecutionState"), exports);
332
+ __exportStar(require("./WorkflowRunAsset"), exports);
326
333
  __exportStar(require("./WorkflowRunCallbackRequest"), exports);
327
334
  __exportStar(require("./WorkflowRunOrder"), exports);
328
335
  __exportStar(require("./WorkflowRunResponse"), exports);
@@ -9,7 +9,7 @@ Name | Type
9
9
  `messageId` | string
10
10
  `role` | [MessageRole](MessageRole.md)
11
11
  `content` | [ThreadMessageContent](ThreadMessageContent.md)
12
- `details` | [ThreadMessageDetailsInput](ThreadMessageDetailsInput.md)
12
+ `details` | [ThreadMessageDetails](ThreadMessageDetails.md)
13
13
 
14
14
  ## Example
15
15
 
@@ -0,0 +1,54 @@
1
+
2
+ # DocEditPart
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `seq` | number
11
+ `startTime` | Date
12
+ `endTime` | Date
13
+ `kind` | string
14
+ `toolCallId` | string
15
+ `documentId` | string
16
+ `baseVersionId` | string
17
+ `newVersionId` | string
18
+ `docFormat` | string
19
+ `approvalId` | string
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import type { DocEditPart } from '@knowledge-stack/ksapi'
25
+
26
+ // TODO: Update the object below with actual values
27
+ const example = {
28
+ "id": null,
29
+ "seq": null,
30
+ "startTime": null,
31
+ "endTime": null,
32
+ "kind": null,
33
+ "toolCallId": null,
34
+ "documentId": null,
35
+ "baseVersionId": null,
36
+ "newVersionId": null,
37
+ "docFormat": null,
38
+ "approvalId": null,
39
+ } satisfies DocEditPart
40
+
41
+ console.log(example)
42
+
43
+ // Convert the instance to a JSON string
44
+ const exampleJSON: string = JSON.stringify(example)
45
+ console.log(exampleJSON)
46
+
47
+ // Parse the JSON string back to an object
48
+ const exampleParsed = JSON.parse(exampleJSON) as DocEditPart
49
+ console.log(exampleParsed)
50
+ ```
51
+
52
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
53
+
54
+
@@ -48,7 +48,10 @@ Name | Type
48
48
  `outputsPathPartId` | string
49
49
  `discussionsPathPartId` | string
50
50
  `inputPathPartIds` | Array<string>
51
- `outputsPathPartIds` | Array<string>
51
+ `outputAssets` | [Array<WorkflowRunAsset>](WorkflowRunAsset.md)
52
+ `inputAssets` | [Array<WorkflowRunAsset>](WorkflowRunAsset.md)
53
+ `inputsPath` | string
54
+ `outputsPath` | string
52
55
  `excludedCommonFiles` | [Array<ExcludedCommonFile>](ExcludedCommonFile.md)
53
56
  `runThreadId` | string
54
57
  `engine` | [DataSourceEngine](DataSourceEngine.md)
@@ -115,7 +118,10 @@ const example = {
115
118
  "outputsPathPartId": null,
116
119
  "discussionsPathPartId": null,
117
120
  "inputPathPartIds": null,
118
- "outputsPathPartIds": null,
121
+ "outputAssets": null,
122
+ "inputAssets": null,
123
+ "inputsPath": null,
124
+ "outputsPath": null,
119
125
  "excludedCommonFiles": null,
120
126
  "runThreadId": null,
121
127
  "engine": null,
@@ -1,26 +1,20 @@
1
1
 
2
- # ThreadMessageDetailsInput
2
+ # Input
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `steps` | [Array<StepInput>](StepInput.md)
10
- `checkpoint` | [CheckpointDetails](CheckpointDetails.md)
11
- `modelId` | string
12
9
 
13
10
  ## Example
14
11
 
15
12
  ```typescript
16
- import type { ThreadMessageDetailsInput } from '@knowledge-stack/ksapi'
13
+ import type { Input } from '@knowledge-stack/ksapi'
17
14
 
18
15
  // TODO: Update the object below with actual values
19
16
  const example = {
20
- "steps": null,
21
- "checkpoint": null,
22
- "modelId": null,
23
- } satisfies ThreadMessageDetailsInput
17
+ } satisfies Input
24
18
 
25
19
  console.log(example)
26
20
 
@@ -29,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
29
23
  console.log(exampleJSON)
30
24
 
31
25
  // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as ThreadMessageDetailsInput
26
+ const exampleParsed = JSON.parse(exampleJSON) as Input
33
27
  console.log(exampleParsed)
34
28
  ```
35
29
 
@@ -0,0 +1,37 @@
1
+
2
+ # MessageUsage
3
+
4
+ Token counts only — the run\'s model lives on ``details.model_id``.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `inputTokens` | number
11
+ `outputTokens` | number
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { MessageUsage } from '@knowledge-stack/ksapi'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "inputTokens": null,
21
+ "outputTokens": null,
22
+ } satisfies MessageUsage
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as MessageUsage
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+
@@ -1,5 +1,5 @@
1
1
 
2
- # StepOutput
2
+ # ReasoningPart
3
3
 
4
4
 
5
5
  ## Properties
@@ -7,30 +7,26 @@
7
7
  Name | Type
8
8
  ------------ | -------------
9
9
  `id` | string
10
- `name` | string
11
- `kind` | [StepKind](StepKind.md)
12
- `args` | [Args](Args.md)
13
- `detail` | string
10
+ `seq` | number
14
11
  `startTime` | Date
15
12
  `endTime` | Date
16
- `steps` | [Array<StepOutput>](StepOutput.md)
13
+ `kind` | string
14
+ `text` | string
17
15
 
18
16
  ## Example
19
17
 
20
18
  ```typescript
21
- import type { StepOutput } from '@knowledge-stack/ksapi'
19
+ import type { ReasoningPart } from '@knowledge-stack/ksapi'
22
20
 
23
21
  // TODO: Update the object below with actual values
24
22
  const example = {
25
23
  "id": null,
26
- "name": null,
27
- "kind": null,
28
- "args": null,
29
- "detail": null,
24
+ "seq": null,
30
25
  "startTime": null,
31
26
  "endTime": null,
32
- "steps": null,
33
- } satisfies StepOutput
27
+ "kind": null,
28
+ "text": null,
29
+ } satisfies ReasoningPart
34
30
 
35
31
  console.log(example)
36
32
 
@@ -39,7 +35,7 @@ const exampleJSON: string = JSON.stringify(example)
39
35
  console.log(exampleJSON)
40
36
 
41
37
  // Parse the JSON string back to an object
42
- const exampleParsed = JSON.parse(exampleJSON) as StepOutput
38
+ const exampleParsed = JSON.parse(exampleJSON) as ReasoningPart
43
39
  console.log(exampleParsed)
44
40
  ```
45
41
 
@@ -1,5 +1,5 @@
1
1
 
2
- # StepInput
2
+ # Step
3
3
 
4
4
 
5
5
  ## Properties
@@ -13,12 +13,11 @@ Name | Type
13
13
  `detail` | string
14
14
  `startTime` | Date
15
15
  `endTime` | Date
16
- `steps` | [Array<StepInput>](StepInput.md)
17
16
 
18
17
  ## Example
19
18
 
20
19
  ```typescript
21
- import type { StepInput } from '@knowledge-stack/ksapi'
20
+ import type { Step } from '@knowledge-stack/ksapi'
22
21
 
23
22
  // TODO: Update the object below with actual values
24
23
  const example = {
@@ -29,8 +28,7 @@ const example = {
29
28
  "detail": null,
30
29
  "startTime": null,
31
30
  "endTime": null,
32
- "steps": null,
33
- } satisfies StepInput
31
+ } satisfies Step
34
32
 
35
33
  console.log(example)
36
34
 
@@ -39,7 +37,7 @@ const exampleJSON: string = JSON.stringify(example)
39
37
  console.log(exampleJSON)
40
38
 
41
39
  // Parse the JSON string back to an object
42
- const exampleParsed = JSON.parse(exampleJSON) as StepInput
40
+ const exampleParsed = JSON.parse(exampleJSON) as Step
43
41
  console.log(exampleParsed)
44
42
  ```
45
43
 
@@ -0,0 +1,46 @@
1
+
2
+ # TextPart
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `seq` | number
11
+ `startTime` | Date
12
+ `endTime` | Date
13
+ `kind` | string
14
+ `text` | string
15
+ `citations` | [Array<Citation>](Citation.md)
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import type { TextPart } from '@knowledge-stack/ksapi'
21
+
22
+ // TODO: Update the object below with actual values
23
+ const example = {
24
+ "id": null,
25
+ "seq": null,
26
+ "startTime": null,
27
+ "endTime": null,
28
+ "kind": null,
29
+ "text": null,
30
+ "citations": null,
31
+ } satisfies TextPart
32
+
33
+ console.log(example)
34
+
35
+ // Convert the instance to a JSON string
36
+ const exampleJSON: string = JSON.stringify(example)
37
+ console.log(exampleJSON)
38
+
39
+ // Parse the JSON string back to an object
40
+ const exampleParsed = JSON.parse(exampleJSON) as TextPart
41
+ console.log(exampleParsed)
42
+ ```
43
+
44
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
45
+
46
+
@@ -0,0 +1,72 @@
1
+
2
+ # TextPartOrReasoningPartOrToolPartOrDocEditPart
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `seq` | number
11
+ `startTime` | Date
12
+ `endTime` | Date
13
+ `kind` | string
14
+ `text` | string
15
+ `citations` | [Array<Citation>](Citation.md)
16
+ `toolCallId` | string
17
+ `toolName` | string
18
+ `input` | [Input](Input.md)
19
+ `status` | [ToolStatus](ToolStatus.md)
20
+ `result` | any
21
+ `isError` | boolean
22
+ `durationMs` | number
23
+ `extras` | { [key: string]: any; }
24
+ `documentId` | string
25
+ `baseVersionId` | string
26
+ `newVersionId` | string
27
+ `docFormat` | string
28
+ `approvalId` | string
29
+
30
+ ## Example
31
+
32
+ ```typescript
33
+ import type { TextPartOrReasoningPartOrToolPartOrDocEditPart } from '@knowledge-stack/ksapi'
34
+
35
+ // TODO: Update the object below with actual values
36
+ const example = {
37
+ "id": null,
38
+ "seq": null,
39
+ "startTime": null,
40
+ "endTime": null,
41
+ "kind": null,
42
+ "text": null,
43
+ "citations": null,
44
+ "toolCallId": null,
45
+ "toolName": null,
46
+ "input": null,
47
+ "status": null,
48
+ "result": null,
49
+ "isError": null,
50
+ "durationMs": null,
51
+ "extras": null,
52
+ "documentId": null,
53
+ "baseVersionId": null,
54
+ "newVersionId": null,
55
+ "docFormat": null,
56
+ "approvalId": null,
57
+ } satisfies TextPartOrReasoningPartOrToolPartOrDocEditPart
58
+
59
+ console.log(example)
60
+
61
+ // Convert the instance to a JSON string
62
+ const exampleJSON: string = JSON.stringify(example)
63
+ console.log(exampleJSON)
64
+
65
+ // Parse the JSON string back to an object
66
+ const exampleParsed = JSON.parse(exampleJSON) as TextPartOrReasoningPartOrToolPartOrDocEditPart
67
+ console.log(exampleParsed)
68
+ ```
69
+
70
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
71
+
72
+
@@ -1,26 +1,30 @@
1
1
 
2
- # ThreadMessageDetailsOutput
2
+ # ThreadMessageDetails
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `steps` | [Array<StepOutput>](StepOutput.md)
9
+ `parts` | [Array<TextPartOrReasoningPartOrToolPartOrDocEditPart>](TextPartOrReasoningPartOrToolPartOrDocEditPart.md)
10
+ `usage` | [MessageUsage](MessageUsage.md)
11
+ `steps` | [Array<Step>](Step.md)
10
12
  `checkpoint` | [CheckpointDetails](CheckpointDetails.md)
11
13
  `modelId` | string
12
14
 
13
15
  ## Example
14
16
 
15
17
  ```typescript
16
- import type { ThreadMessageDetailsOutput } from '@knowledge-stack/ksapi'
18
+ import type { ThreadMessageDetails } from '@knowledge-stack/ksapi'
17
19
 
18
20
  // TODO: Update the object below with actual values
19
21
  const example = {
22
+ "parts": null,
23
+ "usage": null,
20
24
  "steps": null,
21
25
  "checkpoint": null,
22
26
  "modelId": null,
23
- } satisfies ThreadMessageDetailsOutput
27
+ } satisfies ThreadMessageDetails
24
28
 
25
29
  console.log(example)
26
30
 
@@ -29,7 +33,7 @@ const exampleJSON: string = JSON.stringify(example)
29
33
  console.log(exampleJSON)
30
34
 
31
35
  // Parse the JSON string back to an object
32
- const exampleParsed = JSON.parse(exampleJSON) as ThreadMessageDetailsOutput
36
+ const exampleParsed = JSON.parse(exampleJSON) as ThreadMessageDetails
33
37
  console.log(exampleParsed)
34
38
  ```
35
39
 
@@ -11,7 +11,8 @@ Name | Type
11
11
  `sequence` | number
12
12
  `role` | [MessageRole](MessageRole.md)
13
13
  `content` | [EnrichedThreadMessageContent](EnrichedThreadMessageContent.md)
14
- `details` | [ThreadMessageDetailsOutput](ThreadMessageDetailsOutput.md)
14
+ `details` | [ThreadMessageDetails](ThreadMessageDetails.md)
15
+ `parts` | [Array<TextPartOrReasoningPartOrToolPartOrDocEditPart>](TextPartOrReasoningPartOrToolPartOrDocEditPart.md)
15
16
  `parentPathId` | string
16
17
  `materializedPath` | string
17
18
  `tenantId` | string
@@ -32,6 +33,7 @@ const example = {
32
33
  "role": null,
33
34
  "content": null,
34
35
  "details": null,
36
+ "parts": null,
35
37
  "parentPathId": null,
36
38
  "materializedPath": null,
37
39
  "tenantId": null,
@@ -0,0 +1,58 @@
1
+
2
+ # ToolPart
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `seq` | number
11
+ `startTime` | Date
12
+ `endTime` | Date
13
+ `kind` | string
14
+ `toolCallId` | string
15
+ `toolName` | string
16
+ `input` | [Input](Input.md)
17
+ `status` | [ToolStatus](ToolStatus.md)
18
+ `result` | any
19
+ `isError` | boolean
20
+ `durationMs` | number
21
+ `extras` | { [key: string]: any; }
22
+
23
+ ## Example
24
+
25
+ ```typescript
26
+ import type { ToolPart } from '@knowledge-stack/ksapi'
27
+
28
+ // TODO: Update the object below with actual values
29
+ const example = {
30
+ "id": null,
31
+ "seq": null,
32
+ "startTime": null,
33
+ "endTime": null,
34
+ "kind": null,
35
+ "toolCallId": null,
36
+ "toolName": null,
37
+ "input": null,
38
+ "status": null,
39
+ "result": null,
40
+ "isError": null,
41
+ "durationMs": null,
42
+ "extras": null,
43
+ } satisfies ToolPart
44
+
45
+ console.log(example)
46
+
47
+ // Convert the instance to a JSON string
48
+ const exampleJSON: string = JSON.stringify(example)
49
+ console.log(exampleJSON)
50
+
51
+ // Parse the JSON string back to an object
52
+ const exampleParsed = JSON.parse(exampleJSON) as ToolPart
53
+ console.log(exampleParsed)
54
+ ```
55
+
56
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
57
+
58
+