@knowledge-stack/ksapi 1.72.4 → 1.78.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 +36 -4
- package/README.md +33 -11
- package/dist/apis/AgentApi.d.ts +114 -0
- package/dist/apis/AgentApi.js +156 -0
- package/dist/apis/ChunksApi.d.ts +19 -16
- package/dist/apis/ChunksApi.js +9 -6
- package/dist/apis/DocumentsApi.d.ts +4 -4
- package/dist/apis/DocumentsApi.js +2 -2
- package/dist/apis/FoldersApi.d.ts +4 -4
- package/dist/apis/FoldersApi.js +2 -2
- package/dist/apis/InvitesApi.d.ts +54 -7
- package/dist/apis/InvitesApi.js +51 -2
- package/dist/apis/PublicApi.d.ts +59 -0
- package/dist/apis/PublicApi.js +103 -0
- package/dist/apis/SubscriptionsApi.d.ts +120 -0
- package/dist/apis/SubscriptionsApi.js +162 -0
- package/dist/apis/TenantsApi.d.ts +45 -1
- package/dist/apis/TenantsApi.js +44 -0
- package/dist/apis/ThreadsApi.d.ts +4 -4
- package/dist/apis/ThreadsApi.js +2 -2
- package/dist/apis/index.d.ts +3 -0
- package/dist/apis/index.js +3 -0
- package/dist/esm/apis/AgentApi.d.ts +114 -0
- package/dist/esm/apis/AgentApi.js +119 -0
- package/dist/esm/apis/ChunksApi.d.ts +19 -16
- package/dist/esm/apis/ChunksApi.js +9 -6
- package/dist/esm/apis/DocumentsApi.d.ts +4 -4
- package/dist/esm/apis/DocumentsApi.js +2 -2
- package/dist/esm/apis/FoldersApi.d.ts +4 -4
- package/dist/esm/apis/FoldersApi.js +2 -2
- package/dist/esm/apis/InvitesApi.d.ts +54 -7
- package/dist/esm/apis/InvitesApi.js +52 -3
- package/dist/esm/apis/PublicApi.d.ts +59 -0
- package/dist/esm/apis/PublicApi.js +66 -0
- package/dist/esm/apis/SubscriptionsApi.d.ts +120 -0
- package/dist/esm/apis/SubscriptionsApi.js +125 -0
- package/dist/esm/apis/TenantsApi.d.ts +45 -1
- package/dist/esm/apis/TenantsApi.js +45 -1
- package/dist/esm/apis/ThreadsApi.d.ts +4 -4
- package/dist/esm/apis/ThreadsApi.js +2 -2
- package/dist/esm/apis/index.d.ts +3 -0
- package/dist/esm/apis/index.js +3 -0
- package/dist/esm/models/AcceptInviteResponse.d.ts +6 -0
- package/dist/esm/models/AcceptInviteResponse.js +2 -0
- package/dist/esm/models/AskRequest.d.ts +47 -0
- package/dist/esm/models/AskRequest.js +44 -0
- package/dist/esm/models/AskResponse.d.ts +47 -0
- package/dist/esm/models/AskResponse.js +44 -0
- package/dist/esm/models/ChangeSubscriptionRequest.d.ts +53 -0
- package/dist/esm/models/ChangeSubscriptionRequest.js +53 -0
- package/dist/esm/models/CheckpointDetails.d.ts +96 -0
- package/dist/esm/models/CheckpointDetails.js +91 -0
- package/dist/esm/models/ChunkBulkResponse.d.ts +3 -3
- package/dist/esm/models/ChunkBulkResponse.js +3 -3
- package/dist/esm/models/ChunkContentItem.d.ts +3 -3
- package/dist/esm/models/ChunkContentItem.js +3 -3
- package/dist/esm/models/{ChunkMetadataInput.d.ts → ChunkMetadata.d.ts} +23 -23
- package/dist/esm/models/{ChunkMetadataInput.js → ChunkMetadata.js} +9 -9
- package/dist/esm/models/ChunkNeighborsResponse.d.ts +18 -0
- package/dist/esm/models/ChunkNeighborsResponse.js +10 -0
- package/dist/esm/models/ChunkResponse.d.ts +3 -3
- package/dist/esm/models/ChunkResponse.js +3 -3
- package/dist/esm/models/CreateChunkRequest.d.ts +3 -3
- package/dist/esm/models/CreateChunkRequest.js +3 -3
- package/dist/esm/models/DocumentResponse.d.ts +6 -0
- package/dist/esm/models/DocumentResponse.js +4 -0
- package/dist/esm/models/DocumentVersionMetadata.d.ts +24 -0
- package/dist/esm/models/DocumentVersionMetadata.js +8 -0
- package/dist/esm/models/DocumentVersionMetadataUpdate.d.ts +24 -0
- package/dist/esm/models/DocumentVersionMetadataUpdate.js +8 -0
- package/dist/esm/models/ExtractRequest.d.ts +61 -0
- package/dist/esm/models/ExtractRequest.js +48 -0
- package/dist/esm/models/ExtractResponse.d.ts +49 -0
- package/dist/esm/models/ExtractResponse.js +44 -0
- package/dist/esm/models/FeaturesResponse.d.ts +12 -0
- package/dist/esm/models/FeaturesResponse.js +8 -0
- package/dist/esm/models/FolderResponse.d.ts +6 -0
- package/dist/esm/models/FolderResponse.js +4 -0
- package/dist/esm/models/IdpType.d.ts +2 -0
- package/dist/esm/models/IdpType.js +2 -0
- package/dist/esm/models/InviteLinkSettingsRequest.d.ts +70 -0
- package/dist/esm/models/InviteLinkSettingsRequest.js +58 -0
- package/dist/esm/models/InviteLinkSettingsResponse.d.ts +67 -0
- package/dist/esm/models/InviteLinkSettingsResponse.js +57 -0
- package/dist/esm/models/InviteResponse.d.ts +6 -0
- package/dist/esm/models/InviteResponse.js +2 -0
- package/dist/esm/models/InviteUserRequest.d.ts +6 -0
- package/dist/esm/models/InviteUserRequest.js +8 -1
- package/dist/esm/models/LineageNodeResponse.d.ts +3 -3
- package/dist/esm/models/LineageNodeResponse.js +3 -3
- package/dist/esm/models/MeteredQuotaStatus.d.ts +72 -0
- package/dist/esm/models/MeteredQuotaStatus.js +61 -0
- package/dist/esm/models/PathPartAncestorItem.d.ts +6 -0
- package/dist/esm/models/PathPartAncestorItem.js +4 -0
- package/dist/esm/models/PathPartResponse.d.ts +6 -0
- package/dist/esm/models/PathPartResponse.js +4 -0
- package/dist/esm/models/PipelineStatus.d.ts +1 -0
- package/dist/esm/models/PipelineStatus.js +2 -1
- package/dist/esm/models/ScoredChunkResponse.d.ts +3 -3
- package/dist/esm/models/ScoredChunkResponse.js +3 -3
- package/dist/esm/models/SeatQuotaStatus.d.ts +55 -0
- package/dist/esm/models/SeatQuotaStatus.js +48 -0
- package/dist/esm/models/SubscriptionPlanResponse.d.ts +101 -0
- package/dist/esm/models/SubscriptionPlanResponse.js +76 -0
- package/dist/esm/models/TenantQuotaStateResponse.d.ts +55 -0
- package/dist/esm/models/TenantQuotaStateResponse.js +50 -0
- package/dist/esm/models/TenantResponse.d.ts +12 -0
- package/dist/esm/models/TenantResponse.js +14 -1
- package/dist/esm/models/TenantSettingsResponse.d.ts +7 -0
- package/dist/esm/models/TenantSettingsResponse.js +5 -0
- package/dist/esm/models/TenantSettingsUpdate.d.ts +7 -0
- package/dist/esm/models/TenantSettingsUpdate.js +3 -0
- package/dist/esm/models/ThreadMessageDetailsInput.d.ts +7 -0
- package/dist/esm/models/ThreadMessageDetailsInput.js +3 -0
- package/dist/esm/models/ThreadMessageDetailsOutput.d.ts +7 -0
- package/dist/esm/models/ThreadMessageDetailsOutput.js +3 -0
- package/dist/esm/models/UpdateChunkMetadataRequest.d.ts +3 -3
- package/dist/esm/models/UpdateChunkMetadataRequest.js +3 -3
- package/dist/esm/models/UpdateDocumentRequest.d.ts +7 -1
- package/dist/esm/models/UpdateDocumentRequest.js +2 -0
- package/dist/esm/models/UpdateFolderRequest.d.ts +7 -1
- package/dist/esm/models/UpdateFolderRequest.js +2 -0
- package/dist/esm/models/UpdateInviteRequest.d.ts +53 -0
- package/dist/esm/models/UpdateInviteRequest.js +49 -0
- package/dist/esm/models/UsageMetric.d.ts +26 -0
- package/dist/esm/models/UsageMetric.js +44 -0
- package/dist/esm/models/index.d.ts +15 -2
- package/dist/esm/models/index.js +15 -2
- package/dist/models/AcceptInviteResponse.d.ts +6 -0
- package/dist/models/AcceptInviteResponse.js +2 -0
- package/dist/models/AskRequest.d.ts +47 -0
- package/dist/models/AskRequest.js +52 -0
- package/dist/models/AskResponse.d.ts +47 -0
- package/dist/models/AskResponse.js +52 -0
- package/dist/models/ChangeSubscriptionRequest.d.ts +53 -0
- package/dist/models/ChangeSubscriptionRequest.js +61 -0
- package/dist/models/CheckpointDetails.d.ts +96 -0
- package/dist/models/CheckpointDetails.js +99 -0
- package/dist/models/ChunkBulkResponse.d.ts +3 -3
- package/dist/models/ChunkBulkResponse.js +3 -3
- package/dist/models/ChunkContentItem.d.ts +3 -3
- package/dist/models/ChunkContentItem.js +3 -3
- package/dist/models/{ChunkMetadataInput.d.ts → ChunkMetadata.d.ts} +23 -23
- package/dist/models/{ChunkMetadataInput.js → ChunkMetadata.js} +15 -15
- package/dist/models/ChunkNeighborsResponse.d.ts +18 -0
- package/dist/models/ChunkNeighborsResponse.js +10 -0
- package/dist/models/ChunkResponse.d.ts +3 -3
- package/dist/models/ChunkResponse.js +3 -3
- package/dist/models/CreateChunkRequest.d.ts +3 -3
- package/dist/models/CreateChunkRequest.js +3 -3
- package/dist/models/DocumentResponse.d.ts +6 -0
- package/dist/models/DocumentResponse.js +4 -0
- package/dist/models/DocumentVersionMetadata.d.ts +24 -0
- package/dist/models/DocumentVersionMetadata.js +8 -0
- package/dist/models/DocumentVersionMetadataUpdate.d.ts +24 -0
- package/dist/models/DocumentVersionMetadataUpdate.js +8 -0
- package/dist/models/ExtractRequest.d.ts +61 -0
- package/dist/models/ExtractRequest.js +56 -0
- package/dist/models/ExtractResponse.d.ts +49 -0
- package/dist/models/ExtractResponse.js +52 -0
- package/dist/models/FeaturesResponse.d.ts +12 -0
- package/dist/models/FeaturesResponse.js +8 -0
- package/dist/models/FolderResponse.d.ts +6 -0
- package/dist/models/FolderResponse.js +4 -0
- package/dist/models/IdpType.d.ts +2 -0
- package/dist/models/IdpType.js +2 -0
- package/dist/models/InviteLinkSettingsRequest.d.ts +70 -0
- package/dist/models/InviteLinkSettingsRequest.js +66 -0
- package/dist/models/InviteLinkSettingsResponse.d.ts +67 -0
- package/dist/models/InviteLinkSettingsResponse.js +65 -0
- package/dist/models/InviteResponse.d.ts +6 -0
- package/dist/models/InviteResponse.js +2 -0
- package/dist/models/InviteUserRequest.d.ts +6 -0
- package/dist/models/InviteUserRequest.js +8 -1
- package/dist/models/LineageNodeResponse.d.ts +3 -3
- package/dist/models/LineageNodeResponse.js +3 -3
- package/dist/models/MeteredQuotaStatus.d.ts +72 -0
- package/dist/models/MeteredQuotaStatus.js +69 -0
- package/dist/models/PathPartAncestorItem.d.ts +6 -0
- package/dist/models/PathPartAncestorItem.js +4 -0
- package/dist/models/PathPartResponse.d.ts +6 -0
- package/dist/models/PathPartResponse.js +4 -0
- package/dist/models/PipelineStatus.d.ts +1 -0
- package/dist/models/PipelineStatus.js +2 -1
- package/dist/models/ScoredChunkResponse.d.ts +3 -3
- package/dist/models/ScoredChunkResponse.js +3 -3
- package/dist/models/SeatQuotaStatus.d.ts +55 -0
- package/dist/models/SeatQuotaStatus.js +56 -0
- package/dist/models/SubscriptionPlanResponse.d.ts +101 -0
- package/dist/models/SubscriptionPlanResponse.js +84 -0
- package/dist/models/TenantQuotaStateResponse.d.ts +55 -0
- package/dist/models/TenantQuotaStateResponse.js +58 -0
- package/dist/models/TenantResponse.d.ts +12 -0
- package/dist/models/TenantResponse.js +14 -1
- package/dist/models/TenantSettingsResponse.d.ts +7 -0
- package/dist/models/TenantSettingsResponse.js +5 -0
- package/dist/models/TenantSettingsUpdate.d.ts +7 -0
- package/dist/models/TenantSettingsUpdate.js +3 -0
- package/dist/models/ThreadMessageDetailsInput.d.ts +7 -0
- package/dist/models/ThreadMessageDetailsInput.js +3 -0
- package/dist/models/ThreadMessageDetailsOutput.d.ts +7 -0
- package/dist/models/ThreadMessageDetailsOutput.js +3 -0
- package/dist/models/UpdateChunkMetadataRequest.d.ts +3 -3
- package/dist/models/UpdateChunkMetadataRequest.js +3 -3
- package/dist/models/UpdateDocumentRequest.d.ts +7 -1
- package/dist/models/UpdateDocumentRequest.js +2 -0
- package/dist/models/UpdateFolderRequest.d.ts +7 -1
- package/dist/models/UpdateFolderRequest.js +2 -0
- package/dist/models/UpdateInviteRequest.d.ts +53 -0
- package/dist/models/UpdateInviteRequest.js +57 -0
- package/dist/models/UsageMetric.d.ts +26 -0
- package/dist/models/UsageMetric.js +52 -0
- package/dist/models/index.d.ts +15 -2
- package/dist/models/index.js +15 -2
- package/docs/AcceptInviteResponse.md +2 -0
- package/docs/AgentApi.md +158 -0
- package/docs/AskRequest.md +35 -0
- package/docs/AskResponse.md +35 -0
- package/docs/AuthApi.md +2 -2
- package/docs/ChangeSubscriptionRequest.md +37 -0
- package/docs/CheckpointDetails.md +49 -0
- package/docs/ChunkBulkResponse.md +1 -1
- package/docs/ChunkContentItem.md +1 -1
- package/docs/{ChunkMetadataInput.md → ChunkMetadata.md} +4 -4
- package/docs/ChunkNeighborsResponse.md +6 -0
- package/docs/ChunkResponse.md +1 -1
- package/docs/ChunksApi.md +13 -10
- package/docs/CreateChunkRequest.md +1 -1
- package/docs/DocumentResponse.md +2 -0
- package/docs/DocumentVersionMetadata.md +8 -0
- package/docs/DocumentVersionMetadataUpdate.md +8 -0
- package/docs/DocumentsApi.md +1 -1
- package/docs/ExtractRequest.md +39 -0
- package/docs/ExtractResponse.md +35 -0
- package/docs/FeaturesResponse.md +4 -0
- package/docs/FolderResponse.md +2 -0
- package/docs/FolderResponseOrDocumentResponse.md +2 -0
- package/docs/FoldersApi.md +1 -1
- package/docs/InviteLinkSettingsRequest.md +39 -0
- package/docs/InviteLinkSettingsResponse.md +39 -0
- package/docs/InviteResponse.md +2 -0
- package/docs/InviteUserRequest.md +2 -0
- package/docs/InvitesApi.md +81 -3
- package/docs/LineageNodeResponse.md +1 -1
- package/docs/MeteredQuotaStatus.md +43 -0
- package/docs/PathPartAncestorItem.md +2 -0
- package/docs/PathPartResponse.md +2 -0
- package/docs/PublicApi.md +68 -0
- package/docs/ScoredChunkResponse.md +1 -1
- package/docs/SeatQuotaStatus.md +37 -0
- package/docs/SectionContentItemOrChunkContentItem.md +1 -1
- package/docs/SubscriptionPlanResponse.md +51 -0
- package/docs/SubscriptionsApi.md +164 -0
- package/docs/TenantQuotaStateResponse.md +37 -0
- package/docs/TenantResponse.md +4 -0
- package/docs/TenantSettingsResponse.md +2 -0
- package/docs/TenantSettingsUpdate.md +2 -0
- package/docs/TenantsApi.md +75 -0
- package/docs/ThreadMessageDetailsInput.md +2 -0
- package/docs/ThreadMessageDetailsOutput.md +2 -0
- package/docs/ThreadsApi.md +1 -1
- package/docs/UpdateChunkMetadataRequest.md +1 -1
- package/docs/UpdateDocumentRequest.md +3 -1
- package/docs/UpdateFolderRequest.md +3 -1
- package/docs/UpdateInviteRequest.md +37 -0
- package/docs/UsageMetric.md +32 -0
- package/package.json +1 -1
- package/src/apis/AgentApi.ts +225 -0
- package/src/apis/ChunksApi.ts +27 -17
- package/src/apis/DocumentsApi.ts +4 -4
- package/src/apis/FoldersApi.ts +4 -4
- package/src/apis/InvitesApi.ts +107 -6
- package/src/apis/PublicApi.ts +100 -0
- package/src/apis/SubscriptionsApi.ts +238 -0
- package/src/apis/TenantsApi.ts +88 -0
- package/src/apis/ThreadsApi.ts +4 -4
- package/src/apis/index.ts +3 -0
- package/src/models/AcceptInviteResponse.ts +8 -0
- package/src/models/AskRequest.ts +83 -0
- package/src/models/AskResponse.ts +83 -0
- package/src/models/ChangeSubscriptionRequest.ts +96 -0
- package/src/models/CheckpointDetails.ts +169 -0
- package/src/models/ChunkBulkResponse.ts +11 -11
- package/src/models/ChunkContentItem.ts +10 -10
- package/src/models/{ChunkMetadataInput.ts → ChunkMetadata.ts} +25 -25
- package/src/models/ChunkNeighborsResponse.ts +26 -0
- package/src/models/ChunkResponse.ts +11 -11
- package/src/models/CreateChunkRequest.ts +10 -10
- package/src/models/DocumentResponse.ts +9 -0
- package/src/models/DocumentVersionMetadata.ts +32 -0
- package/src/models/DocumentVersionMetadataUpdate.ts +32 -0
- package/src/models/ExtractRequest.ts +99 -0
- package/src/models/ExtractResponse.ts +83 -0
- package/src/models/FeaturesResponse.ts +18 -0
- package/src/models/FolderResponse.ts +9 -0
- package/src/models/IdpType.ts +2 -0
- package/src/models/InviteLinkSettingsRequest.ts +116 -0
- package/src/models/InviteLinkSettingsResponse.ts +111 -0
- package/src/models/InviteResponse.ts +8 -0
- package/src/models/InviteUserRequest.ts +12 -0
- package/src/models/LineageNodeResponse.ts +10 -10
- package/src/models/MeteredQuotaStatus.ts +129 -0
- package/src/models/PathPartAncestorItem.ts +9 -0
- package/src/models/PathPartResponse.ts +9 -0
- package/src/models/PipelineStatus.ts +2 -1
- package/src/models/ScoredChunkResponse.ts +11 -11
- package/src/models/SeatQuotaStatus.ts +94 -0
- package/src/models/SubscriptionPlanResponse.ts +161 -0
- package/src/models/TenantQuotaStateResponse.ts +107 -0
- package/src/models/TenantResponse.ts +22 -0
- package/src/models/TenantSettingsResponse.ts +16 -0
- package/src/models/TenantSettingsUpdate.ts +15 -0
- package/src/models/ThreadMessageDetailsInput.ts +15 -0
- package/src/models/ThreadMessageDetailsOutput.ts +15 -0
- package/src/models/UpdateChunkMetadataRequest.ts +10 -10
- package/src/models/UpdateDocumentRequest.ts +9 -1
- package/src/models/UpdateFolderRequest.ts +9 -1
- package/src/models/UpdateInviteRequest.ts +94 -0
- package/src/models/UsageMetric.ts +54 -0
- package/src/models/index.ts +15 -2
- package/dist/esm/models/ChunkMetadataOutput.d.ts +0 -135
- package/dist/esm/models/ChunkMetadataOutput.js +0 -70
- package/dist/models/ChunkMetadataOutput.d.ts +0 -135
- package/dist/models/ChunkMetadataOutput.js +0 -78
- package/docs/ChunkMetadataOutput.md +0 -61
- package/src/models/ChunkMetadataOutput.ts +0 -203
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# ChunkMetadata
|
|
3
3
|
|
|
4
4
|
Metadata for a chunk including source document references.
|
|
5
5
|
|
|
@@ -25,7 +25,7 @@ Name | Type
|
|
|
25
25
|
## Example
|
|
26
26
|
|
|
27
27
|
```typescript
|
|
28
|
-
import type {
|
|
28
|
+
import type { ChunkMetadata } from '@knowledge-stack/ksapi'
|
|
29
29
|
|
|
30
30
|
// TODO: Update the object below with actual values
|
|
31
31
|
const example = {
|
|
@@ -43,7 +43,7 @@ const example = {
|
|
|
43
43
|
"formulas": null,
|
|
44
44
|
"keyCells": null,
|
|
45
45
|
"namedRanges": null,
|
|
46
|
-
} satisfies
|
|
46
|
+
} satisfies ChunkMetadata
|
|
47
47
|
|
|
48
48
|
console.log(example)
|
|
49
49
|
|
|
@@ -52,7 +52,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
52
52
|
console.log(exampleJSON)
|
|
53
53
|
|
|
54
54
|
// Parse the JSON string back to an object
|
|
55
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
55
|
+
const exampleParsed = JSON.parse(exampleJSON) as ChunkMetadata
|
|
56
56
|
console.log(exampleParsed)
|
|
57
57
|
```
|
|
58
58
|
|
|
@@ -9,6 +9,9 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`items` | [Array<SectionContentItemOrChunkContentItem>](SectionContentItemOrChunkContentItem.md)
|
|
11
11
|
`anchorIndex` | number
|
|
12
|
+
`anchorOffset` | number
|
|
13
|
+
`total` | number
|
|
14
|
+
`documentVersionId` | string
|
|
12
15
|
|
|
13
16
|
## Example
|
|
14
17
|
|
|
@@ -19,6 +22,9 @@ import type { ChunkNeighborsResponse } from '@knowledge-stack/ksapi'
|
|
|
19
22
|
const example = {
|
|
20
23
|
"items": null,
|
|
21
24
|
"anchorIndex": null,
|
|
25
|
+
"anchorOffset": null,
|
|
26
|
+
"total": null,
|
|
27
|
+
"documentVersionId": null,
|
|
22
28
|
} satisfies ChunkNeighborsResponse
|
|
23
29
|
|
|
24
30
|
console.log(example)
|
package/docs/ChunkResponse.md
CHANGED
|
@@ -12,7 +12,7 @@ Name | Type
|
|
|
12
12
|
`contentId` | string
|
|
13
13
|
`content` | string
|
|
14
14
|
`chunkType` | [ChunkType](ChunkType.md)
|
|
15
|
-
`chunkMetadata` | [
|
|
15
|
+
`chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
|
|
16
16
|
`numTokens` | number
|
|
17
17
|
`parentPathId` | string
|
|
18
18
|
`prevSiblingPathId` | string
|
package/docs/ChunksApi.md
CHANGED
|
@@ -243,11 +243,11 @@ No authorization required
|
|
|
243
243
|
|
|
244
244
|
## getChunkNeighbors
|
|
245
245
|
|
|
246
|
-
> ChunkNeighborsResponse getChunkNeighbors(chunkId, prev, next,
|
|
246
|
+
> ChunkNeighborsResponse getChunkNeighbors(chunkId, prev, next, contentType, withinSection, authorization, ksUat)
|
|
247
247
|
|
|
248
248
|
Get Chunk Neighbors Handler
|
|
249
249
|
|
|
250
|
-
|
|
250
|
+
Return a window of items around an anchor chunk. Two traversal modes: - ``within_section=true`` (default): walks the sibling linked-list under the anchor\'s parent. Stops at items outside ``content_type`` when set. Authorized by the anchor\'s path read permission alone. - ``within_section=false``: walks the full document version in depth-first order and slices a window around the anchor. Crosses section boundaries. Additionally requires read permission on the enclosing document version\'s path (matching the ``/v1/document_versions/{id}/contents`` endpoint). USERs whose path permissions are scoped to a sub-section of the version will get ``403`` and should use ``within_section=true``. ``content_type=SECTION`` is rejected with ``400``: the anchor is always a chunk, so a SECTION-only filter would exclude it.
|
|
251
251
|
|
|
252
252
|
### Example
|
|
253
253
|
|
|
@@ -265,12 +265,14 @@ async function example() {
|
|
|
265
265
|
const body = {
|
|
266
266
|
// string
|
|
267
267
|
chunkId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
268
|
-
// number | Number of preceding
|
|
268
|
+
// number | Number of preceding items to include (max 50). (optional)
|
|
269
269
|
prev: 56,
|
|
270
|
-
// number | Number of succeeding
|
|
270
|
+
// number | Number of succeeding items to include (max 50). (optional)
|
|
271
271
|
next: 56,
|
|
272
|
-
//
|
|
273
|
-
|
|
272
|
+
// PartType | Filter by content type: SECTION or CHUNK. Omit to return both. SECTION is rejected when the anchor is a chunk (always). (optional)
|
|
273
|
+
contentType: ...,
|
|
274
|
+
// boolean | When true (default), traverse only the anchor\'s sibling chain under the same parent. When false, traverse the entire document version in DFS order, crossing section boundaries. (optional)
|
|
275
|
+
withinSection: true,
|
|
274
276
|
// string (optional)
|
|
275
277
|
authorization: authorization_example,
|
|
276
278
|
// string (optional)
|
|
@@ -295,9 +297,10 @@ example().catch(console.error);
|
|
|
295
297
|
| Name | Type | Description | Notes |
|
|
296
298
|
|------------- | ------------- | ------------- | -------------|
|
|
297
299
|
| **chunkId** | `string` | | [Defaults to `undefined`] |
|
|
298
|
-
| **prev** | `number` | Number of preceding
|
|
299
|
-
| **next** | `number` | Number of succeeding
|
|
300
|
-
| **
|
|
300
|
+
| **prev** | `number` | Number of preceding items to include (max 50). | [Optional] [Defaults to `1`] |
|
|
301
|
+
| **next** | `number` | Number of succeeding items to include (max 50). | [Optional] [Defaults to `1`] |
|
|
302
|
+
| **contentType** | `PartType` | Filter by content type: SECTION or CHUNK. Omit to return both. SECTION is rejected when the anchor is a chunk (always). | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DOCUMENT_VERSION, SECTION, CHUNK, THREAD, THREAD_MESSAGE, WORKFLOW_DEFINITION, WORKFLOW_RUN] |
|
|
303
|
+
| **withinSection** | `boolean` | When true (default), traverse only the anchor\'s sibling chain under the same parent. When false, traverse the entire document version in DFS order, crossing section boundaries. | [Optional] [Defaults to `true`] |
|
|
301
304
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
302
305
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
303
306
|
|
|
@@ -478,7 +481,7 @@ No authorization required
|
|
|
478
481
|
|
|
479
482
|
Search Chunks Handler
|
|
480
483
|
|
|
481
|
-
Search over chunks using dense vector, BM25 full-text, or hybrid retrieval. Combines search with path-based authorization and optional metadata filters. Uses Qdrant for retrieval and hydrates the matched chunks from Postgres.
|
|
484
|
+
Search over chunks using dense vector, BM25 full-text, or hybrid retrieval. Combines search with path-based authorization and optional metadata filters. Uses Qdrant for retrieval and hydrates the matched chunks from Postgres. **Billing note.** SEARCH consume runs *before* path-permission resolution. A request that resolves to an empty permission set (caller has read access to nothing in the requested scope) returns ``[]`` cleanly — without raising — so it is **not** refunded. This is intentional: differential billing for a no-results case would leak access shape to the caller. Callers concerned about charged no-op searches should validate path access client-side first.
|
|
482
485
|
|
|
483
486
|
### Example
|
|
484
487
|
|
|
@@ -10,7 +10,7 @@ Name | Type
|
|
|
10
10
|
`parentPathId` | string
|
|
11
11
|
`content` | string
|
|
12
12
|
`chunkType` | [ChunkType](ChunkType.md)
|
|
13
|
-
`chunkMetadata` | [
|
|
13
|
+
`chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
|
|
14
14
|
`prevSiblingPathId` | string
|
|
15
15
|
|
|
16
16
|
## Example
|
package/docs/DocumentResponse.md
CHANGED
|
@@ -18,6 +18,7 @@ Name | Type
|
|
|
18
18
|
`activeVersion` | [DocumentVersionResponse](DocumentVersionResponse.md)
|
|
19
19
|
`materializedPath` | string
|
|
20
20
|
`systemManaged` | boolean
|
|
21
|
+
`excludeFromQdrant` | boolean
|
|
21
22
|
`tenantId` | string
|
|
22
23
|
`createdAt` | Date
|
|
23
24
|
`updatedAt` | Date
|
|
@@ -41,6 +42,7 @@ const example = {
|
|
|
41
42
|
"activeVersion": null,
|
|
42
43
|
"materializedPath": null,
|
|
43
44
|
"systemManaged": null,
|
|
45
|
+
"excludeFromQdrant": null,
|
|
44
46
|
"tenantId": null,
|
|
45
47
|
"createdAt": null,
|
|
46
48
|
"updatedAt": null,
|
|
@@ -20,6 +20,10 @@ Name | Type
|
|
|
20
20
|
`xlsxNamedRanges` | Array<{ [key: string]: any; }>
|
|
21
21
|
`xlsxKpiCatalog` | Array<{ [key: string]: any; }>
|
|
22
22
|
`informationStatistics` | [InformationStatistics](InformationStatistics.md)
|
|
23
|
+
`quotaCharged` | boolean
|
|
24
|
+
`quotaPageCount` | number
|
|
25
|
+
`quotaIdempotencyKey` | string
|
|
26
|
+
`fileMd5` | string
|
|
23
27
|
|
|
24
28
|
## Example
|
|
25
29
|
|
|
@@ -41,6 +45,10 @@ const example = {
|
|
|
41
45
|
"xlsxNamedRanges": null,
|
|
42
46
|
"xlsxKpiCatalog": null,
|
|
43
47
|
"informationStatistics": null,
|
|
48
|
+
"quotaCharged": null,
|
|
49
|
+
"quotaPageCount": null,
|
|
50
|
+
"quotaIdempotencyKey": null,
|
|
51
|
+
"fileMd5": null,
|
|
44
52
|
} satisfies DocumentVersionMetadata
|
|
45
53
|
|
|
46
54
|
console.log(example)
|
|
@@ -23,6 +23,10 @@ Name | Type
|
|
|
23
23
|
`xlsxNamedRanges` | Array<{ [key: string]: any; }>
|
|
24
24
|
`xlsxKpiCatalog` | Array<{ [key: string]: any; }>
|
|
25
25
|
`informationStatistics` | [InformationStatistics](InformationStatistics.md)
|
|
26
|
+
`quotaCharged` | boolean
|
|
27
|
+
`quotaPageCount` | number
|
|
28
|
+
`quotaIdempotencyKey` | string
|
|
29
|
+
`fileMd5` | string
|
|
26
30
|
|
|
27
31
|
## Example
|
|
28
32
|
|
|
@@ -47,6 +51,10 @@ const example = {
|
|
|
47
51
|
"xlsxNamedRanges": null,
|
|
48
52
|
"xlsxKpiCatalog": null,
|
|
49
53
|
"informationStatistics": null,
|
|
54
|
+
"quotaCharged": null,
|
|
55
|
+
"quotaPageCount": null,
|
|
56
|
+
"quotaIdempotencyKey": null,
|
|
57
|
+
"fileMd5": null,
|
|
50
58
|
} satisfies DocumentVersionMetadataUpdate
|
|
51
59
|
|
|
52
60
|
console.log(example)
|
package/docs/DocumentsApi.md
CHANGED
|
@@ -512,7 +512,7 @@ No authorization required
|
|
|
512
512
|
|
|
513
513
|
Update Document Handler
|
|
514
514
|
|
|
515
|
-
Update a document (rename, move,
|
|
515
|
+
Update a document (rename, move, change active version, Qdrant exclusion). To rename: provide `name` field. To move: provide `parent_path_part_id` field. To change active version: provide `active_version_id` field. To toggle Qdrant exclusion: provide `exclude_from_qdrant` field. Any combination can be sent in a single request.
|
|
516
516
|
|
|
517
517
|
### Example
|
|
518
518
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# ExtractRequest
|
|
3
|
+
|
|
4
|
+
Request body for POST /v1/agent/extract.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`prompt` | string
|
|
11
|
+
`schemaPathPartId` | string
|
|
12
|
+
`outputSchema` | { [key: string]: any; }
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { ExtractRequest } from '@knowledge-stack/ksapi'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"prompt": null,
|
|
22
|
+
"schemaPathPartId": null,
|
|
23
|
+
"outputSchema": null,
|
|
24
|
+
} satisfies ExtractRequest
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as ExtractRequest
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
|
|
2
|
+
# ExtractResponse
|
|
3
|
+
|
|
4
|
+
Response body for POST /v1/agent/extract.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`structured` | { [key: string]: any; }
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { ExtractResponse } from '@knowledge-stack/ksapi'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"structured": null,
|
|
20
|
+
} satisfies ExtractResponse
|
|
21
|
+
|
|
22
|
+
console.log(example)
|
|
23
|
+
|
|
24
|
+
// Convert the instance to a JSON string
|
|
25
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
26
|
+
console.log(exampleJSON)
|
|
27
|
+
|
|
28
|
+
// Parse the JSON string back to an object
|
|
29
|
+
const exampleParsed = JSON.parse(exampleJSON) as ExtractResponse
|
|
30
|
+
console.log(exampleParsed)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
34
|
+
|
|
35
|
+
|
package/docs/FeaturesResponse.md
CHANGED
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`googleLoginEnabled` | boolean
|
|
10
|
+
`microsoftLoginEnabled` | boolean
|
|
11
|
+
`githubLoginEnabled` | boolean
|
|
10
12
|
`defaultFrontendLanguage` | [SupportedLanguage](SupportedLanguage.md)
|
|
11
13
|
|
|
12
14
|
## Example
|
|
@@ -17,6 +19,8 @@ import type { FeaturesResponse } from '@knowledge-stack/ksapi'
|
|
|
17
19
|
// TODO: Update the object below with actual values
|
|
18
20
|
const example = {
|
|
19
21
|
"googleLoginEnabled": null,
|
|
22
|
+
"microsoftLoginEnabled": null,
|
|
23
|
+
"githubLoginEnabled": null,
|
|
20
24
|
"defaultFrontendLanguage": null,
|
|
21
25
|
} satisfies FeaturesResponse
|
|
22
26
|
|
package/docs/FolderResponse.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type
|
|
|
14
14
|
`parentPathPartId` | string
|
|
15
15
|
`materializedPath` | string
|
|
16
16
|
`systemManaged` | boolean
|
|
17
|
+
`excludeFromQdrant` | boolean
|
|
17
18
|
`tenantId` | string
|
|
18
19
|
`createdAt` | Date
|
|
19
20
|
`updatedAt` | Date
|
|
@@ -33,6 +34,7 @@ const example = {
|
|
|
33
34
|
"parentPathPartId": null,
|
|
34
35
|
"materializedPath": null,
|
|
35
36
|
"systemManaged": null,
|
|
37
|
+
"excludeFromQdrant": null,
|
|
36
38
|
"tenantId": null,
|
|
37
39
|
"createdAt": null,
|
|
38
40
|
"updatedAt": null,
|
|
@@ -13,6 +13,7 @@ Name | Type
|
|
|
13
13
|
`parentPathPartId` | string
|
|
14
14
|
`materializedPath` | string
|
|
15
15
|
`systemManaged` | boolean
|
|
16
|
+
`excludeFromQdrant` | boolean
|
|
16
17
|
`tenantId` | string
|
|
17
18
|
`createdAt` | Date
|
|
18
19
|
`updatedAt` | Date
|
|
@@ -36,6 +37,7 @@ const example = {
|
|
|
36
37
|
"parentPathPartId": null,
|
|
37
38
|
"materializedPath": null,
|
|
38
39
|
"systemManaged": null,
|
|
40
|
+
"excludeFromQdrant": null,
|
|
39
41
|
"tenantId": null,
|
|
40
42
|
"createdAt": null,
|
|
41
43
|
"updatedAt": null,
|
package/docs/FoldersApi.md
CHANGED
|
@@ -590,7 +590,7 @@ No authorization required
|
|
|
590
590
|
|
|
591
591
|
Update Folder Handler
|
|
592
592
|
|
|
593
|
-
Update a folder (rename and/or
|
|
593
|
+
Update a folder (rename, move, and/or toggle Qdrant exclusion). To rename: provide `name` field. To move: provide `parent_path_part_id` field. To toggle Qdrant exclusion for this folder and its descendants: provide `exclude_from_qdrant` field. Any combination can be sent in a single request.
|
|
594
594
|
|
|
595
595
|
### Example
|
|
596
596
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# InviteLinkSettingsRequest
|
|
3
|
+
|
|
4
|
+
Partial invite-link settings update. ``role`` is constrained to USER/ADMIN by the shared ``InviteLinkRole`` Literal — Pydantic raises a 422 for any other value.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`enabled` | boolean
|
|
11
|
+
`role` | string
|
|
12
|
+
`groups` | Array<string>
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { InviteLinkSettingsRequest } from '@knowledge-stack/ksapi'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"enabled": null,
|
|
22
|
+
"role": null,
|
|
23
|
+
"groups": null,
|
|
24
|
+
} satisfies InviteLinkSettingsRequest
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as InviteLinkSettingsRequest
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# InviteLinkSettingsResponse
|
|
3
|
+
|
|
4
|
+
Tenant-wide invite-link settings (exposed via API).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`enabled` | boolean
|
|
11
|
+
`role` | string
|
|
12
|
+
`groups` | Array<string>
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { InviteLinkSettingsResponse } from '@knowledge-stack/ksapi'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"enabled": null,
|
|
22
|
+
"role": null,
|
|
23
|
+
"groups": null,
|
|
24
|
+
} satisfies InviteLinkSettingsResponse
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as InviteLinkSettingsResponse
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
package/docs/InviteResponse.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`tenantId` | string
|
|
12
12
|
`email` | string
|
|
13
13
|
`role` | [TenantUserRole](TenantUserRole.md)
|
|
14
|
+
`groups` | Array<string>
|
|
14
15
|
`expiresAt` | Date
|
|
15
16
|
`acceptedAt` | Date
|
|
16
17
|
`createdAt` | Date
|
|
@@ -29,6 +30,7 @@ const example = {
|
|
|
29
30
|
"tenantId": null,
|
|
30
31
|
"email": null,
|
|
31
32
|
"role": null,
|
|
33
|
+
"groups": null,
|
|
32
34
|
"expiresAt": null,
|
|
33
35
|
"acceptedAt": null,
|
|
34
36
|
"createdAt": null,
|
|
@@ -9,6 +9,7 @@ Name | Type
|
|
|
9
9
|
`tenantId` | string
|
|
10
10
|
`email` | string
|
|
11
11
|
`role` | [TenantUserRole](TenantUserRole.md)
|
|
12
|
+
`groups` | Array<string>
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,6 +21,7 @@ const example = {
|
|
|
20
21
|
"tenantId": null,
|
|
21
22
|
"email": null,
|
|
22
23
|
"role": null,
|
|
24
|
+
"groups": null,
|
|
23
25
|
} satisfies InviteUserRequest
|
|
24
26
|
|
|
25
27
|
console.log(example)
|
package/docs/InvitesApi.md
CHANGED
|
@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
8
8
|
| [**createInvite**](InvitesApi.md#createinvite) | **POST** /v1/invites | Create Invite |
|
|
9
9
|
| [**deleteInvite**](InvitesApi.md#deleteinvite) | **DELETE** /v1/invites/{invite_id} | Delete Invite |
|
|
10
10
|
| [**listInvites**](InvitesApi.md#listinvites) | **GET** /v1/invites | List Invites Handler |
|
|
11
|
+
| [**updateInvite**](InvitesApi.md#updateinviteoperation) | **PATCH** /v1/invites/{invite_id} | Update Invite Handler |
|
|
11
12
|
|
|
12
13
|
|
|
13
14
|
|
|
@@ -17,7 +18,7 @@ All URIs are relative to *http://localhost:8000*
|
|
|
17
18
|
|
|
18
19
|
Accept Invite
|
|
19
20
|
|
|
20
|
-
|
|
21
|
+
Accept an invite OR a tenant invite-link. The path parameter ``invite_id`` may be either: * a Tenant ID (when an admin has enabled ``invite_link`` on the tenant), OR * an Invite ID (the traditional per-email invite flow). Tenant lookup is tried first. If the row is found, the request is treated as an invite-link request — both 400 paths below have *distinct* messages so the frontend can branch on copy: * \"does not have invite link enabled\" → admin hasn\'t turned it on * \"does not support inviting users\" → tenant kill-switch ``system_metadata.can_invite`` is honored on this path too — it\'s a hard kill switch for self-serve onboarding. Only when no tenant matches do we look up an Invite row.
|
|
21
22
|
|
|
22
23
|
### Example
|
|
23
24
|
|
|
@@ -33,7 +34,7 @@ async function example() {
|
|
|
33
34
|
const api = new InvitesApi();
|
|
34
35
|
|
|
35
36
|
const body = {
|
|
36
|
-
// string
|
|
37
|
+
// string | Either an Invite ID (traditional per-email invite) OR a Tenant ID (when the tenant has ``invite_link.enabled``). Tenant lookup is tried first.
|
|
37
38
|
inviteId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
38
39
|
// string (optional)
|
|
39
40
|
authorization: authorization_example,
|
|
@@ -58,7 +59,7 @@ example().catch(console.error);
|
|
|
58
59
|
|
|
59
60
|
| Name | Type | Description | Notes |
|
|
60
61
|
|------------- | ------------- | ------------- | -------------|
|
|
61
|
-
| **inviteId** | `string` |
|
|
62
|
+
| **inviteId** | `string` | Either an Invite ID (traditional per-email invite) OR a Tenant ID (when the tenant has ``invite_link.enabled``). Tenant lookup is tried first. | [Defaults to `undefined`] |
|
|
62
63
|
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
63
64
|
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
64
65
|
|
|
@@ -315,3 +316,80 @@ No authorization required
|
|
|
315
316
|
|
|
316
317
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
317
318
|
|
|
319
|
+
|
|
320
|
+
## updateInvite
|
|
321
|
+
|
|
322
|
+
> InviteResponse updateInvite(inviteId, updateInviteRequest, authorization, ksUat)
|
|
323
|
+
|
|
324
|
+
Update Invite Handler
|
|
325
|
+
|
|
326
|
+
Update an invite\'s expiry or groups (admin/owner only). The invite must belong to the caller\'s current tenant. Any provided groups are validated to belong to the same tenant.
|
|
327
|
+
|
|
328
|
+
### Example
|
|
329
|
+
|
|
330
|
+
```ts
|
|
331
|
+
import {
|
|
332
|
+
Configuration,
|
|
333
|
+
InvitesApi,
|
|
334
|
+
} from '@knowledge-stack/ksapi';
|
|
335
|
+
import type { UpdateInviteOperationRequest } from '@knowledge-stack/ksapi';
|
|
336
|
+
|
|
337
|
+
async function example() {
|
|
338
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
339
|
+
const api = new InvitesApi();
|
|
340
|
+
|
|
341
|
+
const body = {
|
|
342
|
+
// string
|
|
343
|
+
inviteId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
344
|
+
// UpdateInviteRequest
|
|
345
|
+
updateInviteRequest: ...,
|
|
346
|
+
// string (optional)
|
|
347
|
+
authorization: authorization_example,
|
|
348
|
+
// string (optional)
|
|
349
|
+
ksUat: ksUat_example,
|
|
350
|
+
} satisfies UpdateInviteOperationRequest;
|
|
351
|
+
|
|
352
|
+
try {
|
|
353
|
+
const data = await api.updateInvite(body);
|
|
354
|
+
console.log(data);
|
|
355
|
+
} catch (error) {
|
|
356
|
+
console.error(error);
|
|
357
|
+
}
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
// Run the test
|
|
361
|
+
example().catch(console.error);
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
### Parameters
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
| Name | Type | Description | Notes |
|
|
368
|
+
|------------- | ------------- | ------------- | -------------|
|
|
369
|
+
| **inviteId** | `string` | | [Defaults to `undefined`] |
|
|
370
|
+
| **updateInviteRequest** | [UpdateInviteRequest](UpdateInviteRequest.md) | | |
|
|
371
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
372
|
+
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
373
|
+
|
|
374
|
+
### Return type
|
|
375
|
+
|
|
376
|
+
[**InviteResponse**](InviteResponse.md)
|
|
377
|
+
|
|
378
|
+
### Authorization
|
|
379
|
+
|
|
380
|
+
No authorization required
|
|
381
|
+
|
|
382
|
+
### HTTP request headers
|
|
383
|
+
|
|
384
|
+
- **Content-Type**: `application/json`
|
|
385
|
+
- **Accept**: `application/json`
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
### HTTP response details
|
|
389
|
+
| Status code | Description | Response headers |
|
|
390
|
+
|-------------|-------------|------------------|
|
|
391
|
+
| **200** | Successful Response | - |
|
|
392
|
+
| **422** | Validation Error | - |
|
|
393
|
+
|
|
394
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
395
|
+
|
|
@@ -10,7 +10,7 @@ Name | Type
|
|
|
10
10
|
`id` | string
|
|
11
11
|
`content` | string
|
|
12
12
|
`chunkType` | [ChunkType](ChunkType.md)
|
|
13
|
-
`chunkMetadata` | [
|
|
13
|
+
`chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
|
|
14
14
|
`tenantId` | string
|
|
15
15
|
`createdAt` | Date
|
|
16
16
|
`updatedAt` | Date
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
|
|
2
|
+
# MeteredQuotaStatus
|
|
3
|
+
|
|
4
|
+
Per-metric usage snapshot for the active period.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`metric` | [UsageMetric](UsageMetric.md)
|
|
11
|
+
`used` | number
|
|
12
|
+
`limit` | number
|
|
13
|
+
`periodStart` | Date
|
|
14
|
+
`periodEnd` | Date
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { MeteredQuotaStatus } from '@knowledge-stack/ksapi'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"metric": null,
|
|
24
|
+
"used": null,
|
|
25
|
+
"limit": null,
|
|
26
|
+
"periodStart": null,
|
|
27
|
+
"periodEnd": null,
|
|
28
|
+
} satisfies MeteredQuotaStatus
|
|
29
|
+
|
|
30
|
+
console.log(example)
|
|
31
|
+
|
|
32
|
+
// Convert the instance to a JSON string
|
|
33
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
34
|
+
console.log(exampleJSON)
|
|
35
|
+
|
|
36
|
+
// Parse the JSON string back to an object
|
|
37
|
+
const exampleParsed = JSON.parse(exampleJSON) as MeteredQuotaStatus
|
|
38
|
+
console.log(exampleParsed)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
42
|
+
|
|
43
|
+
|
|
@@ -14,6 +14,7 @@ Name | Type
|
|
|
14
14
|
`metadataObjId` | string
|
|
15
15
|
`materializedPath` | string
|
|
16
16
|
`systemManaged` | boolean
|
|
17
|
+
`excludeFromQdrant` | boolean
|
|
17
18
|
`createdAt` | Date
|
|
18
19
|
`updatedAt` | Date
|
|
19
20
|
|
|
@@ -31,6 +32,7 @@ const example = {
|
|
|
31
32
|
"metadataObjId": null,
|
|
32
33
|
"materializedPath": null,
|
|
33
34
|
"systemManaged": null,
|
|
35
|
+
"excludeFromQdrant": null,
|
|
34
36
|
"createdAt": null,
|
|
35
37
|
"updatedAt": null,
|
|
36
38
|
} satisfies PathPartAncestorItem
|
package/docs/PathPartResponse.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type
|
|
|
14
14
|
`metadataObjId` | string
|
|
15
15
|
`materializedPath` | string
|
|
16
16
|
`systemManaged` | boolean
|
|
17
|
+
`excludeFromQdrant` | boolean
|
|
17
18
|
`tags` | [Array<TagResponse>](TagResponse.md)
|
|
18
19
|
`canRead` | boolean
|
|
19
20
|
`canWrite` | boolean
|
|
@@ -34,6 +35,7 @@ const example = {
|
|
|
34
35
|
"metadataObjId": null,
|
|
35
36
|
"materializedPath": null,
|
|
36
37
|
"systemManaged": null,
|
|
38
|
+
"excludeFromQdrant": null,
|
|
37
39
|
"tags": null,
|
|
38
40
|
"canRead": null,
|
|
39
41
|
"canWrite": null,
|