@knowledge-stack/ksapi 1.72.3 → 1.77.1
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/FolderResponse.d.ts +6 -0
- package/dist/esm/models/FolderResponse.js +4 -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/FolderResponse.d.ts +6 -0
- package/dist/models/FolderResponse.js +4 -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/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/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/FolderResponse.ts +9 -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
package/dist/models/index.js
CHANGED
|
@@ -22,15 +22,18 @@ __exportStar(require("./AddMemberRequest"), exports);
|
|
|
22
22
|
__exportStar(require("./AncestryResponse"), exports);
|
|
23
23
|
__exportStar(require("./ApiKeyResponse"), exports);
|
|
24
24
|
__exportStar(require("./Args"), exports);
|
|
25
|
+
__exportStar(require("./AskRequest"), exports);
|
|
26
|
+
__exportStar(require("./AskResponse"), exports);
|
|
25
27
|
__exportStar(require("./BrandingLogoType"), exports);
|
|
26
28
|
__exportStar(require("./BulkTagRequest"), exports);
|
|
29
|
+
__exportStar(require("./ChangeSubscriptionRequest"), exports);
|
|
30
|
+
__exportStar(require("./CheckpointDetails"), exports);
|
|
27
31
|
__exportStar(require("./ChunkBulkResponse"), exports);
|
|
28
32
|
__exportStar(require("./ChunkContentItem"), exports);
|
|
29
33
|
__exportStar(require("./ChunkDocumentResponse"), exports);
|
|
30
34
|
__exportStar(require("./ChunkDocumentVersionResponse"), exports);
|
|
31
35
|
__exportStar(require("./ChunkLineageResponse"), exports);
|
|
32
|
-
__exportStar(require("./
|
|
33
|
-
__exportStar(require("./ChunkMetadataOutput"), exports);
|
|
36
|
+
__exportStar(require("./ChunkMetadata"), exports);
|
|
34
37
|
__exportStar(require("./ChunkNeighborsResponse"), exports);
|
|
35
38
|
__exportStar(require("./ChunkResponse"), exports);
|
|
36
39
|
__exportStar(require("./ChunkSearchRequest"), exports);
|
|
@@ -67,6 +70,8 @@ __exportStar(require("./EmailSentResponse"), exports);
|
|
|
67
70
|
__exportStar(require("./EmailVerificationRequest"), exports);
|
|
68
71
|
__exportStar(require("./EnrichedCitation"), exports);
|
|
69
72
|
__exportStar(require("./EnrichedThreadMessageContent"), exports);
|
|
73
|
+
__exportStar(require("./ExtractRequest"), exports);
|
|
74
|
+
__exportStar(require("./ExtractResponse"), exports);
|
|
70
75
|
__exportStar(require("./FeaturesResponse"), exports);
|
|
71
76
|
__exportStar(require("./FeedbackEventResponse"), exports);
|
|
72
77
|
__exportStar(require("./FeedbackRating"), exports);
|
|
@@ -87,6 +92,8 @@ __exportStar(require("./ImageTaxonomy"), exports);
|
|
|
87
92
|
__exportStar(require("./InformationStatistics"), exports);
|
|
88
93
|
__exportStar(require("./IngestDocumentResponse"), exports);
|
|
89
94
|
__exportStar(require("./IngestionMode"), exports);
|
|
95
|
+
__exportStar(require("./InviteLinkSettingsRequest"), exports);
|
|
96
|
+
__exportStar(require("./InviteLinkSettingsResponse"), exports);
|
|
90
97
|
__exportStar(require("./InviteResponse"), exports);
|
|
91
98
|
__exportStar(require("./InviteStatus"), exports);
|
|
92
99
|
__exportStar(require("./InviteUserRequest"), exports);
|
|
@@ -97,6 +104,7 @@ __exportStar(require("./LineageNodeResponse"), exports);
|
|
|
97
104
|
__exportStar(require("./LocationInner"), exports);
|
|
98
105
|
__exportStar(require("./MembershipResponse"), exports);
|
|
99
106
|
__exportStar(require("./MessageRole"), exports);
|
|
107
|
+
__exportStar(require("./MeteredQuotaStatus"), exports);
|
|
100
108
|
__exportStar(require("./NonFilesystemReferenceType"), exports);
|
|
101
109
|
__exportStar(require("./PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator"), exports);
|
|
102
110
|
__exportStar(require("./PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator"), exports);
|
|
@@ -140,6 +148,7 @@ __exportStar(require("./ScoredChunkResponse"), exports);
|
|
|
140
148
|
__exportStar(require("./SearchSortOrder"), exports);
|
|
141
149
|
__exportStar(require("./SearchType"), exports);
|
|
142
150
|
__exportStar(require("./SearchablePartType"), exports);
|
|
151
|
+
__exportStar(require("./SeatQuotaStatus"), exports);
|
|
143
152
|
__exportStar(require("./SectionContentItem"), exports);
|
|
144
153
|
__exportStar(require("./SectionContentItemOrChunkContentItem"), exports);
|
|
145
154
|
__exportStar(require("./SectionResponse"), exports);
|
|
@@ -151,6 +160,7 @@ __exportStar(require("./StepInput"), exports);
|
|
|
151
160
|
__exportStar(require("./StepKind"), exports);
|
|
152
161
|
__exportStar(require("./StepOutput"), exports);
|
|
153
162
|
__exportStar(require("./SubmitFeedbackRequest"), exports);
|
|
163
|
+
__exportStar(require("./SubscriptionPlanResponse"), exports);
|
|
154
164
|
__exportStar(require("./SubtreeChunkGroup"), exports);
|
|
155
165
|
__exportStar(require("./SubtreeChunksResponse"), exports);
|
|
156
166
|
__exportStar(require("./SupportedIdP"), exports);
|
|
@@ -158,6 +168,7 @@ __exportStar(require("./SupportedLanguage"), exports);
|
|
|
158
168
|
__exportStar(require("./TagResponse"), exports);
|
|
159
169
|
__exportStar(require("./TemporalWorkflowStatusResponse"), exports);
|
|
160
170
|
__exportStar(require("./TenantBrandingResponse"), exports);
|
|
171
|
+
__exportStar(require("./TenantQuotaStateResponse"), exports);
|
|
161
172
|
__exportStar(require("./TenantResponse"), exports);
|
|
162
173
|
__exportStar(require("./TenantSettingsResponse"), exports);
|
|
163
174
|
__exportStar(require("./TenantSettingsUpdate"), exports);
|
|
@@ -175,6 +186,7 @@ __exportStar(require("./UpdateDocumentRequest"), exports);
|
|
|
175
186
|
__exportStar(require("./UpdateFolderRequest"), exports);
|
|
176
187
|
__exportStar(require("./UpdateGroupPermissionRequest"), exports);
|
|
177
188
|
__exportStar(require("./UpdateGroupRequest"), exports);
|
|
189
|
+
__exportStar(require("./UpdateInviteRequest"), exports);
|
|
178
190
|
__exportStar(require("./UpdatePermissionRequest"), exports);
|
|
179
191
|
__exportStar(require("./UpdateSectionRequest"), exports);
|
|
180
192
|
__exportStar(require("./UpdateTagRequest"), exports);
|
|
@@ -182,6 +194,7 @@ __exportStar(require("./UpdateTenantRequest"), exports);
|
|
|
182
194
|
__exportStar(require("./UpdateThreadRequest"), exports);
|
|
183
195
|
__exportStar(require("./UpdateUserRequest"), exports);
|
|
184
196
|
__exportStar(require("./UpdateWorkflowDefinitionRequest"), exports);
|
|
197
|
+
__exportStar(require("./UsageMetric"), exports);
|
|
185
198
|
__exportStar(require("./UserMessageRequest"), exports);
|
|
186
199
|
__exportStar(require("./UserMessageResponse"), exports);
|
|
187
200
|
__exportStar(require("./UserResponse"), exports);
|
|
@@ -9,6 +9,7 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`tenantId` | string
|
|
11
11
|
`role` | [TenantUserRole](TenantUserRole.md)
|
|
12
|
+
`skippedGroups` | Array<string>
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -19,6 +20,7 @@ import type { AcceptInviteResponse } from '@knowledge-stack/ksapi'
|
|
|
19
20
|
const example = {
|
|
20
21
|
"tenantId": null,
|
|
21
22
|
"role": null,
|
|
23
|
+
"skippedGroups": null,
|
|
22
24
|
} satisfies AcceptInviteResponse
|
|
23
25
|
|
|
24
26
|
console.log(example)
|
package/docs/AgentApi.md
ADDED
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# AgentApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:8000*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**agentAsk**](AgentApi.md#agentask) | **POST** /v1/agent/ask | Agent Ask Handler |
|
|
8
|
+
| [**agentExtract**](AgentApi.md#agentextract) | **POST** /v1/agent/extract | Agent Extract Handler |
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## agentAsk
|
|
13
|
+
|
|
14
|
+
> AskResponse agentAsk(askRequest, authorization, ksUat)
|
|
15
|
+
|
|
16
|
+
Agent Ask Handler
|
|
17
|
+
|
|
18
|
+
Run a one-shot text agent request to completion and return the payload. The request blocks until the underlying Temporal workflow finishes. Clients should set a generous HTTP timeout to accommodate tool-heavy runs. Quota: consumes one MESSAGE before ``start_workflow``. Refunds on any failure between consume and ``handle.result()`` returning — pre-enqueue ``start_workflow`` raises and post-enqueue workflow failures both refund.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import {
|
|
24
|
+
Configuration,
|
|
25
|
+
AgentApi,
|
|
26
|
+
} from '@knowledge-stack/ksapi';
|
|
27
|
+
import type { AgentAskRequest } from '@knowledge-stack/ksapi';
|
|
28
|
+
|
|
29
|
+
async function example() {
|
|
30
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
31
|
+
const api = new AgentApi();
|
|
32
|
+
|
|
33
|
+
const body = {
|
|
34
|
+
// AskRequest
|
|
35
|
+
askRequest: ...,
|
|
36
|
+
// string (optional)
|
|
37
|
+
authorization: authorization_example,
|
|
38
|
+
// string (optional)
|
|
39
|
+
ksUat: ksUat_example,
|
|
40
|
+
} satisfies AgentAskRequest;
|
|
41
|
+
|
|
42
|
+
try {
|
|
43
|
+
const data = await api.agentAsk(body);
|
|
44
|
+
console.log(data);
|
|
45
|
+
} catch (error) {
|
|
46
|
+
console.error(error);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
// Run the test
|
|
51
|
+
example().catch(console.error);
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Parameters
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
| Name | Type | Description | Notes |
|
|
58
|
+
|------------- | ------------- | ------------- | -------------|
|
|
59
|
+
| **askRequest** | [AskRequest](AskRequest.md) | | |
|
|
60
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
61
|
+
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
62
|
+
|
|
63
|
+
### Return type
|
|
64
|
+
|
|
65
|
+
[**AskResponse**](AskResponse.md)
|
|
66
|
+
|
|
67
|
+
### Authorization
|
|
68
|
+
|
|
69
|
+
No authorization required
|
|
70
|
+
|
|
71
|
+
### HTTP request headers
|
|
72
|
+
|
|
73
|
+
- **Content-Type**: `application/json`
|
|
74
|
+
- **Accept**: `application/json`
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### HTTP response details
|
|
78
|
+
| Status code | Description | Response headers |
|
|
79
|
+
|-------------|-------------|------------------|
|
|
80
|
+
| **200** | Successful Response | - |
|
|
81
|
+
| **422** | Validation Error | - |
|
|
82
|
+
|
|
83
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
## agentExtract
|
|
87
|
+
|
|
88
|
+
> ExtractResponse agentExtract(extractRequest, authorization, ksUat)
|
|
89
|
+
|
|
90
|
+
Agent Extract Handler
|
|
91
|
+
|
|
92
|
+
Run a one-shot structured extraction request and return the payload. Validates the schema input on the route side (DOCUMENT → active version → valid JSON object) BEFORE consuming quota or starting the workflow. Bad schema → 400 with no quota debit. The workflow activity trusts the input and does not re-validate. Quota: consumes one MESSAGE before ``start_workflow``. Refunds on any failure between consume and ``handle.result()`` returning — pre-enqueue ``start_workflow`` raises and post-enqueue workflow failures both refund.
|
|
93
|
+
|
|
94
|
+
### Example
|
|
95
|
+
|
|
96
|
+
```ts
|
|
97
|
+
import {
|
|
98
|
+
Configuration,
|
|
99
|
+
AgentApi,
|
|
100
|
+
} from '@knowledge-stack/ksapi';
|
|
101
|
+
import type { AgentExtractRequest } from '@knowledge-stack/ksapi';
|
|
102
|
+
|
|
103
|
+
async function example() {
|
|
104
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
105
|
+
const api = new AgentApi();
|
|
106
|
+
|
|
107
|
+
const body = {
|
|
108
|
+
// ExtractRequest
|
|
109
|
+
extractRequest: ...,
|
|
110
|
+
// string (optional)
|
|
111
|
+
authorization: authorization_example,
|
|
112
|
+
// string (optional)
|
|
113
|
+
ksUat: ksUat_example,
|
|
114
|
+
} satisfies AgentExtractRequest;
|
|
115
|
+
|
|
116
|
+
try {
|
|
117
|
+
const data = await api.agentExtract(body);
|
|
118
|
+
console.log(data);
|
|
119
|
+
} catch (error) {
|
|
120
|
+
console.error(error);
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
// Run the test
|
|
125
|
+
example().catch(console.error);
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Parameters
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
| Name | Type | Description | Notes |
|
|
132
|
+
|------------- | ------------- | ------------- | -------------|
|
|
133
|
+
| **extractRequest** | [ExtractRequest](ExtractRequest.md) | | |
|
|
134
|
+
| **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
135
|
+
| **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
136
|
+
|
|
137
|
+
### Return type
|
|
138
|
+
|
|
139
|
+
[**ExtractResponse**](ExtractResponse.md)
|
|
140
|
+
|
|
141
|
+
### Authorization
|
|
142
|
+
|
|
143
|
+
No authorization required
|
|
144
|
+
|
|
145
|
+
### HTTP request headers
|
|
146
|
+
|
|
147
|
+
- **Content-Type**: `application/json`
|
|
148
|
+
- **Accept**: `application/json`
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
### HTTP response details
|
|
152
|
+
| Status code | Description | Response headers |
|
|
153
|
+
|-------------|-------------|------------------|
|
|
154
|
+
| **200** | Successful Response | - |
|
|
155
|
+
| **422** | Validation Error | - |
|
|
156
|
+
|
|
157
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
158
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
|
|
2
|
+
# AskRequest
|
|
3
|
+
|
|
4
|
+
Request body for POST /v1/agent/ask.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`prompt` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { AskRequest } from '@knowledge-stack/ksapi'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"prompt": null,
|
|
20
|
+
} satisfies AskRequest
|
|
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 AskRequest
|
|
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
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
|
|
2
|
+
# AskResponse
|
|
3
|
+
|
|
4
|
+
Response body for POST /v1/agent/ask.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`text` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { AskResponse } from '@knowledge-stack/ksapi'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"text": null,
|
|
20
|
+
} satisfies AskResponse
|
|
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 AskResponse
|
|
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
|
+
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# ChangeSubscriptionRequest
|
|
3
|
+
|
|
4
|
+
Body for ``POST /v1/tenants/{tenant_id}/subscriptions``.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`subscriptionId` | string
|
|
11
|
+
`numSeats` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ChangeSubscriptionRequest } from '@knowledge-stack/ksapi'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"subscriptionId": null,
|
|
21
|
+
"numSeats": null,
|
|
22
|
+
} satisfies ChangeSubscriptionRequest
|
|
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 ChangeSubscriptionRequest
|
|
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
|
+
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
|
|
2
|
+
# CheckpointDetails
|
|
3
|
+
|
|
4
|
+
Agent-internal overlay that replaces older messages in the loaded history. Written as ``details.checkpoint`` on ``role=SYSTEM`` ThreadMessages. The boundary is explicit via ``upto_message_id`` + ``upto_message_created_at`` so the agent can keep recent messages uncompacted even though the checkpoint message itself is inserted at \"now\".
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`uptoMessageId` | string
|
|
11
|
+
`uptoMessageCreatedAt` | Date
|
|
12
|
+
`summary` | { [key: string]: any; }
|
|
13
|
+
`coveredMessageCount` | number
|
|
14
|
+
`tokensBefore` | number
|
|
15
|
+
`tokensAfter` | number
|
|
16
|
+
`summarizerModel` | string
|
|
17
|
+
`promptVersion` | string
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { CheckpointDetails } from '@knowledge-stack/ksapi'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"uptoMessageId": null,
|
|
27
|
+
"uptoMessageCreatedAt": null,
|
|
28
|
+
"summary": null,
|
|
29
|
+
"coveredMessageCount": null,
|
|
30
|
+
"tokensBefore": null,
|
|
31
|
+
"tokensAfter": null,
|
|
32
|
+
"summarizerModel": null,
|
|
33
|
+
"promptVersion": null,
|
|
34
|
+
} satisfies CheckpointDetails
|
|
35
|
+
|
|
36
|
+
console.log(example)
|
|
37
|
+
|
|
38
|
+
// Convert the instance to a JSON string
|
|
39
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
40
|
+
console.log(exampleJSON)
|
|
41
|
+
|
|
42
|
+
// Parse the JSON string back to an object
|
|
43
|
+
const exampleParsed = JSON.parse(exampleJSON) as CheckpointDetails
|
|
44
|
+
console.log(exampleParsed)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
48
|
+
|
|
49
|
+
|
|
@@ -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/ChunkContentItem.md
CHANGED
|
@@ -15,7 +15,7 @@ Name | Type
|
|
|
15
15
|
`depth` | number
|
|
16
16
|
`content` | string
|
|
17
17
|
`chunkType` | [ChunkType](ChunkType.md)
|
|
18
|
-
`chunkMetadata` | [
|
|
18
|
+
`chunkMetadata` | [ChunkMetadata](ChunkMetadata.md)
|
|
19
19
|
`materializedPath` | string
|
|
20
20
|
`systemManaged` | boolean
|
|
21
21
|
`createdAt` | Date
|
|
@@ -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
|
|