@knowledge-stack/ksapi 1.56.0 → 1.58.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/.openapi-generator/FILES +14 -2
- package/README.md +14 -6
- package/dist/apis/DocumentVersionsApi.d.ts +8 -5
- package/dist/apis/DocumentVersionsApi.js +5 -2
- package/dist/apis/ThreadMessagesApi.d.ts +6 -6
- package/dist/apis/ThreadMessagesApi.js +2 -2
- package/dist/apis/WorkflowsApi.d.ts +144 -59
- package/dist/apis/WorkflowsApi.js +131 -49
- package/dist/esm/apis/DocumentVersionsApi.d.ts +8 -5
- package/dist/esm/apis/DocumentVersionsApi.js +5 -2
- package/dist/esm/apis/ThreadMessagesApi.d.ts +6 -6
- package/dist/esm/apis/ThreadMessagesApi.js +2 -2
- package/dist/esm/apis/WorkflowsApi.d.ts +144 -59
- package/dist/esm/apis/WorkflowsApi.js +132 -50
- package/dist/esm/models/CreateThreadMessageRequest.d.ts +6 -0
- package/dist/esm/models/CreateThreadMessageRequest.js +2 -0
- package/dist/esm/models/DocumentVersionContentTypeFilter.d.ts +25 -0
- package/dist/esm/models/DocumentVersionContentTypeFilter.js +43 -0
- package/dist/esm/models/EnrichedThreadMessageContent.d.ts +13 -0
- package/dist/esm/models/EnrichedThreadMessageContent.js +5 -0
- package/dist/esm/models/NonFilesystemReferenceType.d.ts +27 -0
- package/dist/esm/models/NonFilesystemReferenceType.js +45 -0
- package/dist/esm/models/ReferenceType.d.ts +34 -0
- package/dist/esm/models/ReferenceType.js +52 -0
- package/dist/esm/models/ResolvedReferenceInput.d.ts +70 -0
- package/dist/esm/models/ResolvedReferenceInput.js +55 -0
- package/dist/esm/models/ResolvedReferenceOutput.d.ts +69 -0
- package/dist/esm/models/ResolvedReferenceOutput.js +54 -0
- package/dist/esm/models/StepInput.d.ts +6 -0
- package/dist/esm/models/StepInput.js +4 -0
- package/dist/esm/models/StepKind.d.ts +1 -0
- package/dist/esm/models/StepKind.js +1 -0
- package/dist/esm/models/StepOutput.d.ts +6 -0
- package/dist/esm/models/StepOutput.js +4 -0
- package/dist/esm/models/TemporalWorkflowStatusResponse.d.ts +83 -0
- package/dist/esm/models/TemporalWorkflowStatusResponse.js +66 -0
- package/dist/esm/models/ThreadMessageContent.d.ts +13 -0
- package/dist/esm/models/ThreadMessageContent.js +5 -0
- package/dist/esm/models/WorkflowActionResponse.d.ts +1 -1
- package/dist/esm/models/WorkflowCancelResponse.d.ts +53 -0
- package/dist/esm/models/WorkflowCancelResponse.js +48 -0
- package/dist/esm/models/index.d.ts +7 -1
- package/dist/esm/models/index.js +7 -1
- package/dist/models/CreateThreadMessageRequest.d.ts +6 -0
- package/dist/models/CreateThreadMessageRequest.js +2 -0
- package/dist/models/DocumentVersionContentTypeFilter.d.ts +25 -0
- package/dist/models/DocumentVersionContentTypeFilter.js +51 -0
- package/dist/models/EnrichedThreadMessageContent.d.ts +13 -0
- package/dist/models/EnrichedThreadMessageContent.js +5 -0
- package/dist/models/NonFilesystemReferenceType.d.ts +27 -0
- package/dist/models/NonFilesystemReferenceType.js +53 -0
- package/dist/models/ReferenceType.d.ts +34 -0
- package/dist/models/ReferenceType.js +60 -0
- package/dist/models/ResolvedReferenceInput.d.ts +70 -0
- package/dist/models/ResolvedReferenceInput.js +63 -0
- package/dist/models/ResolvedReferenceOutput.d.ts +69 -0
- package/dist/models/ResolvedReferenceOutput.js +62 -0
- package/dist/models/StepInput.d.ts +6 -0
- package/dist/models/StepInput.js +4 -0
- package/dist/models/StepKind.d.ts +1 -0
- package/dist/models/StepKind.js +1 -0
- package/dist/models/StepOutput.d.ts +6 -0
- package/dist/models/StepOutput.js +4 -0
- package/dist/models/TemporalWorkflowStatusResponse.d.ts +83 -0
- package/dist/models/TemporalWorkflowStatusResponse.js +74 -0
- package/dist/models/ThreadMessageContent.d.ts +13 -0
- package/dist/models/ThreadMessageContent.js +5 -0
- package/dist/models/WorkflowActionResponse.d.ts +1 -1
- package/dist/models/WorkflowCancelResponse.d.ts +53 -0
- package/dist/models/WorkflowCancelResponse.js +56 -0
- package/dist/models/index.d.ts +7 -1
- package/dist/models/index.js +7 -1
- package/docs/CreateThreadMessageRequest.md +2 -0
- package/docs/DocumentVersionContentTypeFilter.md +33 -0
- package/docs/DocumentVersionsApi.md +5 -2
- package/docs/EnrichedThreadMessageContent.md +4 -0
- package/docs/NonFilesystemReferenceType.md +33 -0
- package/docs/{WorkflowAction.md → ReferenceType.md} +4 -5
- package/docs/ResolvedReferenceInput.md +41 -0
- package/docs/ResolvedReferenceOutput.md +41 -0
- package/docs/StepInput.md +2 -0
- package/docs/StepOutput.md +2 -0
- package/docs/TemporalWorkflowStatusResponse.md +47 -0
- package/docs/ThreadMessageContent.md +4 -0
- package/docs/ThreadMessagesApi.md +3 -3
- package/docs/WorkflowActionResponse.md +1 -1
- package/docs/WorkflowCancelResponse.md +37 -0
- package/docs/WorkflowsApi.md +183 -36
- package/package.json +1 -1
- package/src/apis/DocumentVersionsApi.ts +14 -4
- package/src/apis/ThreadMessagesApi.ts +6 -6
- package/src/apis/WorkflowsApi.ts +249 -90
- package/src/models/CreateThreadMessageRequest.ts +8 -0
- package/src/models/DocumentVersionContentTypeFilter.ts +53 -0
- package/src/models/EnrichedThreadMessageContent.ts +23 -0
- package/src/models/NonFilesystemReferenceType.ts +55 -0
- package/src/models/ReferenceType.ts +62 -0
- package/src/models/ResolvedReferenceInput.ts +123 -0
- package/src/models/ResolvedReferenceOutput.ts +113 -0
- package/src/models/StepInput.ts +9 -0
- package/src/models/StepKind.ts +1 -0
- package/src/models/StepOutput.ts +9 -0
- package/src/models/TemporalWorkflowStatusResponse.ts +136 -0
- package/src/models/ThreadMessageContent.ts +23 -0
- package/src/models/WorkflowActionResponse.ts +1 -1
- package/src/models/WorkflowCancelResponse.ts +92 -0
- package/src/models/index.ts +7 -1
- package/dist/esm/models/WorkflowAction.d.ts +0 -25
- package/dist/esm/models/WorkflowAction.js +0 -43
- package/dist/models/WorkflowAction.d.ts +0 -25
- package/dist/models/WorkflowAction.js +0 -51
- package/src/models/WorkflowAction.ts +0 -53
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Knowledge Stack API
|
|
3
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Response for generic workflow cancellation.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface WorkflowCancelResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface WorkflowCancelResponse {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof WorkflowCancelResponse
|
|
22
|
+
*/
|
|
23
|
+
workflowId: string;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof WorkflowCancelResponse
|
|
28
|
+
*/
|
|
29
|
+
message: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the WorkflowCancelResponse interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfWorkflowCancelResponse(value: object): value is WorkflowCancelResponse;
|
|
35
|
+
export declare function WorkflowCancelResponseFromJSON(json: any): WorkflowCancelResponse;
|
|
36
|
+
export declare function WorkflowCancelResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowCancelResponse;
|
|
37
|
+
export declare function WorkflowCancelResponseToJSON(json: any): WorkflowCancelResponse;
|
|
38
|
+
export declare function WorkflowCancelResponseToJSONTyped(value?: WorkflowCancelResponse | null, ignoreDiscriminator?: boolean): any;
|
|
39
|
+
export declare const WorkflowCancelResponsePropertyValidationAttributesMap: {
|
|
40
|
+
[property: string]: {
|
|
41
|
+
maxLength?: number;
|
|
42
|
+
minLength?: number;
|
|
43
|
+
pattern?: string;
|
|
44
|
+
maximum?: number;
|
|
45
|
+
exclusiveMaximum?: boolean;
|
|
46
|
+
minimum?: number;
|
|
47
|
+
exclusiveMinimum?: boolean;
|
|
48
|
+
multipleOf?: number;
|
|
49
|
+
maxItems?: number;
|
|
50
|
+
minItems?: number;
|
|
51
|
+
uniqueItems?: boolean;
|
|
52
|
+
};
|
|
53
|
+
};
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Knowledge Stack API
|
|
6
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.WorkflowCancelResponsePropertyValidationAttributesMap = void 0;
|
|
17
|
+
exports.instanceOfWorkflowCancelResponse = instanceOfWorkflowCancelResponse;
|
|
18
|
+
exports.WorkflowCancelResponseFromJSON = WorkflowCancelResponseFromJSON;
|
|
19
|
+
exports.WorkflowCancelResponseFromJSONTyped = WorkflowCancelResponseFromJSONTyped;
|
|
20
|
+
exports.WorkflowCancelResponseToJSON = WorkflowCancelResponseToJSON;
|
|
21
|
+
exports.WorkflowCancelResponseToJSONTyped = WorkflowCancelResponseToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the WorkflowCancelResponse interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfWorkflowCancelResponse(value) {
|
|
26
|
+
if (!('workflowId' in value) || value['workflowId'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('message' in value) || value['message'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
return true;
|
|
31
|
+
}
|
|
32
|
+
function WorkflowCancelResponseFromJSON(json) {
|
|
33
|
+
return WorkflowCancelResponseFromJSONTyped(json, false);
|
|
34
|
+
}
|
|
35
|
+
function WorkflowCancelResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
36
|
+
if (json == null) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
return {
|
|
40
|
+
'workflowId': json['workflow_id'],
|
|
41
|
+
'message': json['message'],
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
function WorkflowCancelResponseToJSON(json) {
|
|
45
|
+
return WorkflowCancelResponseToJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
function WorkflowCancelResponseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
48
|
+
if (value == null) {
|
|
49
|
+
return value;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'workflow_id': value['workflowId'],
|
|
53
|
+
'message': value['message'],
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
exports.WorkflowCancelResponsePropertyValidationAttributesMap = {};
|
package/dist/models/index.d.ts
CHANGED
|
@@ -33,6 +33,7 @@ export * from './DocumentResponse';
|
|
|
33
33
|
export * from './DocumentType';
|
|
34
34
|
export * from './DocumentVersionAction';
|
|
35
35
|
export * from './DocumentVersionActionResponse';
|
|
36
|
+
export * from './DocumentVersionContentTypeFilter';
|
|
36
37
|
export * from './DocumentVersionMetadata';
|
|
37
38
|
export * from './DocumentVersionMetadataUpdate';
|
|
38
39
|
export * from './DocumentVersionResponse';
|
|
@@ -60,6 +61,7 @@ export * from './LineageGraphResponse';
|
|
|
60
61
|
export * from './LineageNodeResponse';
|
|
61
62
|
export * from './LocationInner';
|
|
62
63
|
export * from './MessageRole';
|
|
64
|
+
export * from './NonFilesystemReferenceType';
|
|
63
65
|
export * from './OAuth2Config';
|
|
64
66
|
export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator';
|
|
65
67
|
export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
|
|
@@ -87,6 +89,9 @@ export * from './PipelineState';
|
|
|
87
89
|
export * from './PipelineStatus';
|
|
88
90
|
export * from './Polygon';
|
|
89
91
|
export * from './PolygonReference';
|
|
92
|
+
export * from './ReferenceType';
|
|
93
|
+
export * from './ResolvedReferenceInput';
|
|
94
|
+
export * from './ResolvedReferenceOutput';
|
|
90
95
|
export * from './RootResponse';
|
|
91
96
|
export * from './SSOInitiateResponse';
|
|
92
97
|
export * from './ScoredChunkResponse';
|
|
@@ -103,6 +108,7 @@ export * from './SubtreeChunkGroup';
|
|
|
103
108
|
export * from './SubtreeChunksResponse';
|
|
104
109
|
export * from './SupportedLanguage';
|
|
105
110
|
export * from './TagResponse';
|
|
111
|
+
export * from './TemporalWorkflowStatusResponse';
|
|
106
112
|
export * from './TenantBrandingResponse';
|
|
107
113
|
export * from './TenantResponse';
|
|
108
114
|
export * from './TenantSettingsResponse';
|
|
@@ -130,7 +136,7 @@ export * from './UserMessageResponse';
|
|
|
130
136
|
export * from './UserResponse';
|
|
131
137
|
export * from './ValidationError';
|
|
132
138
|
export * from './VersionChunkIdsResponse';
|
|
133
|
-
export * from './WorkflowAction';
|
|
134
139
|
export * from './WorkflowActionResponse';
|
|
140
|
+
export * from './WorkflowCancelResponse';
|
|
135
141
|
export * from './WorkflowDetailResponse';
|
|
136
142
|
export * from './WorkflowSummaryResponse';
|
package/dist/models/index.js
CHANGED
|
@@ -51,6 +51,7 @@ __exportStar(require("./DocumentResponse"), exports);
|
|
|
51
51
|
__exportStar(require("./DocumentType"), exports);
|
|
52
52
|
__exportStar(require("./DocumentVersionAction"), exports);
|
|
53
53
|
__exportStar(require("./DocumentVersionActionResponse"), exports);
|
|
54
|
+
__exportStar(require("./DocumentVersionContentTypeFilter"), exports);
|
|
54
55
|
__exportStar(require("./DocumentVersionMetadata"), exports);
|
|
55
56
|
__exportStar(require("./DocumentVersionMetadataUpdate"), exports);
|
|
56
57
|
__exportStar(require("./DocumentVersionResponse"), exports);
|
|
@@ -78,6 +79,7 @@ __exportStar(require("./LineageGraphResponse"), exports);
|
|
|
78
79
|
__exportStar(require("./LineageNodeResponse"), exports);
|
|
79
80
|
__exportStar(require("./LocationInner"), exports);
|
|
80
81
|
__exportStar(require("./MessageRole"), exports);
|
|
82
|
+
__exportStar(require("./NonFilesystemReferenceType"), exports);
|
|
81
83
|
__exportStar(require("./OAuth2Config"), exports);
|
|
82
84
|
__exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator"), exports);
|
|
83
85
|
__exportStar(require("./PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator"), exports);
|
|
@@ -105,6 +107,9 @@ __exportStar(require("./PipelineState"), exports);
|
|
|
105
107
|
__exportStar(require("./PipelineStatus"), exports);
|
|
106
108
|
__exportStar(require("./Polygon"), exports);
|
|
107
109
|
__exportStar(require("./PolygonReference"), exports);
|
|
110
|
+
__exportStar(require("./ReferenceType"), exports);
|
|
111
|
+
__exportStar(require("./ResolvedReferenceInput"), exports);
|
|
112
|
+
__exportStar(require("./ResolvedReferenceOutput"), exports);
|
|
108
113
|
__exportStar(require("./RootResponse"), exports);
|
|
109
114
|
__exportStar(require("./SSOInitiateResponse"), exports);
|
|
110
115
|
__exportStar(require("./ScoredChunkResponse"), exports);
|
|
@@ -121,6 +126,7 @@ __exportStar(require("./SubtreeChunkGroup"), exports);
|
|
|
121
126
|
__exportStar(require("./SubtreeChunksResponse"), exports);
|
|
122
127
|
__exportStar(require("./SupportedLanguage"), exports);
|
|
123
128
|
__exportStar(require("./TagResponse"), exports);
|
|
129
|
+
__exportStar(require("./TemporalWorkflowStatusResponse"), exports);
|
|
124
130
|
__exportStar(require("./TenantBrandingResponse"), exports);
|
|
125
131
|
__exportStar(require("./TenantResponse"), exports);
|
|
126
132
|
__exportStar(require("./TenantSettingsResponse"), exports);
|
|
@@ -148,7 +154,7 @@ __exportStar(require("./UserMessageResponse"), exports);
|
|
|
148
154
|
__exportStar(require("./UserResponse"), exports);
|
|
149
155
|
__exportStar(require("./ValidationError"), exports);
|
|
150
156
|
__exportStar(require("./VersionChunkIdsResponse"), exports);
|
|
151
|
-
__exportStar(require("./WorkflowAction"), exports);
|
|
152
157
|
__exportStar(require("./WorkflowActionResponse"), exports);
|
|
158
|
+
__exportStar(require("./WorkflowCancelResponse"), exports);
|
|
153
159
|
__exportStar(require("./WorkflowDetailResponse"), exports);
|
|
154
160
|
__exportStar(require("./WorkflowSummaryResponse"), exports);
|
|
@@ -7,6 +7,7 @@ Request to create a new thread message.
|
|
|
7
7
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
|
+
`messageId` | string
|
|
10
11
|
`role` | [MessageRole](MessageRole.md)
|
|
11
12
|
`content` | [ThreadMessageContent](ThreadMessageContent.md)
|
|
12
13
|
`details` | [ThreadMessageDetailsInput](ThreadMessageDetailsInput.md)
|
|
@@ -18,6 +19,7 @@ import type { CreateThreadMessageRequest } from '@knowledge-stack/ksapi'
|
|
|
18
19
|
|
|
19
20
|
// TODO: Update the object below with actual values
|
|
20
21
|
const example = {
|
|
22
|
+
"messageId": null,
|
|
21
23
|
"role": null,
|
|
22
24
|
"content": null,
|
|
23
25
|
"details": null,
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# DocumentVersionContentTypeFilter
|
|
3
|
+
|
|
4
|
+
Filter for the type of content rows to return.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { DocumentVersionContentTypeFilter } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies DocumentVersionContentTypeFilter
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as DocumentVersionContentTypeFilter
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|
|
@@ -390,11 +390,11 @@ No authorization required
|
|
|
390
390
|
|
|
391
391
|
## getDocumentVersionContents
|
|
392
392
|
|
|
393
|
-
> PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator getDocumentVersionContents(versionId, sectionId, limit, offset, authorization, ksUat)
|
|
393
|
+
> PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator getDocumentVersionContents(versionId, sectionId, contentType, limit, offset, authorization, ksUat)
|
|
394
394
|
|
|
395
395
|
Get Document Version Contents Handler
|
|
396
396
|
|
|
397
|
-
List all sections and chunks for a document version in depth-first logical order. Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\").
|
|
397
|
+
List all sections and chunks for a document version in depth-first logical order. Returns a discriminated union of SectionContentItem and ChunkContentItem, distinguished by the `part_type` field (\"SECTION\" or \"CHUNK\"). Use `content_type` to return only one type (e.g. `content_type=CHUNK` for chunk-only pagination where offset/limit apply only to chunks).
|
|
398
398
|
|
|
399
399
|
### Example
|
|
400
400
|
|
|
@@ -414,6 +414,8 @@ async function example() {
|
|
|
414
414
|
versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
415
415
|
// string | Optional section ID to scope traversal to a subtree (optional)
|
|
416
416
|
sectionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
417
|
+
// DocumentVersionContentTypeFilter | Filter by content type: SECTION or CHUNK. Omit to return both types. (optional)
|
|
418
|
+
contentType: ...,
|
|
417
419
|
// number | Number of items per page (optional)
|
|
418
420
|
limit: 56,
|
|
419
421
|
// number | Number of items to skip (optional)
|
|
@@ -443,6 +445,7 @@ example().catch(console.error);
|
|
|
443
445
|
|------------- | ------------- | ------------- | -------------|
|
|
444
446
|
| **versionId** | `string` | DocumentVersion ID | [Defaults to `undefined`] |
|
|
445
447
|
| **sectionId** | `string` | Optional section ID to scope traversal to a subtree | [Optional] [Defaults to `undefined`] |
|
|
448
|
+
| **contentType** | `DocumentVersionContentTypeFilter` | Filter by content type: SECTION or CHUNK. Omit to return both types. | [Optional] [Defaults to `undefined`] [Enum: SECTION, CHUNK] |
|
|
446
449
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
447
450
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
448
451
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -8,7 +8,9 @@ ThreadMessageContent with enriched citations for API responses.
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`text` | string
|
|
11
|
+
`isError` | boolean
|
|
11
12
|
`citations` | [Array<EnrichedCitation>](EnrichedCitation.md)
|
|
13
|
+
`references` | [Array<ResolvedReferenceOutput>](ResolvedReferenceOutput.md)
|
|
12
14
|
|
|
13
15
|
## Example
|
|
14
16
|
|
|
@@ -18,7 +20,9 @@ import type { EnrichedThreadMessageContent } from '@knowledge-stack/ksapi'
|
|
|
18
20
|
// TODO: Update the object below with actual values
|
|
19
21
|
const example = {
|
|
20
22
|
"text": null,
|
|
23
|
+
"isError": null,
|
|
21
24
|
"citations": null,
|
|
25
|
+
"references": null,
|
|
22
26
|
} satisfies EnrichedThreadMessageContent
|
|
23
27
|
|
|
24
28
|
console.log(example)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# NonFilesystemReferenceType
|
|
3
|
+
|
|
4
|
+
Supported reference types that do not map to filesystem PartType.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { NonFilesystemReferenceType } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies NonFilesystemReferenceType
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as NonFilesystemReferenceType
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# ReferenceType
|
|
3
3
|
|
|
4
|
-
Supported workflow actions.
|
|
5
4
|
|
|
6
5
|
## Properties
|
|
7
6
|
|
|
@@ -11,11 +10,11 @@ Name | Type
|
|
|
11
10
|
## Example
|
|
12
11
|
|
|
13
12
|
```typescript
|
|
14
|
-
import type {
|
|
13
|
+
import type { ReferenceType } from '@knowledge-stack/ksapi'
|
|
15
14
|
|
|
16
15
|
// TODO: Update the object below with actual values
|
|
17
16
|
const example = {
|
|
18
|
-
} satisfies
|
|
17
|
+
} satisfies ReferenceType
|
|
19
18
|
|
|
20
19
|
console.log(example)
|
|
21
20
|
|
|
@@ -24,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
24
23
|
console.log(exampleJSON)
|
|
25
24
|
|
|
26
25
|
// Parse the JSON string back to an object
|
|
27
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
26
|
+
const exampleParsed = JSON.parse(exampleJSON) as ReferenceType
|
|
28
27
|
console.log(exampleParsed)
|
|
29
28
|
```
|
|
30
29
|
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# ResolvedReferenceInput
|
|
3
|
+
|
|
4
|
+
A parsed reference enriched with display name and path from the database. Uses ``extra=\"ignore\"`` (not ``\"forbid\"``) because SDK dicts may contain fields not yet modelled here. Adding ``\"forbid\"`` would cause runtime deserialization failures whenever the SDK adds a new field.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`refType` | [ReferenceType](ReferenceType.md)
|
|
11
|
+
`entityId` | string
|
|
12
|
+
`displayName` | string
|
|
13
|
+
`materializedPath` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { ResolvedReferenceInput } from '@knowledge-stack/ksapi'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"refType": null,
|
|
23
|
+
"entityId": null,
|
|
24
|
+
"displayName": null,
|
|
25
|
+
"materializedPath": null,
|
|
26
|
+
} satisfies ResolvedReferenceInput
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as ResolvedReferenceInput
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# ResolvedReferenceOutput
|
|
3
|
+
|
|
4
|
+
A parsed reference enriched with display name and path from the database. Uses ``extra=\"ignore\"`` (not ``\"forbid\"``) because SDK dicts may contain fields not yet modelled here. Adding ``\"forbid\"`` would cause runtime deserialization failures whenever the SDK adds a new field.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`refType` | string
|
|
11
|
+
`entityId` | string
|
|
12
|
+
`displayName` | string
|
|
13
|
+
`materializedPath` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { ResolvedReferenceOutput } from '@knowledge-stack/ksapi'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"refType": null,
|
|
23
|
+
"entityId": null,
|
|
24
|
+
"displayName": null,
|
|
25
|
+
"materializedPath": null,
|
|
26
|
+
} satisfies ResolvedReferenceOutput
|
|
27
|
+
|
|
28
|
+
console.log(example)
|
|
29
|
+
|
|
30
|
+
// Convert the instance to a JSON string
|
|
31
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
32
|
+
console.log(exampleJSON)
|
|
33
|
+
|
|
34
|
+
// Parse the JSON string back to an object
|
|
35
|
+
const exampleParsed = JSON.parse(exampleJSON) as ResolvedReferenceOutput
|
|
36
|
+
console.log(exampleParsed)
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
40
|
+
|
|
41
|
+
|
package/docs/StepInput.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`id` | string
|
|
9
10
|
`name` | string
|
|
10
11
|
`kind` | [StepKind](StepKind.md)
|
|
11
12
|
`args` | [Args](Args.md)
|
|
@@ -21,6 +22,7 @@ import type { StepInput } from '@knowledge-stack/ksapi'
|
|
|
21
22
|
|
|
22
23
|
// TODO: Update the object below with actual values
|
|
23
24
|
const example = {
|
|
25
|
+
"id": null,
|
|
24
26
|
"name": null,
|
|
25
27
|
"kind": null,
|
|
26
28
|
"args": null,
|
package/docs/StepOutput.md
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`id` | string
|
|
9
10
|
`name` | string
|
|
10
11
|
`kind` | [StepKind](StepKind.md)
|
|
11
12
|
`args` | [Args](Args.md)
|
|
@@ -21,6 +22,7 @@ import type { StepOutput } from '@knowledge-stack/ksapi'
|
|
|
21
22
|
|
|
22
23
|
// TODO: Update the object below with actual values
|
|
23
24
|
const example = {
|
|
25
|
+
"id": null,
|
|
24
26
|
"name": null,
|
|
25
27
|
"kind": null,
|
|
26
28
|
"args": null,
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
|
|
2
|
+
# TemporalWorkflowStatusResponse
|
|
3
|
+
|
|
4
|
+
Generic Temporal workflow status — no DB interaction.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`workflowId` | string
|
|
11
|
+
`temporalStatus` | string
|
|
12
|
+
`workflowType` | string
|
|
13
|
+
`taskQueue` | string
|
|
14
|
+
`startTime` | Date
|
|
15
|
+
`closeTime` | Date
|
|
16
|
+
`runId` | string
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import type { TemporalWorkflowStatusResponse } from '@knowledge-stack/ksapi'
|
|
22
|
+
|
|
23
|
+
// TODO: Update the object below with actual values
|
|
24
|
+
const example = {
|
|
25
|
+
"workflowId": null,
|
|
26
|
+
"temporalStatus": null,
|
|
27
|
+
"workflowType": null,
|
|
28
|
+
"taskQueue": null,
|
|
29
|
+
"startTime": null,
|
|
30
|
+
"closeTime": null,
|
|
31
|
+
"runId": null,
|
|
32
|
+
} satisfies TemporalWorkflowStatusResponse
|
|
33
|
+
|
|
34
|
+
console.log(example)
|
|
35
|
+
|
|
36
|
+
// Convert the instance to a JSON string
|
|
37
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
38
|
+
console.log(exampleJSON)
|
|
39
|
+
|
|
40
|
+
// Parse the JSON string back to an object
|
|
41
|
+
const exampleParsed = JSON.parse(exampleJSON) as TemporalWorkflowStatusResponse
|
|
42
|
+
console.log(exampleParsed)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
46
|
+
|
|
47
|
+
|
|
@@ -7,7 +7,9 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`text` | string
|
|
10
|
+
`isError` | boolean
|
|
10
11
|
`citations` | [Array<Citation>](Citation.md)
|
|
12
|
+
`references` | [Array<ResolvedReferenceInput>](ResolvedReferenceInput.md)
|
|
11
13
|
|
|
12
14
|
## Example
|
|
13
15
|
|
|
@@ -17,7 +19,9 @@ import type { ThreadMessageContent } from '@knowledge-stack/ksapi'
|
|
|
17
19
|
// TODO: Update the object below with actual values
|
|
18
20
|
const example = {
|
|
19
21
|
"text": null,
|
|
22
|
+
"isError": null,
|
|
20
23
|
"citations": null,
|
|
24
|
+
"references": null,
|
|
21
25
|
} satisfies ThreadMessageContent
|
|
22
26
|
|
|
23
27
|
console.log(example)
|
|
@@ -173,7 +173,7 @@ No authorization required
|
|
|
173
173
|
|
|
174
174
|
List Thread Messages Handler
|
|
175
175
|
|
|
176
|
-
List messages in a thread, ordered by created_at descending. Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`. Use `with_details=
|
|
176
|
+
List messages in a thread, ordered by created_at descending. Supports cursor-based pagination via `before` parameter and standard offset-based pagination via `limit`/`offset`. Use `with_details=false` to exclude execution step data and reduce payload size.
|
|
177
177
|
|
|
178
178
|
### Example
|
|
179
179
|
|
|
@@ -193,7 +193,7 @@ async function example() {
|
|
|
193
193
|
threadId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
194
194
|
// Date | Cursor for keyset pagination: only return messages with created_at < this value (optional)
|
|
195
195
|
before: 2013-10-20T19:20:30+01:00,
|
|
196
|
-
// boolean | Include execution steps in response (default
|
|
196
|
+
// boolean | Include execution steps in response (default true) (optional)
|
|
197
197
|
withDetails: true,
|
|
198
198
|
// number | Number of items per page (optional)
|
|
199
199
|
limit: 56,
|
|
@@ -224,7 +224,7 @@ example().catch(console.error);
|
|
|
224
224
|
|------------- | ------------- | ------------- | -------------|
|
|
225
225
|
| **threadId** | `string` | | [Defaults to `undefined`] |
|
|
226
226
|
| **before** | `Date` | Cursor for keyset pagination: only return messages with created_at < this value | [Optional] [Defaults to `undefined`] |
|
|
227
|
-
| **withDetails** | `boolean` | Include execution steps in response (default
|
|
227
|
+
| **withDetails** | `boolean` | Include execution steps in response (default true) | [Optional] [Defaults to `true`] |
|
|
228
228
|
| **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
|
|
229
229
|
| **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
|
|
230
230
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# WorkflowCancelResponse
|
|
3
|
+
|
|
4
|
+
Response for generic workflow cancellation.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`workflowId` | string
|
|
11
|
+
`message` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { WorkflowCancelResponse } from '@knowledge-stack/ksapi'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"workflowId": null,
|
|
21
|
+
"message": null,
|
|
22
|
+
} satisfies WorkflowCancelResponse
|
|
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 WorkflowCancelResponse
|
|
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
|
+
|