@knowledge-stack/ksapi 1.55.0 → 1.57.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 +10 -0
- package/README.md +7 -2
- 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/UsersApi.d.ts +4 -4
- package/dist/apis/UsersApi.js +2 -2
- 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/UsersApi.d.ts +4 -4
- package/dist/esm/apis/UsersApi.js +2 -2
- package/dist/esm/models/CreatePasswordUserRequest.d.ts +12 -0
- package/dist/esm/models/CreatePasswordUserRequest.js +4 -0
- 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/ThreadMessageContent.d.ts +13 -0
- package/dist/esm/models/ThreadMessageContent.js +5 -0
- package/dist/esm/models/UpdateUserRequest.d.ts +13 -1
- package/dist/esm/models/UpdateUserRequest.js +5 -3
- package/dist/esm/models/UserResponse.d.ts +12 -0
- package/dist/esm/models/UserResponse.js +8 -0
- package/dist/esm/models/index.d.ts +5 -0
- package/dist/esm/models/index.js +5 -0
- package/dist/models/CreatePasswordUserRequest.d.ts +12 -0
- package/dist/models/CreatePasswordUserRequest.js +4 -0
- 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/ThreadMessageContent.d.ts +13 -0
- package/dist/models/ThreadMessageContent.js +5 -0
- package/dist/models/UpdateUserRequest.d.ts +13 -1
- package/dist/models/UpdateUserRequest.js +5 -3
- package/dist/models/UserResponse.d.ts +12 -0
- package/dist/models/UserResponse.js +8 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/docs/CreatePasswordUserRequest.md +4 -0
- 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/ReferenceType.md +32 -0
- 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/ThreadMessageContent.md +4 -0
- package/docs/ThreadMessagesApi.md +3 -3
- package/docs/UpdateUserRequest.md +4 -0
- package/docs/UserResponse.md +4 -0
- package/docs/UsersApi.md +1 -1
- package/package.json +1 -1
- package/src/apis/DocumentVersionsApi.ts +14 -4
- package/src/apis/ThreadMessagesApi.ts +6 -6
- package/src/apis/UsersApi.ts +4 -4
- package/src/models/CreatePasswordUserRequest.ts +16 -0
- 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/ThreadMessageContent.ts +23 -0
- package/src/models/UpdateUserRequest.ts +18 -3
- package/src/models/UserResponse.ts +18 -0
- package/src/models/index.ts +5 -0
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
|
|
2
|
+
# ReferenceType
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import type { ReferenceType } from '@knowledge-stack/ksapi'
|
|
14
|
+
|
|
15
|
+
// TODO: Update the object below with actual values
|
|
16
|
+
const example = {
|
|
17
|
+
} satisfies ReferenceType
|
|
18
|
+
|
|
19
|
+
console.log(example)
|
|
20
|
+
|
|
21
|
+
// Convert the instance to a JSON string
|
|
22
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
23
|
+
console.log(exampleJSON)
|
|
24
|
+
|
|
25
|
+
// Parse the JSON string back to an object
|
|
26
|
+
const exampleParsed = JSON.parse(exampleJSON) as ReferenceType
|
|
27
|
+
console.log(exampleParsed)
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
31
|
+
|
|
32
|
+
|
|
@@ -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,
|
|
@@ -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`] |
|
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`defaultTenantId` | string
|
|
10
|
+
`firstName` | string
|
|
11
|
+
`lastName` | string
|
|
10
12
|
|
|
11
13
|
## Example
|
|
12
14
|
|
|
@@ -16,6 +18,8 @@ import type { UpdateUserRequest } from '@knowledge-stack/ksapi'
|
|
|
16
18
|
// TODO: Update the object below with actual values
|
|
17
19
|
const example = {
|
|
18
20
|
"defaultTenantId": null,
|
|
21
|
+
"firstName": null,
|
|
22
|
+
"lastName": null,
|
|
19
23
|
} satisfies UpdateUserRequest
|
|
20
24
|
|
|
21
25
|
console.log(example)
|
package/docs/UserResponse.md
CHANGED
|
@@ -8,6 +8,8 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | string
|
|
10
10
|
`email` | string
|
|
11
|
+
`firstName` | string
|
|
12
|
+
`lastName` | string
|
|
11
13
|
`idpType` | [IdpType](IdpType.md)
|
|
12
14
|
`currentTenantId` | string
|
|
13
15
|
`currentTenantRole` | [TenantUserRole](TenantUserRole.md)
|
|
@@ -22,6 +24,8 @@ import type { UserResponse } from '@knowledge-stack/ksapi'
|
|
|
22
24
|
const example = {
|
|
23
25
|
"id": null,
|
|
24
26
|
"email": null,
|
|
27
|
+
"firstName": null,
|
|
28
|
+
"lastName": null,
|
|
25
29
|
"idpType": null,
|
|
26
30
|
"currentTenantId": null,
|
|
27
31
|
"currentTenantRole": null,
|
package/docs/UsersApi.md
CHANGED
|
@@ -86,7 +86,7 @@ No authorization required
|
|
|
86
86
|
|
|
87
87
|
Update Me Handler
|
|
88
88
|
|
|
89
|
-
Update the user\'s default tenant.
|
|
89
|
+
Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
|
|
90
90
|
|
|
91
91
|
### Example
|
|
92
92
|
|
package/package.json
CHANGED
|
@@ -18,6 +18,7 @@ import type {
|
|
|
18
18
|
ClearVersionContentsResponse,
|
|
19
19
|
DocumentVersionAction,
|
|
20
20
|
DocumentVersionActionResponse,
|
|
21
|
+
DocumentVersionContentTypeFilter,
|
|
21
22
|
DocumentVersionMetadataUpdate,
|
|
22
23
|
DocumentVersionResponse,
|
|
23
24
|
HTTPValidationError,
|
|
@@ -31,6 +32,8 @@ import {
|
|
|
31
32
|
DocumentVersionActionToJSON,
|
|
32
33
|
DocumentVersionActionResponseFromJSON,
|
|
33
34
|
DocumentVersionActionResponseToJSON,
|
|
35
|
+
DocumentVersionContentTypeFilterFromJSON,
|
|
36
|
+
DocumentVersionContentTypeFilterToJSON,
|
|
34
37
|
DocumentVersionMetadataUpdateFromJSON,
|
|
35
38
|
DocumentVersionMetadataUpdateToJSON,
|
|
36
39
|
DocumentVersionResponseFromJSON,
|
|
@@ -77,6 +80,7 @@ export interface GetDocumentVersionRequest {
|
|
|
77
80
|
export interface GetDocumentVersionContentsRequest {
|
|
78
81
|
versionId: string;
|
|
79
82
|
sectionId?: string | null;
|
|
83
|
+
contentType?: DocumentVersionContentTypeFilter;
|
|
80
84
|
limit?: number;
|
|
81
85
|
offset?: number;
|
|
82
86
|
authorization?: string | null;
|
|
@@ -251,6 +255,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
251
255
|
* Creates request options for getDocumentVersionContents without sending the request
|
|
252
256
|
* @param {string} versionId DocumentVersion ID
|
|
253
257
|
* @param {string} [sectionId] Optional section ID to scope traversal to a subtree
|
|
258
|
+
* @param {DocumentVersionContentTypeFilter} [contentType] Filter by content type: SECTION or CHUNK. Omit to return both types.
|
|
254
259
|
* @param {number} [limit] Number of items per page
|
|
255
260
|
* @param {number} [offset] Number of items to skip
|
|
256
261
|
* @param {string} [authorization]
|
|
@@ -261,10 +266,11 @@ export interface DocumentVersionsApiInterface {
|
|
|
261
266
|
getDocumentVersionContentsRequestOpts(requestParameters: GetDocumentVersionContentsRequest): Promise<runtime.RequestOpts>;
|
|
262
267
|
|
|
263
268
|
/**
|
|
264
|
-
* 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\").
|
|
269
|
+
* 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).
|
|
265
270
|
* @summary Get Document Version Contents Handler
|
|
266
271
|
* @param {string} versionId DocumentVersion ID
|
|
267
272
|
* @param {string} [sectionId] Optional section ID to scope traversal to a subtree
|
|
273
|
+
* @param {DocumentVersionContentTypeFilter} [contentType] Filter by content type: SECTION or CHUNK. Omit to return both types.
|
|
268
274
|
* @param {number} [limit] Number of items per page
|
|
269
275
|
* @param {number} [offset] Number of items to skip
|
|
270
276
|
* @param {string} [authorization]
|
|
@@ -276,7 +282,7 @@ export interface DocumentVersionsApiInterface {
|
|
|
276
282
|
getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>>;
|
|
277
283
|
|
|
278
284
|
/**
|
|
279
|
-
* 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\").
|
|
285
|
+
* 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).
|
|
280
286
|
* Get Document Version Contents Handler
|
|
281
287
|
*/
|
|
282
288
|
getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>;
|
|
@@ -632,6 +638,10 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
|
|
|
632
638
|
queryParameters['section_id'] = requestParameters['sectionId'];
|
|
633
639
|
}
|
|
634
640
|
|
|
641
|
+
if (requestParameters['contentType'] != null) {
|
|
642
|
+
queryParameters['content_type'] = requestParameters['contentType'];
|
|
643
|
+
}
|
|
644
|
+
|
|
635
645
|
if (requestParameters['limit'] != null) {
|
|
636
646
|
queryParameters['limit'] = requestParameters['limit'];
|
|
637
647
|
}
|
|
@@ -659,7 +669,7 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
|
|
|
659
669
|
}
|
|
660
670
|
|
|
661
671
|
/**
|
|
662
|
-
* 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\").
|
|
672
|
+
* 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).
|
|
663
673
|
* Get Document Version Contents Handler
|
|
664
674
|
*/
|
|
665
675
|
async getDocumentVersionContentsRaw(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator>> {
|
|
@@ -670,7 +680,7 @@ export class DocumentVersionsApi extends runtime.BaseAPI implements DocumentVers
|
|
|
670
680
|
}
|
|
671
681
|
|
|
672
682
|
/**
|
|
673
|
-
* 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\").
|
|
683
|
+
* 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).
|
|
674
684
|
* Get Document Version Contents Handler
|
|
675
685
|
*/
|
|
676
686
|
async getDocumentVersionContents(requestParameters: GetDocumentVersionContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator> {
|
|
@@ -129,7 +129,7 @@ export interface ThreadMessagesApiInterface {
|
|
|
129
129
|
* Creates request options for listThreadMessages without sending the request
|
|
130
130
|
* @param {string} threadId
|
|
131
131
|
* @param {Date} [before] Cursor for keyset pagination: only return messages with created_at < this value
|
|
132
|
-
* @param {boolean} [withDetails] Include execution steps in response (default
|
|
132
|
+
* @param {boolean} [withDetails] Include execution steps in response (default true)
|
|
133
133
|
* @param {number} [limit] Number of items per page
|
|
134
134
|
* @param {number} [offset] Number of items to skip
|
|
135
135
|
* @param {string} [authorization]
|
|
@@ -140,11 +140,11 @@ export interface ThreadMessagesApiInterface {
|
|
|
140
140
|
listThreadMessagesRequestOpts(requestParameters: ListThreadMessagesRequest): Promise<runtime.RequestOpts>;
|
|
141
141
|
|
|
142
142
|
/**
|
|
143
|
-
* 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=
|
|
143
|
+
* 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.
|
|
144
144
|
* @summary List Thread Messages Handler
|
|
145
145
|
* @param {string} threadId
|
|
146
146
|
* @param {Date} [before] Cursor for keyset pagination: only return messages with created_at < this value
|
|
147
|
-
* @param {boolean} [withDetails] Include execution steps in response (default
|
|
147
|
+
* @param {boolean} [withDetails] Include execution steps in response (default true)
|
|
148
148
|
* @param {number} [limit] Number of items per page
|
|
149
149
|
* @param {number} [offset] Number of items to skip
|
|
150
150
|
* @param {string} [authorization]
|
|
@@ -156,7 +156,7 @@ export interface ThreadMessagesApiInterface {
|
|
|
156
156
|
listThreadMessagesRaw(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadMessageResponse>>;
|
|
157
157
|
|
|
158
158
|
/**
|
|
159
|
-
* 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=
|
|
159
|
+
* 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.
|
|
160
160
|
* List Thread Messages Handler
|
|
161
161
|
*/
|
|
162
162
|
listThreadMessages(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadMessageResponse>;
|
|
@@ -340,7 +340,7 @@ export class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessages
|
|
|
340
340
|
}
|
|
341
341
|
|
|
342
342
|
/**
|
|
343
|
-
* 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=
|
|
343
|
+
* 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.
|
|
344
344
|
* List Thread Messages Handler
|
|
345
345
|
*/
|
|
346
346
|
async listThreadMessagesRaw(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseThreadMessageResponse>> {
|
|
@@ -351,7 +351,7 @@ export class ThreadMessagesApi extends runtime.BaseAPI implements ThreadMessages
|
|
|
351
351
|
}
|
|
352
352
|
|
|
353
353
|
/**
|
|
354
|
-
* 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=
|
|
354
|
+
* 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.
|
|
355
355
|
* List Thread Messages Handler
|
|
356
356
|
*/
|
|
357
357
|
async listThreadMessages(requestParameters: ListThreadMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadMessageResponse> {
|
package/src/apis/UsersApi.ts
CHANGED
|
@@ -83,7 +83,7 @@ export interface UsersApiInterface {
|
|
|
83
83
|
updateMeRequestOpts(requestParameters: UpdateMeRequest): Promise<runtime.RequestOpts>;
|
|
84
84
|
|
|
85
85
|
/**
|
|
86
|
-
* Update the user\'s default tenant.
|
|
86
|
+
* Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
|
|
87
87
|
* @summary Update Me Handler
|
|
88
88
|
* @param {UpdateUserRequest} updateUserRequest
|
|
89
89
|
* @param {string} [authorization]
|
|
@@ -95,7 +95,7 @@ export interface UsersApiInterface {
|
|
|
95
95
|
updateMeRaw(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
|
|
96
96
|
|
|
97
97
|
/**
|
|
98
|
-
* Update the user\'s default tenant.
|
|
98
|
+
* Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
|
|
99
99
|
* Update Me Handler
|
|
100
100
|
*/
|
|
101
101
|
updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
|
|
@@ -184,7 +184,7 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
|
|
|
184
184
|
}
|
|
185
185
|
|
|
186
186
|
/**
|
|
187
|
-
* Update the user\'s default tenant.
|
|
187
|
+
* Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
|
|
188
188
|
* Update Me Handler
|
|
189
189
|
*/
|
|
190
190
|
async updateMeRaw(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
|
|
@@ -195,7 +195,7 @@ export class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
|
|
|
195
195
|
}
|
|
196
196
|
|
|
197
197
|
/**
|
|
198
|
-
* Update the user\'s default tenant.
|
|
198
|
+
* Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
|
|
199
199
|
* Update Me Handler
|
|
200
200
|
*/
|
|
201
201
|
async updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
|
|
@@ -31,6 +31,18 @@ export interface CreatePasswordUserRequest {
|
|
|
31
31
|
* @memberof CreatePasswordUserRequest
|
|
32
32
|
*/
|
|
33
33
|
emailToken: string;
|
|
34
|
+
/**
|
|
35
|
+
* First name
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof CreatePasswordUserRequest
|
|
38
|
+
*/
|
|
39
|
+
firstName?: string | null;
|
|
40
|
+
/**
|
|
41
|
+
* Last name
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof CreatePasswordUserRequest
|
|
44
|
+
*/
|
|
45
|
+
lastName?: string | null;
|
|
34
46
|
}
|
|
35
47
|
|
|
36
48
|
/**
|
|
@@ -54,6 +66,8 @@ export function CreatePasswordUserRequestFromJSONTyped(json: any, ignoreDiscrimi
|
|
|
54
66
|
|
|
55
67
|
'password': json['password'],
|
|
56
68
|
'emailToken': json['email_token'],
|
|
69
|
+
'firstName': json['first_name'] == null ? undefined : json['first_name'],
|
|
70
|
+
'lastName': json['last_name'] == null ? undefined : json['last_name'],
|
|
57
71
|
};
|
|
58
72
|
}
|
|
59
73
|
|
|
@@ -70,6 +84,8 @@ export function CreatePasswordUserRequestToJSONTyped(value?: CreatePasswordUserR
|
|
|
70
84
|
|
|
71
85
|
'password': value['password'],
|
|
72
86
|
'email_token': value['emailToken'],
|
|
87
|
+
'first_name': value['firstName'],
|
|
88
|
+
'last_name': value['lastName'],
|
|
73
89
|
};
|
|
74
90
|
}
|
|
75
91
|
|
|
@@ -41,6 +41,12 @@ import {
|
|
|
41
41
|
* @interface CreateThreadMessageRequest
|
|
42
42
|
*/
|
|
43
43
|
export interface CreateThreadMessageRequest {
|
|
44
|
+
/**
|
|
45
|
+
* Optional caller-supplied ThreadMessage ID for idempotent creates.
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof CreateThreadMessageRequest
|
|
48
|
+
*/
|
|
49
|
+
messageId?: string | null;
|
|
44
50
|
/**
|
|
45
51
|
*
|
|
46
52
|
* @type {MessageRole}
|
|
@@ -82,6 +88,7 @@ export function CreateThreadMessageRequestFromJSONTyped(json: any, ignoreDiscrim
|
|
|
82
88
|
}
|
|
83
89
|
return {
|
|
84
90
|
|
|
91
|
+
'messageId': json['message_id'] == null ? undefined : json['message_id'],
|
|
85
92
|
'role': MessageRoleFromJSON(json['role']),
|
|
86
93
|
'content': ThreadMessageContentFromJSON(json['content']),
|
|
87
94
|
'details': json['details'] == null ? undefined : ThreadMessageDetailsInputFromJSON(json['details']),
|
|
@@ -99,6 +106,7 @@ export function CreateThreadMessageRequestToJSONTyped(value?: CreateThreadMessag
|
|
|
99
106
|
|
|
100
107
|
return {
|
|
101
108
|
|
|
109
|
+
'message_id': value['messageId'],
|
|
102
110
|
'role': MessageRoleToJSON(value['role']),
|
|
103
111
|
'content': ThreadMessageContentToJSON(value['content']),
|
|
104
112
|
'details': ThreadMessageDetailsInputToJSON(value['details']),
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Filter for the type of content rows to return.
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export const DocumentVersionContentTypeFilter = {
|
|
21
|
+
Section: 'SECTION',
|
|
22
|
+
Chunk: 'CHUNK'
|
|
23
|
+
} as const;
|
|
24
|
+
export type DocumentVersionContentTypeFilter = typeof DocumentVersionContentTypeFilter[keyof typeof DocumentVersionContentTypeFilter];
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
export function instanceOfDocumentVersionContentTypeFilter(value: any): boolean {
|
|
28
|
+
for (const key in DocumentVersionContentTypeFilter) {
|
|
29
|
+
if (Object.prototype.hasOwnProperty.call(DocumentVersionContentTypeFilter, key)) {
|
|
30
|
+
if (DocumentVersionContentTypeFilter[key as keyof typeof DocumentVersionContentTypeFilter] === value) {
|
|
31
|
+
return true;
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return false;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export function DocumentVersionContentTypeFilterFromJSON(json: any): DocumentVersionContentTypeFilter {
|
|
39
|
+
return DocumentVersionContentTypeFilterFromJSONTyped(json, false);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export function DocumentVersionContentTypeFilterFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentVersionContentTypeFilter {
|
|
43
|
+
return json as DocumentVersionContentTypeFilter;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export function DocumentVersionContentTypeFilterToJSON(value?: DocumentVersionContentTypeFilter | null): any {
|
|
47
|
+
return value as any;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export function DocumentVersionContentTypeFilterToJSONTyped(value: any, ignoreDiscriminator: boolean): DocumentVersionContentTypeFilter {
|
|
51
|
+
return value as DocumentVersionContentTypeFilter;
|
|
52
|
+
}
|
|
53
|
+
|
|
@@ -13,6 +13,13 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { ResolvedReferenceOutput } from './ResolvedReferenceOutput';
|
|
17
|
+
import {
|
|
18
|
+
ResolvedReferenceOutputFromJSON,
|
|
19
|
+
ResolvedReferenceOutputFromJSONTyped,
|
|
20
|
+
ResolvedReferenceOutputToJSON,
|
|
21
|
+
ResolvedReferenceOutputToJSONTyped,
|
|
22
|
+
} from './ResolvedReferenceOutput';
|
|
16
23
|
import type { EnrichedCitation } from './EnrichedCitation';
|
|
17
24
|
import {
|
|
18
25
|
EnrichedCitationFromJSON,
|
|
@@ -33,12 +40,24 @@ export interface EnrichedThreadMessageContent {
|
|
|
33
40
|
* @memberof EnrichedThreadMessageContent
|
|
34
41
|
*/
|
|
35
42
|
text: string;
|
|
43
|
+
/**
|
|
44
|
+
* Whether this message represents a terminal assistant error
|
|
45
|
+
* @type {boolean}
|
|
46
|
+
* @memberof EnrichedThreadMessageContent
|
|
47
|
+
*/
|
|
48
|
+
isError?: boolean | null;
|
|
36
49
|
/**
|
|
37
50
|
* A list of citations with document context
|
|
38
51
|
* @type {Array<EnrichedCitation>}
|
|
39
52
|
* @memberof EnrichedThreadMessageContent
|
|
40
53
|
*/
|
|
41
54
|
citations?: Array<EnrichedCitation> | null;
|
|
55
|
+
/**
|
|
56
|
+
* Resolved inline references attached to this message
|
|
57
|
+
* @type {Array<ResolvedReferenceOutput>}
|
|
58
|
+
* @memberof EnrichedThreadMessageContent
|
|
59
|
+
*/
|
|
60
|
+
references?: Array<ResolvedReferenceOutput> | null;
|
|
42
61
|
}
|
|
43
62
|
|
|
44
63
|
/**
|
|
@@ -60,7 +79,9 @@ export function EnrichedThreadMessageContentFromJSONTyped(json: any, ignoreDiscr
|
|
|
60
79
|
return {
|
|
61
80
|
|
|
62
81
|
'text': json['text'],
|
|
82
|
+
'isError': json['is_error'] == null ? undefined : json['is_error'],
|
|
63
83
|
'citations': json['citations'] == null ? undefined : ((json['citations'] as Array<any>).map(EnrichedCitationFromJSON)),
|
|
84
|
+
'references': json['references'] == null ? undefined : ((json['references'] as Array<any>).map(ResolvedReferenceOutputFromJSON)),
|
|
64
85
|
};
|
|
65
86
|
}
|
|
66
87
|
|
|
@@ -76,7 +97,9 @@ export function EnrichedThreadMessageContentToJSONTyped(value?: EnrichedThreadMe
|
|
|
76
97
|
return {
|
|
77
98
|
|
|
78
99
|
'text': value['text'],
|
|
100
|
+
'is_error': value['isError'],
|
|
79
101
|
'citations': value['citations'] == null ? undefined : ((value['citations'] as Array<any>).map(EnrichedCitationToJSON)),
|
|
102
|
+
'references': value['references'] == null ? undefined : ((value['references'] as Array<any>).map(ResolvedReferenceOutputToJSON)),
|
|
80
103
|
};
|
|
81
104
|
}
|
|
82
105
|
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Knowledge Stack API
|
|
5
|
+
* Knowledge Stack backend API for authentication and knowledge management
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 0.1.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Supported reference types that do not map to filesystem PartType.
|
|
18
|
+
* @export
|
|
19
|
+
*/
|
|
20
|
+
export const NonFilesystemReferenceType = {
|
|
21
|
+
Image: 'image',
|
|
22
|
+
Memory: 'memory',
|
|
23
|
+
Tag: 'tag',
|
|
24
|
+
User: 'user'
|
|
25
|
+
} as const;
|
|
26
|
+
export type NonFilesystemReferenceType = typeof NonFilesystemReferenceType[keyof typeof NonFilesystemReferenceType];
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
export function instanceOfNonFilesystemReferenceType(value: any): boolean {
|
|
30
|
+
for (const key in NonFilesystemReferenceType) {
|
|
31
|
+
if (Object.prototype.hasOwnProperty.call(NonFilesystemReferenceType, key)) {
|
|
32
|
+
if (NonFilesystemReferenceType[key as keyof typeof NonFilesystemReferenceType] === value) {
|
|
33
|
+
return true;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
return false;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
export function NonFilesystemReferenceTypeFromJSON(json: any): NonFilesystemReferenceType {
|
|
41
|
+
return NonFilesystemReferenceTypeFromJSONTyped(json, false);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export function NonFilesystemReferenceTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): NonFilesystemReferenceType {
|
|
45
|
+
return json as NonFilesystemReferenceType;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
export function NonFilesystemReferenceTypeToJSON(value?: NonFilesystemReferenceType | null): any {
|
|
49
|
+
return value as any;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
export function NonFilesystemReferenceTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): NonFilesystemReferenceType {
|
|
53
|
+
return value as NonFilesystemReferenceType;
|
|
54
|
+
}
|
|
55
|
+
|