@knowledge-stack/ksapi 1.23.4 → 1.24.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 +125 -6
- package/.openapi-generator/VERSION +1 -1
- package/README.md +274 -28
- package/dist/apis/AuthApi.d.ts +117 -0
- package/dist/apis/AuthApi.js +137 -47
- package/dist/apis/ChunkLineagesApi.d.ts +38 -0
- package/dist/apis/ChunkLineagesApi.js +42 -15
- package/dist/apis/ChunksApi.d.ts +78 -4
- package/dist/apis/ChunksApi.js +85 -31
- package/dist/apis/DefaultApi.d.ts +20 -0
- package/dist/apis/DefaultApi.js +28 -10
- package/dist/apis/DocumentVersionsApi.d.ts +99 -9
- package/dist/apis/DocumentVersionsApi.js +100 -37
- package/dist/apis/DocumentsApi.d.ts +80 -0
- package/dist/apis/DocumentsApi.js +84 -30
- package/dist/apis/FoldersApi.d.ts +92 -9
- package/dist/apis/FoldersApi.js +86 -32
- package/dist/apis/InvitesApi.d.ts +51 -0
- package/dist/apis/InvitesApi.js +56 -20
- package/dist/apis/PathPartsApi.d.ts +54 -0
- package/dist/apis/PathPartsApi.js +56 -20
- package/dist/apis/SectionsApi.d.ts +49 -0
- package/dist/apis/SectionsApi.js +56 -20
- package/dist/apis/TagsApi.d.ts +62 -0
- package/dist/apis/TagsApi.js +70 -25
- package/dist/apis/TenantsApi.d.ts +172 -5
- package/dist/apis/TenantsApi.js +179 -31
- package/dist/apis/ThreadMessagesApi.d.ts +41 -0
- package/dist/apis/ThreadMessagesApi.js +42 -15
- package/dist/apis/ThreadsApi.d.ts +77 -0
- package/dist/apis/ThreadsApi.js +84 -30
- package/dist/apis/UserPermissionsApi.d.ts +54 -0
- package/dist/apis/UserPermissionsApi.js +56 -20
- package/dist/apis/UsersApi.d.ts +23 -0
- package/dist/apis/UsersApi.js +28 -10
- package/dist/apis/WorkflowsApi.d.ts +38 -0
- package/dist/apis/WorkflowsApi.js +42 -15
- package/dist/esm/apis/AuthApi.d.ts +117 -0
- package/dist/esm/apis/AuthApi.js +137 -47
- package/dist/esm/apis/ChunkLineagesApi.d.ts +38 -0
- package/dist/esm/apis/ChunkLineagesApi.js +42 -15
- package/dist/esm/apis/ChunksApi.d.ts +78 -4
- package/dist/esm/apis/ChunksApi.js +85 -31
- package/dist/esm/apis/DefaultApi.d.ts +20 -0
- package/dist/esm/apis/DefaultApi.js +28 -10
- package/dist/esm/apis/DocumentVersionsApi.d.ts +99 -9
- package/dist/esm/apis/DocumentVersionsApi.js +101 -38
- package/dist/esm/apis/DocumentsApi.d.ts +80 -0
- package/dist/esm/apis/DocumentsApi.js +84 -30
- package/dist/esm/apis/FoldersApi.d.ts +92 -9
- package/dist/esm/apis/FoldersApi.js +87 -33
- package/dist/esm/apis/InvitesApi.d.ts +51 -0
- package/dist/esm/apis/InvitesApi.js +56 -20
- package/dist/esm/apis/PathPartsApi.d.ts +54 -0
- package/dist/esm/apis/PathPartsApi.js +56 -20
- package/dist/esm/apis/SectionsApi.d.ts +49 -0
- package/dist/esm/apis/SectionsApi.js +56 -20
- package/dist/esm/apis/TagsApi.d.ts +62 -0
- package/dist/esm/apis/TagsApi.js +70 -25
- package/dist/esm/apis/TenantsApi.d.ts +172 -5
- package/dist/esm/apis/TenantsApi.js +180 -32
- package/dist/esm/apis/ThreadMessagesApi.d.ts +41 -0
- package/dist/esm/apis/ThreadMessagesApi.js +42 -15
- package/dist/esm/apis/ThreadsApi.d.ts +77 -0
- package/dist/esm/apis/ThreadsApi.js +84 -30
- package/dist/esm/apis/UserPermissionsApi.d.ts +54 -0
- package/dist/esm/apis/UserPermissionsApi.js +56 -20
- package/dist/esm/apis/UsersApi.d.ts +23 -0
- package/dist/esm/apis/UsersApi.js +28 -10
- package/dist/esm/apis/WorkflowsApi.d.ts +38 -0
- package/dist/esm/apis/WorkflowsApi.js +42 -15
- package/dist/esm/models/{DocumentContentPathPart.d.ts → ChunkContentItem.d.ts} +37 -40
- package/dist/esm/models/{DocumentContentPathPart.js → ChunkContentItem.js} +17 -16
- package/dist/esm/models/ChunkResponse.d.ts +6 -0
- package/dist/esm/models/ChunkResponse.js +2 -0
- package/dist/esm/models/DocumentResponse.d.ts +13 -0
- package/dist/esm/models/DocumentResponse.js +8 -0
- package/dist/esm/models/FolderResponse.d.ts +13 -0
- package/dist/esm/models/FolderResponse.js +8 -0
- package/dist/esm/models/FolderResponseOrDocumentResponse.d.ts +27 -0
- package/dist/esm/models/FolderResponseOrDocumentResponse.js +47 -0
- package/dist/esm/models/InviteResponse.d.ts +7 -0
- package/dist/esm/models/InviteResponse.js +5 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.js +70 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.d.ts +66 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.js +70 -0
- package/dist/esm/models/PaginatedResponseTenantUserResponse.d.ts +66 -0
- package/dist/esm/models/{PaginatedResponseTenantUserInTenantResponse.js → PaginatedResponseTenantUserResponse.js} +12 -12
- package/dist/esm/models/ScoredChunkResponse.d.ts +6 -0
- package/dist/esm/models/ScoredChunkResponse.js +2 -0
- package/dist/esm/models/SectionContentItem.d.ts +114 -0
- package/dist/esm/models/SectionContentItem.js +86 -0
- package/dist/esm/models/SectionContentItemOrChunkContentItem.d.ts +27 -0
- package/dist/esm/models/SectionContentItemOrChunkContentItem.js +47 -0
- package/dist/esm/models/TenantUserEditRequest.d.ts +48 -0
- package/dist/esm/models/TenantUserEditRequest.js +45 -0
- package/dist/esm/models/{TenantUserInTenantResponse.d.ts → TenantUserResponse.d.ts} +19 -13
- package/dist/esm/models/{TenantUserInTenantResponse.js → TenantUserResponse.js} +13 -9
- package/dist/esm/models/index.d.ts +9 -6
- package/dist/esm/models/index.js +9 -6
- package/dist/models/{DocumentContentPathPart.d.ts → ChunkContentItem.d.ts} +37 -40
- package/dist/models/{DocumentContentPathPart.js → ChunkContentItem.js} +23 -22
- package/dist/models/ChunkResponse.d.ts +6 -0
- package/dist/models/ChunkResponse.js +2 -0
- package/dist/models/DocumentResponse.d.ts +13 -0
- package/dist/models/DocumentResponse.js +9 -1
- package/dist/models/FolderResponse.d.ts +13 -0
- package/dist/models/FolderResponse.js +9 -1
- package/dist/models/FolderResponseOrDocumentResponse.d.ts +27 -0
- package/dist/models/FolderResponseOrDocumentResponse.js +53 -0
- package/dist/models/InviteResponse.d.ts +7 -0
- package/dist/models/InviteResponse.js +5 -0
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.d.ts +66 -0
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.js +78 -0
- package/dist/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.d.ts +66 -0
- package/dist/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.js +78 -0
- package/dist/models/PaginatedResponseTenantUserResponse.d.ts +66 -0
- package/dist/models/PaginatedResponseTenantUserResponse.js +78 -0
- package/dist/models/ScoredChunkResponse.d.ts +6 -0
- package/dist/models/ScoredChunkResponse.js +2 -0
- package/dist/models/SectionContentItem.d.ts +114 -0
- package/dist/models/SectionContentItem.js +94 -0
- package/dist/models/SectionContentItemOrChunkContentItem.d.ts +27 -0
- package/dist/models/SectionContentItemOrChunkContentItem.js +53 -0
- package/dist/models/TenantUserEditRequest.d.ts +48 -0
- package/dist/models/TenantUserEditRequest.js +53 -0
- package/dist/models/{TenantUserInTenantResponse.d.ts → TenantUserResponse.d.ts} +19 -13
- package/dist/models/{TenantUserInTenantResponse.js → TenantUserResponse.js} +19 -15
- package/dist/models/index.d.ts +9 -6
- package/dist/models/index.js +9 -6
- package/docs/AuthApi.md +707 -0
- package/docs/BulkTagRequest.md +35 -0
- package/docs/ChunkContentItem.md +59 -0
- package/docs/ChunkLineageResponse.md +41 -0
- package/docs/ChunkLineagesApi.md +230 -0
- package/docs/ChunkMetadataInput.md +37 -0
- package/docs/ChunkMetadataOutput.md +37 -0
- package/docs/ChunkResponse.md +63 -0
- package/docs/ChunkSearchRequest.md +47 -0
- package/docs/ChunkType.md +33 -0
- package/docs/ChunksApi.md +446 -0
- package/docs/ClearVersionContentsResponse.md +35 -0
- package/docs/CreateChunkLineageRequest.md +37 -0
- package/docs/CreateChunkRequest.md +43 -0
- package/docs/CreateDocumentRequest.md +41 -0
- package/docs/CreateFolderRequest.md +37 -0
- package/docs/CreatePasswordUserRequest.md +36 -0
- package/docs/CreatePermissionRequest.md +40 -0
- package/docs/CreateSectionRequest.md +41 -0
- package/docs/CreateTagRequest.md +39 -0
- package/docs/CreateTenantRequest.md +37 -0
- package/docs/CreateThreadMessageRequest.md +37 -0
- package/docs/CreateThreadRequest.md +37 -0
- package/docs/DefaultApi.md +128 -0
- package/docs/DocumentOrigin.md +33 -0
- package/docs/DocumentResponse.md +63 -0
- package/docs/DocumentType.md +33 -0
- package/docs/DocumentVersionMetadata.md +47 -0
- package/docs/DocumentVersionMetadataUpdate.md +47 -0
- package/docs/DocumentVersionResponse.md +57 -0
- package/docs/DocumentVersionsApi.md +530 -0
- package/docs/DocumentsApi.md +464 -0
- package/docs/EmailSentResponse.md +34 -0
- package/docs/EmailVerificationRequest.md +34 -0
- package/docs/EmbeddingModel.md +33 -0
- package/docs/FolderResponse.md +55 -0
- package/docs/FolderResponseOrDocumentResponse.md +62 -0
- package/docs/FoldersApi.md +473 -0
- package/docs/HTTPValidationError.md +34 -0
- package/docs/HealthCheckResponse.md +36 -0
- package/docs/IdpType.md +33 -0
- package/docs/IngestDocumentResponse.md +39 -0
- package/docs/InviteResponse.md +53 -0
- package/docs/InviteStatus.md +32 -0
- package/docs/InviteUserRequest.md +38 -0
- package/docs/InvitesApi.md +305 -0
- package/docs/LineageEdgeResponse.md +37 -0
- package/docs/LineageGraphResponse.md +37 -0
- package/docs/LineageNodeResponse.md +47 -0
- package/docs/LocationInner.md +32 -0
- package/docs/MessageRole.md +33 -0
- package/docs/OAuth2Config.md +41 -0
- package/docs/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md +40 -0
- package/docs/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.md +40 -0
- package/docs/PaginatedResponseDocumentResponse.md +40 -0
- package/docs/PaginatedResponseDocumentVersionResponse.md +40 -0
- package/docs/PaginatedResponseFolderResponse.md +40 -0
- package/docs/PaginatedResponseInviteResponse.md +40 -0
- package/docs/PaginatedResponsePathPartResponse.md +40 -0
- package/docs/PaginatedResponsePermissionResponse.md +40 -0
- package/docs/PaginatedResponseTagResponse.md +40 -0
- package/docs/PaginatedResponseTenantResponse.md +40 -0
- package/docs/PaginatedResponseTenantUserResponse.md +40 -0
- package/docs/PaginatedResponseThreadMessageResponse.md +40 -0
- package/docs/PaginatedResponseThreadResponse.md +40 -0
- package/docs/PaginatedResponseWorkflowSummaryResponse.md +40 -0
- package/docs/PartType.md +33 -0
- package/docs/PasswordResetRequest.md +36 -0
- package/docs/PasswordResetWithTokenRequest.md +36 -0
- package/docs/PathOrder.md +33 -0
- package/docs/PathPartResponse.md +53 -0
- package/docs/PathPartTagsResponse.md +35 -0
- package/docs/PathPartsApi.md +314 -0
- package/docs/PermissionCapability.md +33 -0
- package/docs/PermissionResponse.md +48 -0
- package/docs/PipelineState.md +45 -0
- package/docs/PipelineStatus.md +33 -0
- package/docs/Polygon.md +41 -0
- package/docs/PolygonReference.md +37 -0
- package/docs/RootResponse.md +36 -0
- package/docs/ScoredChunkResponse.md +65 -0
- package/docs/SectionContentItem.md +55 -0
- package/docs/SectionContentItemOrChunkContentItem.md +60 -0
- package/docs/SectionResponse.md +57 -0
- package/docs/SectionsApi.md +299 -0
- package/docs/SignInRequest.md +38 -0
- package/docs/TagResponse.md +47 -0
- package/docs/TagsApi.md +374 -0
- package/docs/TenantResponse.md +39 -0
- package/docs/TenantUserEditRequest.md +35 -0
- package/docs/TenantUserResponse.md +43 -0
- package/docs/TenantUserRole.md +33 -0
- package/docs/TenantsApi.md +605 -0
- package/docs/ThreadMessageResponse.md +53 -0
- package/docs/ThreadMessagesApi.md +239 -0
- package/docs/ThreadResponse.md +49 -0
- package/docs/ThreadsApi.md +455 -0
- package/docs/UpdateChunkContentRequest.md +37 -0
- package/docs/UpdateChunkMetadataRequest.md +35 -0
- package/docs/UpdateDocumentRequest.md +39 -0
- package/docs/UpdateFolderRequest.md +37 -0
- package/docs/UpdatePermissionRequest.md +36 -0
- package/docs/UpdateSectionRequest.md +41 -0
- package/docs/UpdateTagRequest.md +39 -0
- package/docs/UpdateTenantRequest.md +37 -0
- package/docs/UpdateThreadRequest.md +37 -0
- package/docs/UpdateUserRequest.md +34 -0
- package/docs/UserPermissionsApi.md +314 -0
- package/docs/UserResponse.md +44 -0
- package/docs/UsersApi.md +149 -0
- package/docs/ValidationError.md +42 -0
- package/docs/WorkflowAction.md +33 -0
- package/docs/WorkflowActionResponse.md +39 -0
- package/docs/WorkflowDetailResponse.md +63 -0
- package/docs/WorkflowSummaryResponse.md +49 -0
- package/docs/WorkflowsApi.md +230 -0
- package/package.json +1 -1
- package/src/apis/AuthApi.ts +214 -47
- package/src/apis/ChunkLineagesApi.ts +68 -15
- package/src/apis/ChunksApi.ts +137 -33
- package/src/apis/DefaultApi.ts +40 -10
- package/src/apis/DocumentVersionsApi.ts +170 -45
- package/src/apis/DocumentsApi.ts +140 -30
- package/src/apis/FoldersApi.ts +153 -40
- package/src/apis/InvitesApi.ts +91 -20
- package/src/apis/PathPartsApi.ts +94 -20
- package/src/apis/SectionsApi.ts +89 -20
- package/src/apis/TagsApi.ts +112 -25
- package/src/apis/TenantsApi.ts +339 -37
- package/src/apis/ThreadMessagesApi.ts +71 -15
- package/src/apis/ThreadsApi.ts +137 -30
- package/src/apis/UserPermissionsApi.ts +94 -20
- package/src/apis/UsersApi.ts +43 -10
- package/src/apis/WorkflowsApi.ts +68 -15
- package/src/models/{DocumentContentPathPart.ts → ChunkContentItem.ts} +42 -53
- package/src/models/ChunkResponse.ts +8 -0
- package/src/models/DocumentResponse.ts +16 -0
- package/src/models/FolderResponse.ts +18 -0
- package/src/models/FolderResponseOrDocumentResponse.ts +72 -0
- package/src/models/InviteResponse.ts +19 -0
- package/src/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.ts +130 -0
- package/src/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.ts +130 -0
- package/src/models/{PaginatedResponseFolderDocumentResponse.ts → PaginatedResponseTenantUserResponse.ts} +25 -25
- package/src/models/ScoredChunkResponse.ts +8 -0
- package/src/models/SectionContentItem.ts +181 -0
- package/src/models/SectionContentItemOrChunkContentItem.ts +72 -0
- package/src/models/TenantUserEditRequest.ts +93 -0
- package/src/models/{TenantUserInTenantResponse.ts → TenantUserResponse.ts} +24 -15
- package/src/models/index.ts +9 -6
- package/dist/esm/models/FolderDocumentResponse.d.ts +0 -157
- package/dist/esm/models/FolderDocumentResponse.js +0 -99
- package/dist/esm/models/PaginatedResponseDocumentContentPathPart.d.ts +0 -66
- package/dist/esm/models/PaginatedResponseDocumentContentPathPart.js +0 -70
- package/dist/esm/models/PaginatedResponseFolderDocumentResponse.d.ts +0 -66
- package/dist/esm/models/PaginatedResponseFolderDocumentResponse.js +0 -70
- package/dist/esm/models/PaginatedResponseTenantUserInTenantResponse.d.ts +0 -66
- package/dist/models/FolderDocumentResponse.d.ts +0 -157
- package/dist/models/FolderDocumentResponse.js +0 -107
- package/dist/models/PaginatedResponseDocumentContentPathPart.d.ts +0 -66
- package/dist/models/PaginatedResponseDocumentContentPathPart.js +0 -78
- package/dist/models/PaginatedResponseFolderDocumentResponse.d.ts +0 -66
- package/dist/models/PaginatedResponseFolderDocumentResponse.js +0 -78
- package/dist/models/PaginatedResponseTenantUserInTenantResponse.d.ts +0 -66
- package/dist/models/PaginatedResponseTenantUserInTenantResponse.js +0 -78
- package/src/models/FolderDocumentResponse.ts +0 -267
- package/src/models/PaginatedResponseDocumentContentPathPart.ts +0 -130
- package/src/models/PaginatedResponseTenantUserInTenantResponse.ts +0 -130
package/.openapi-generator/FILES
CHANGED
|
@@ -2,6 +2,122 @@
|
|
|
2
2
|
.npmignore
|
|
3
3
|
.openapi-generator-ignore
|
|
4
4
|
README.md
|
|
5
|
+
docs/AuthApi.md
|
|
6
|
+
docs/BulkTagRequest.md
|
|
7
|
+
docs/ChunkContentItem.md
|
|
8
|
+
docs/ChunkLineageResponse.md
|
|
9
|
+
docs/ChunkLineagesApi.md
|
|
10
|
+
docs/ChunkMetadataInput.md
|
|
11
|
+
docs/ChunkMetadataOutput.md
|
|
12
|
+
docs/ChunkResponse.md
|
|
13
|
+
docs/ChunkSearchRequest.md
|
|
14
|
+
docs/ChunkType.md
|
|
15
|
+
docs/ChunksApi.md
|
|
16
|
+
docs/ClearVersionContentsResponse.md
|
|
17
|
+
docs/CreateChunkLineageRequest.md
|
|
18
|
+
docs/CreateChunkRequest.md
|
|
19
|
+
docs/CreateDocumentRequest.md
|
|
20
|
+
docs/CreateFolderRequest.md
|
|
21
|
+
docs/CreatePasswordUserRequest.md
|
|
22
|
+
docs/CreatePermissionRequest.md
|
|
23
|
+
docs/CreateSectionRequest.md
|
|
24
|
+
docs/CreateTagRequest.md
|
|
25
|
+
docs/CreateTenantRequest.md
|
|
26
|
+
docs/CreateThreadMessageRequest.md
|
|
27
|
+
docs/CreateThreadRequest.md
|
|
28
|
+
docs/DefaultApi.md
|
|
29
|
+
docs/DocumentOrigin.md
|
|
30
|
+
docs/DocumentResponse.md
|
|
31
|
+
docs/DocumentType.md
|
|
32
|
+
docs/DocumentVersionMetadata.md
|
|
33
|
+
docs/DocumentVersionMetadataUpdate.md
|
|
34
|
+
docs/DocumentVersionResponse.md
|
|
35
|
+
docs/DocumentVersionsApi.md
|
|
36
|
+
docs/DocumentsApi.md
|
|
37
|
+
docs/EmailSentResponse.md
|
|
38
|
+
docs/EmailVerificationRequest.md
|
|
39
|
+
docs/EmbeddingModel.md
|
|
40
|
+
docs/FolderResponse.md
|
|
41
|
+
docs/FolderResponseOrDocumentResponse.md
|
|
42
|
+
docs/FoldersApi.md
|
|
43
|
+
docs/HTTPValidationError.md
|
|
44
|
+
docs/HealthCheckResponse.md
|
|
45
|
+
docs/IdpType.md
|
|
46
|
+
docs/IngestDocumentResponse.md
|
|
47
|
+
docs/InviteResponse.md
|
|
48
|
+
docs/InviteStatus.md
|
|
49
|
+
docs/InviteUserRequest.md
|
|
50
|
+
docs/InvitesApi.md
|
|
51
|
+
docs/LineageEdgeResponse.md
|
|
52
|
+
docs/LineageGraphResponse.md
|
|
53
|
+
docs/LineageNodeResponse.md
|
|
54
|
+
docs/LocationInner.md
|
|
55
|
+
docs/MessageRole.md
|
|
56
|
+
docs/OAuth2Config.md
|
|
57
|
+
docs/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md
|
|
58
|
+
docs/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.md
|
|
59
|
+
docs/PaginatedResponseDocumentResponse.md
|
|
60
|
+
docs/PaginatedResponseDocumentVersionResponse.md
|
|
61
|
+
docs/PaginatedResponseFolderResponse.md
|
|
62
|
+
docs/PaginatedResponseInviteResponse.md
|
|
63
|
+
docs/PaginatedResponsePathPartResponse.md
|
|
64
|
+
docs/PaginatedResponsePermissionResponse.md
|
|
65
|
+
docs/PaginatedResponseTagResponse.md
|
|
66
|
+
docs/PaginatedResponseTenantResponse.md
|
|
67
|
+
docs/PaginatedResponseTenantUserResponse.md
|
|
68
|
+
docs/PaginatedResponseThreadMessageResponse.md
|
|
69
|
+
docs/PaginatedResponseThreadResponse.md
|
|
70
|
+
docs/PaginatedResponseWorkflowSummaryResponse.md
|
|
71
|
+
docs/PartType.md
|
|
72
|
+
docs/PasswordResetRequest.md
|
|
73
|
+
docs/PasswordResetWithTokenRequest.md
|
|
74
|
+
docs/PathOrder.md
|
|
75
|
+
docs/PathPartResponse.md
|
|
76
|
+
docs/PathPartTagsResponse.md
|
|
77
|
+
docs/PathPartsApi.md
|
|
78
|
+
docs/PermissionCapability.md
|
|
79
|
+
docs/PermissionResponse.md
|
|
80
|
+
docs/PipelineState.md
|
|
81
|
+
docs/PipelineStatus.md
|
|
82
|
+
docs/Polygon.md
|
|
83
|
+
docs/PolygonReference.md
|
|
84
|
+
docs/RootResponse.md
|
|
85
|
+
docs/ScoredChunkResponse.md
|
|
86
|
+
docs/SectionContentItem.md
|
|
87
|
+
docs/SectionContentItemOrChunkContentItem.md
|
|
88
|
+
docs/SectionResponse.md
|
|
89
|
+
docs/SectionsApi.md
|
|
90
|
+
docs/SignInRequest.md
|
|
91
|
+
docs/TagResponse.md
|
|
92
|
+
docs/TagsApi.md
|
|
93
|
+
docs/TenantResponse.md
|
|
94
|
+
docs/TenantUserEditRequest.md
|
|
95
|
+
docs/TenantUserResponse.md
|
|
96
|
+
docs/TenantUserRole.md
|
|
97
|
+
docs/TenantsApi.md
|
|
98
|
+
docs/ThreadMessageResponse.md
|
|
99
|
+
docs/ThreadMessagesApi.md
|
|
100
|
+
docs/ThreadResponse.md
|
|
101
|
+
docs/ThreadsApi.md
|
|
102
|
+
docs/UpdateChunkContentRequest.md
|
|
103
|
+
docs/UpdateChunkMetadataRequest.md
|
|
104
|
+
docs/UpdateDocumentRequest.md
|
|
105
|
+
docs/UpdateFolderRequest.md
|
|
106
|
+
docs/UpdatePermissionRequest.md
|
|
107
|
+
docs/UpdateSectionRequest.md
|
|
108
|
+
docs/UpdateTagRequest.md
|
|
109
|
+
docs/UpdateTenantRequest.md
|
|
110
|
+
docs/UpdateThreadRequest.md
|
|
111
|
+
docs/UpdateUserRequest.md
|
|
112
|
+
docs/UserPermissionsApi.md
|
|
113
|
+
docs/UserResponse.md
|
|
114
|
+
docs/UsersApi.md
|
|
115
|
+
docs/ValidationError.md
|
|
116
|
+
docs/WorkflowAction.md
|
|
117
|
+
docs/WorkflowActionResponse.md
|
|
118
|
+
docs/WorkflowDetailResponse.md
|
|
119
|
+
docs/WorkflowSummaryResponse.md
|
|
120
|
+
docs/WorkflowsApi.md
|
|
5
121
|
package.json
|
|
6
122
|
src/apis/AuthApi.ts
|
|
7
123
|
src/apis/ChunkLineagesApi.ts
|
|
@@ -23,6 +139,7 @@ src/apis/WorkflowsApi.ts
|
|
|
23
139
|
src/apis/index.ts
|
|
24
140
|
src/index.ts
|
|
25
141
|
src/models/BulkTagRequest.ts
|
|
142
|
+
src/models/ChunkContentItem.ts
|
|
26
143
|
src/models/ChunkLineageResponse.ts
|
|
27
144
|
src/models/ChunkMetadataInput.ts
|
|
28
145
|
src/models/ChunkMetadataOutput.ts
|
|
@@ -41,7 +158,6 @@ src/models/CreateTagRequest.ts
|
|
|
41
158
|
src/models/CreateTenantRequest.ts
|
|
42
159
|
src/models/CreateThreadMessageRequest.ts
|
|
43
160
|
src/models/CreateThreadRequest.ts
|
|
44
|
-
src/models/DocumentContentPathPart.ts
|
|
45
161
|
src/models/DocumentOrigin.ts
|
|
46
162
|
src/models/DocumentResponse.ts
|
|
47
163
|
src/models/DocumentType.ts
|
|
@@ -51,8 +167,8 @@ src/models/DocumentVersionResponse.ts
|
|
|
51
167
|
src/models/EmailSentResponse.ts
|
|
52
168
|
src/models/EmailVerificationRequest.ts
|
|
53
169
|
src/models/EmbeddingModel.ts
|
|
54
|
-
src/models/FolderDocumentResponse.ts
|
|
55
170
|
src/models/FolderResponse.ts
|
|
171
|
+
src/models/FolderResponseOrDocumentResponse.ts
|
|
56
172
|
src/models/HTTPValidationError.ts
|
|
57
173
|
src/models/HealthCheckResponse.ts
|
|
58
174
|
src/models/IdpType.ts
|
|
@@ -66,17 +182,17 @@ src/models/LineageNodeResponse.ts
|
|
|
66
182
|
src/models/LocationInner.ts
|
|
67
183
|
src/models/MessageRole.ts
|
|
68
184
|
src/models/OAuth2Config.ts
|
|
69
|
-
src/models/
|
|
185
|
+
src/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.ts
|
|
186
|
+
src/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.ts
|
|
70
187
|
src/models/PaginatedResponseDocumentResponse.ts
|
|
71
188
|
src/models/PaginatedResponseDocumentVersionResponse.ts
|
|
72
|
-
src/models/PaginatedResponseFolderDocumentResponse.ts
|
|
73
189
|
src/models/PaginatedResponseFolderResponse.ts
|
|
74
190
|
src/models/PaginatedResponseInviteResponse.ts
|
|
75
191
|
src/models/PaginatedResponsePathPartResponse.ts
|
|
76
192
|
src/models/PaginatedResponsePermissionResponse.ts
|
|
77
193
|
src/models/PaginatedResponseTagResponse.ts
|
|
78
194
|
src/models/PaginatedResponseTenantResponse.ts
|
|
79
|
-
src/models/
|
|
195
|
+
src/models/PaginatedResponseTenantUserResponse.ts
|
|
80
196
|
src/models/PaginatedResponseThreadMessageResponse.ts
|
|
81
197
|
src/models/PaginatedResponseThreadResponse.ts
|
|
82
198
|
src/models/PaginatedResponseWorkflowSummaryResponse.ts
|
|
@@ -94,11 +210,14 @@ src/models/Polygon.ts
|
|
|
94
210
|
src/models/PolygonReference.ts
|
|
95
211
|
src/models/RootResponse.ts
|
|
96
212
|
src/models/ScoredChunkResponse.ts
|
|
213
|
+
src/models/SectionContentItem.ts
|
|
214
|
+
src/models/SectionContentItemOrChunkContentItem.ts
|
|
97
215
|
src/models/SectionResponse.ts
|
|
98
216
|
src/models/SignInRequest.ts
|
|
99
217
|
src/models/TagResponse.ts
|
|
100
218
|
src/models/TenantResponse.ts
|
|
101
|
-
src/models/
|
|
219
|
+
src/models/TenantUserEditRequest.ts
|
|
220
|
+
src/models/TenantUserResponse.ts
|
|
102
221
|
src/models/TenantUserRole.ts
|
|
103
222
|
src/models/ThreadMessageResponse.ts
|
|
104
223
|
src/models/ThreadResponse.ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
7.
|
|
1
|
+
7.20.0
|
package/README.md
CHANGED
|
@@ -1,46 +1,292 @@
|
|
|
1
|
-
|
|
1
|
+
# @knowledge-stack/ksapi@1.24.0
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
* Node.js
|
|
7
|
-
* Webpack
|
|
8
|
-
* Browserify
|
|
5
|
+
## Usage
|
|
9
6
|
|
|
10
|
-
|
|
11
|
-
* ES5 - you must have a Promises/A+ library installed
|
|
12
|
-
* ES6
|
|
7
|
+
First, install the SDK from npm.
|
|
13
8
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
9
|
+
```bash
|
|
10
|
+
npm install @knowledge-stack/ksapi --save
|
|
11
|
+
```
|
|
17
12
|
|
|
18
|
-
|
|
13
|
+
Next, try it out.
|
|
19
14
|
|
|
20
|
-
### Building
|
|
21
15
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
16
|
+
```ts
|
|
17
|
+
import {
|
|
18
|
+
Configuration,
|
|
19
|
+
AuthApi,
|
|
20
|
+
} from '@knowledge-stack/ksapi';
|
|
21
|
+
import type { CreatePasswordUserOperationRequest } from '@knowledge-stack/ksapi';
|
|
22
|
+
|
|
23
|
+
async function example() {
|
|
24
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
25
|
+
const api = new AuthApi();
|
|
26
|
+
|
|
27
|
+
const body = {
|
|
28
|
+
// CreatePasswordUserRequest
|
|
29
|
+
createPasswordUserRequest: ...,
|
|
30
|
+
} satisfies CreatePasswordUserOperationRequest;
|
|
31
|
+
|
|
32
|
+
try {
|
|
33
|
+
const data = await api.createPasswordUser(body);
|
|
34
|
+
console.log(data);
|
|
35
|
+
} catch (error) {
|
|
36
|
+
console.error(error);
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
// Run the test
|
|
41
|
+
example().catch(console.error);
|
|
26
42
|
```
|
|
27
43
|
|
|
28
|
-
### Publishing
|
|
29
44
|
|
|
30
|
-
|
|
45
|
+
## Documentation
|
|
31
46
|
|
|
32
|
-
###
|
|
47
|
+
### API Endpoints
|
|
33
48
|
|
|
34
|
-
|
|
49
|
+
All URIs are relative to *http://localhost:8000*
|
|
35
50
|
|
|
36
|
-
|
|
51
|
+
| Class | Method | HTTP request | Description
|
|
52
|
+
| ----- | ------ | ------------ | -------------
|
|
53
|
+
*AuthApi* | [**createPasswordUser**](docs/AuthApi.md#createpassworduseroperation) | **POST** /v1/auth/pw/user | Create Password User Handler
|
|
54
|
+
*AuthApi* | [**initiateSso**](docs/AuthApi.md#initiatesso) | **POST** /v1/auth/sso/initiate | Initiate Sso Handler
|
|
55
|
+
*AuthApi* | [**oauth2Callback**](docs/AuthApi.md#oauth2callback) | **GET** /v1/auth/sso/oauth2/callback | Oauth2 Callback Handler
|
|
56
|
+
*AuthApi* | [**pwEmailVerification**](docs/AuthApi.md#pwemailverification) | **POST** /v1/auth/pw/email_verification | Pw Email Verification Handler
|
|
57
|
+
*AuthApi* | [**pwSignin**](docs/AuthApi.md#pwsignin) | **POST** /v1/auth/pw/signin | Signin Handler
|
|
58
|
+
*AuthApi* | [**refreshUat**](docs/AuthApi.md#refreshuat) | **POST** /v1/auth/uat | Refresh Uat Handler
|
|
59
|
+
*AuthApi* | [**resetPassword**](docs/AuthApi.md#resetpassword) | **POST** /v1/auth/pw/reset | Reset Password Handler
|
|
60
|
+
*AuthApi* | [**resetPasswordWithToken**](docs/AuthApi.md#resetpasswordwithtoken) | **POST** /v1/auth/pw/reset_with_token | Reset Password With Token Handler
|
|
61
|
+
*AuthApi* | [**sendPwResetEmail**](docs/AuthApi.md#sendpwresetemail) | **POST** /v1/auth/pw/send_reset_email | Send Pw Reset Email Handler
|
|
62
|
+
*AuthApi* | [**signout**](docs/AuthApi.md#signout) | **POST** /v1/auth/signout | Signout Handler
|
|
63
|
+
*ChunkLineagesApi* | [**createChunkLineage**](docs/ChunkLineagesApi.md#createchunklineageoperation) | **POST** /v1/chunk-lineages | Create Chunk Lineage Handler
|
|
64
|
+
*ChunkLineagesApi* | [**deleteChunkLineage**](docs/ChunkLineagesApi.md#deletechunklineage) | **DELETE** /v1/chunk-lineages | Delete Chunk Lineage Handler
|
|
65
|
+
*ChunkLineagesApi* | [**getChunkLineage**](docs/ChunkLineagesApi.md#getchunklineage) | **GET** /v1/chunk-lineages/{chunk_id} | Get Chunk Lineage Handler
|
|
66
|
+
*ChunksApi* | [**createChunk**](docs/ChunksApi.md#createchunkoperation) | **POST** /v1/chunks | Create Chunk Handler
|
|
67
|
+
*ChunksApi* | [**deleteChunk**](docs/ChunksApi.md#deletechunk) | **DELETE** /v1/chunks/{chunk_id} | Delete Chunk Handler
|
|
68
|
+
*ChunksApi* | [**getChunk**](docs/ChunksApi.md#getchunk) | **GET** /v1/chunks/{chunk_id} | Get Chunk Handler
|
|
69
|
+
*ChunksApi* | [**searchChunks**](docs/ChunksApi.md#searchchunks) | **POST** /v1/chunks/search | Search Chunks Handler
|
|
70
|
+
*ChunksApi* | [**updateChunkContent**](docs/ChunksApi.md#updatechunkcontentoperation) | **PATCH** /v1/chunks/{chunk_id}/content | Update Chunk Content Handler
|
|
71
|
+
*ChunksApi* | [**updateChunkMetadata**](docs/ChunksApi.md#updatechunkmetadataoperation) | **PATCH** /v1/chunks/{chunk_id} | Update Chunk Metadata Handler
|
|
72
|
+
*DefaultApi* | [**healthCheck**](docs/DefaultApi.md#healthcheck) | **GET** /healthz | Health Check Handler
|
|
73
|
+
*DefaultApi* | [**hello**](docs/DefaultApi.md#hello) | **GET** / | Root Handler
|
|
74
|
+
*DocumentVersionsApi* | [**clearDocumentVersionContents**](docs/DocumentVersionsApi.md#cleardocumentversioncontents) | **DELETE** /v1/document_versions/{version_id}/contents | Clear Document Version Contents Handler
|
|
75
|
+
*DocumentVersionsApi* | [**createDocumentVersion**](docs/DocumentVersionsApi.md#createdocumentversion) | **POST** /v1/documents/{document_id}/versions | Create Document Version Handler
|
|
76
|
+
*DocumentVersionsApi* | [**deleteDocumentVersion**](docs/DocumentVersionsApi.md#deletedocumentversion) | **DELETE** /v1/document_versions/{version_id} | Delete Document Version Handler
|
|
77
|
+
*DocumentVersionsApi* | [**getDocumentVersion**](docs/DocumentVersionsApi.md#getdocumentversion) | **GET** /v1/document_versions/{version_id} | Get Document Version Handler
|
|
78
|
+
*DocumentVersionsApi* | [**getDocumentVersionContents**](docs/DocumentVersionsApi.md#getdocumentversioncontents) | **GET** /v1/document_versions/{version_id}/contents | Get Document Version Contents Handler
|
|
79
|
+
*DocumentVersionsApi* | [**listDocumentVersions**](docs/DocumentVersionsApi.md#listdocumentversions) | **GET** /v1/document_versions | List Document Versions Handler
|
|
80
|
+
*DocumentVersionsApi* | [**updateDocumentVersionMetadata**](docs/DocumentVersionsApi.md#updatedocumentversionmetadata) | **PATCH** /v1/document_versions/{version_id}/metadata | Update Document Version Metadata Handler
|
|
81
|
+
*DocumentsApi* | [**createDocument**](docs/DocumentsApi.md#createdocumentoperation) | **POST** /v1/documents | Create Document Handler
|
|
82
|
+
*DocumentsApi* | [**deleteDocument**](docs/DocumentsApi.md#deletedocument) | **DELETE** /v1/documents/{document_id} | Delete Document Handler
|
|
83
|
+
*DocumentsApi* | [**getDocument**](docs/DocumentsApi.md#getdocument) | **GET** /v1/documents/{document_id} | Get Document Handler
|
|
84
|
+
*DocumentsApi* | [**ingestDocument**](docs/DocumentsApi.md#ingestdocument) | **POST** /v1/documents/ingest | Ingest Document Handler
|
|
85
|
+
*DocumentsApi* | [**listDocuments**](docs/DocumentsApi.md#listdocuments) | **GET** /v1/documents | List Documents Handler
|
|
86
|
+
*DocumentsApi* | [**updateDocument**](docs/DocumentsApi.md#updatedocumentoperation) | **PATCH** /v1/documents/{document_id} | Update Document Handler
|
|
87
|
+
*FoldersApi* | [**createFolder**](docs/FoldersApi.md#createfolderoperation) | **POST** /v1/folders | Create Folder Handler
|
|
88
|
+
*FoldersApi* | [**deleteFolder**](docs/FoldersApi.md#deletefolder) | **DELETE** /v1/folders/{folder_id} | Delete Folder Handler
|
|
89
|
+
*FoldersApi* | [**getFolder**](docs/FoldersApi.md#getfolder) | **GET** /v1/folders/{folder_id} | Get Folder Handler
|
|
90
|
+
*FoldersApi* | [**listFolderContents**](docs/FoldersApi.md#listfoldercontents) | **GET** /v1/folders/{folder_id}/contents | List Folder Contents Handler
|
|
91
|
+
*FoldersApi* | [**listFolders**](docs/FoldersApi.md#listfolders) | **GET** /v1/folders | List Folders Handler
|
|
92
|
+
*FoldersApi* | [**updateFolder**](docs/FoldersApi.md#updatefolderoperation) | **PATCH** /v1/folders/{folder_id} | Update Folder Handler
|
|
93
|
+
*InvitesApi* | [**acceptInvite**](docs/InvitesApi.md#acceptinvite) | **POST** /v1/invites/{invite_id}/accept | Accept Invite
|
|
94
|
+
*InvitesApi* | [**createInvite**](docs/InvitesApi.md#createinvite) | **POST** /v1/invites | Create Invite
|
|
95
|
+
*InvitesApi* | [**deleteInvite**](docs/InvitesApi.md#deleteinvite) | **DELETE** /v1/invites/{invite_id} | Delete Invite
|
|
96
|
+
*InvitesApi* | [**listInvites**](docs/InvitesApi.md#listinvites) | **GET** /v1/invites | List Invites Handler
|
|
97
|
+
*PathPartsApi* | [**bulkAddPathPartTags**](docs/PathPartsApi.md#bulkaddpathparttags) | **POST** /v1/path-parts/{path_part_id}/tags | Bulk Add Path Part Tags Handler
|
|
98
|
+
*PathPartsApi* | [**bulkRemovePathPartTags**](docs/PathPartsApi.md#bulkremovepathparttags) | **DELETE** /v1/path-parts/{path_part_id}/tags | Bulk Remove Path Part Tags Handler
|
|
99
|
+
*PathPartsApi* | [**getPathPart**](docs/PathPartsApi.md#getpathpart) | **GET** /v1/path-parts/{path_part_id} | Get Path Part Handler
|
|
100
|
+
*PathPartsApi* | [**listPathParts**](docs/PathPartsApi.md#listpathparts) | **GET** /v1/path-parts | List Path Parts Handler
|
|
101
|
+
*SectionsApi* | [**createSection**](docs/SectionsApi.md#createsectionoperation) | **POST** /v1/sections | Create Section Handler
|
|
102
|
+
*SectionsApi* | [**deleteSection**](docs/SectionsApi.md#deletesection) | **DELETE** /v1/sections/{section_id} | Delete Section Handler
|
|
103
|
+
*SectionsApi* | [**getSection**](docs/SectionsApi.md#getsection) | **GET** /v1/sections/{section_id} | Get Section Handler
|
|
104
|
+
*SectionsApi* | [**updateSection**](docs/SectionsApi.md#updatesectionoperation) | **PATCH** /v1/sections/{section_id} | Update Section Handler
|
|
105
|
+
*TagsApi* | [**createTag**](docs/TagsApi.md#createtagoperation) | **POST** /v1/tags | Create Tag Handler
|
|
106
|
+
*TagsApi* | [**deleteTag**](docs/TagsApi.md#deletetag) | **DELETE** /v1/tags/{tag_id} | Delete Tag Handler
|
|
107
|
+
*TagsApi* | [**getTag**](docs/TagsApi.md#gettag) | **GET** /v1/tags/{tag_id} | Get Tag Handler
|
|
108
|
+
*TagsApi* | [**listTags**](docs/TagsApi.md#listtags) | **GET** /v1/tags | List Tags Handler
|
|
109
|
+
*TagsApi* | [**updateTag**](docs/TagsApi.md#updatetagoperation) | **PATCH** /v1/tags/{tag_id} | Update Tag Handler
|
|
110
|
+
*TenantsApi* | [**createTenant**](docs/TenantsApi.md#createtenantoperation) | **POST** /v1/tenants | Create Tenant
|
|
111
|
+
*TenantsApi* | [**deleteTenant**](docs/TenantsApi.md#deletetenant) | **DELETE** /v1/tenants/{tenant_id} | Delete Tenant
|
|
112
|
+
*TenantsApi* | [**deleteTenantUser**](docs/TenantsApi.md#deletetenantuser) | **DELETE** /v1/tenants/{tenant_id}/users/{user_id} | Delete Tenant User
|
|
113
|
+
*TenantsApi* | [**getTenant**](docs/TenantsApi.md#gettenant) | **GET** /v1/tenants/{tenant_id} | Get Tenant
|
|
114
|
+
*TenantsApi* | [**listTenantUsers**](docs/TenantsApi.md#listtenantusers) | **GET** /v1/tenants/{tenant_id}/users | List Tenant Users
|
|
115
|
+
*TenantsApi* | [**listTenants**](docs/TenantsApi.md#listtenants) | **GET** /v1/tenants | List Tenants
|
|
116
|
+
*TenantsApi* | [**updateTenant**](docs/TenantsApi.md#updatetenantoperation) | **PATCH** /v1/tenants/{tenant_id} | Update Tenant
|
|
117
|
+
*TenantsApi* | [**updateTenantUser**](docs/TenantsApi.md#updatetenantuser) | **PATCH** /v1/tenants/{tenant_id}/users/{user_id} | Update Tenant User
|
|
118
|
+
*ThreadMessagesApi* | [**createThreadMessage**](docs/ThreadMessagesApi.md#createthreadmessageoperation) | **POST** /v1/threads/{thread_id}/messages | Create Thread Message Handler
|
|
119
|
+
*ThreadMessagesApi* | [**getThreadMessage**](docs/ThreadMessagesApi.md#getthreadmessage) | **GET** /v1/threads/{thread_id}/messages/{message_id} | Get Thread Message Handler
|
|
120
|
+
*ThreadMessagesApi* | [**listThreadMessages**](docs/ThreadMessagesApi.md#listthreadmessages) | **GET** /v1/threads/{thread_id}/messages | List Thread Messages Handler
|
|
121
|
+
*ThreadsApi* | [**createThread**](docs/ThreadsApi.md#createthreadoperation) | **POST** /v1/threads | Create Thread Handler
|
|
122
|
+
*ThreadsApi* | [**deleteThread**](docs/ThreadsApi.md#deletethread) | **DELETE** /v1/threads/{thread_id} | Delete Thread Handler
|
|
123
|
+
*ThreadsApi* | [**getThread**](docs/ThreadsApi.md#getthread) | **GET** /v1/threads/{thread_id} | Get Thread Handler
|
|
124
|
+
*ThreadsApi* | [**listThreads**](docs/ThreadsApi.md#listthreads) | **GET** /v1/threads | List Threads Handler
|
|
125
|
+
*ThreadsApi* | [**streamThread**](docs/ThreadsApi.md#streamthread) | **GET** /v1/threads/{thread_id}/stream | Stream Thread Handler
|
|
126
|
+
*ThreadsApi* | [**updateThread**](docs/ThreadsApi.md#updatethreadoperation) | **PATCH** /v1/threads/{thread_id} | Update Thread Handler
|
|
127
|
+
*UserPermissionsApi* | [**createUserPermission**](docs/UserPermissionsApi.md#createuserpermission) | **POST** /v1/user-permissions | Create User Permission Handler
|
|
128
|
+
*UserPermissionsApi* | [**deleteUserPermission**](docs/UserPermissionsApi.md#deleteuserpermission) | **DELETE** /v1/user-permissions/{permission_id} | Delete User Permission Handler
|
|
129
|
+
*UserPermissionsApi* | [**listUserPermissions**](docs/UserPermissionsApi.md#listuserpermissions) | **GET** /v1/user-permissions | List User Permissions Handler
|
|
130
|
+
*UserPermissionsApi* | [**updateUserPermission**](docs/UserPermissionsApi.md#updateuserpermission) | **PATCH** /v1/user-permissions/{permission_id} | Update User Permission Handler
|
|
131
|
+
*UsersApi* | [**getMe**](docs/UsersApi.md#getme) | **GET** /v1/users/me | Get Me Handler
|
|
132
|
+
*UsersApi* | [**updateMe**](docs/UsersApi.md#updateme) | **PATCH** /v1/users | Update Me Handler
|
|
133
|
+
*WorkflowsApi* | [**getWorkflow**](docs/WorkflowsApi.md#getworkflow) | **GET** /v1/workflows/{workflow_id} | Get Workflow Handler
|
|
134
|
+
*WorkflowsApi* | [**listWorkflows**](docs/WorkflowsApi.md#listworkflows) | **GET** /v1/workflows | List Workflows Handler
|
|
135
|
+
*WorkflowsApi* | [**workflowAction**](docs/WorkflowsApi.md#workflowaction) | **POST** /v1/workflows/{workflow_id} | Workflow Action Handler
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
### Models
|
|
139
|
+
|
|
140
|
+
- [BulkTagRequest](docs/BulkTagRequest.md)
|
|
141
|
+
- [ChunkContentItem](docs/ChunkContentItem.md)
|
|
142
|
+
- [ChunkLineageResponse](docs/ChunkLineageResponse.md)
|
|
143
|
+
- [ChunkMetadataInput](docs/ChunkMetadataInput.md)
|
|
144
|
+
- [ChunkMetadataOutput](docs/ChunkMetadataOutput.md)
|
|
145
|
+
- [ChunkResponse](docs/ChunkResponse.md)
|
|
146
|
+
- [ChunkSearchRequest](docs/ChunkSearchRequest.md)
|
|
147
|
+
- [ChunkType](docs/ChunkType.md)
|
|
148
|
+
- [ClearVersionContentsResponse](docs/ClearVersionContentsResponse.md)
|
|
149
|
+
- [CreateChunkLineageRequest](docs/CreateChunkLineageRequest.md)
|
|
150
|
+
- [CreateChunkRequest](docs/CreateChunkRequest.md)
|
|
151
|
+
- [CreateDocumentRequest](docs/CreateDocumentRequest.md)
|
|
152
|
+
- [CreateFolderRequest](docs/CreateFolderRequest.md)
|
|
153
|
+
- [CreatePasswordUserRequest](docs/CreatePasswordUserRequest.md)
|
|
154
|
+
- [CreatePermissionRequest](docs/CreatePermissionRequest.md)
|
|
155
|
+
- [CreateSectionRequest](docs/CreateSectionRequest.md)
|
|
156
|
+
- [CreateTagRequest](docs/CreateTagRequest.md)
|
|
157
|
+
- [CreateTenantRequest](docs/CreateTenantRequest.md)
|
|
158
|
+
- [CreateThreadMessageRequest](docs/CreateThreadMessageRequest.md)
|
|
159
|
+
- [CreateThreadRequest](docs/CreateThreadRequest.md)
|
|
160
|
+
- [DocumentOrigin](docs/DocumentOrigin.md)
|
|
161
|
+
- [DocumentResponse](docs/DocumentResponse.md)
|
|
162
|
+
- [DocumentType](docs/DocumentType.md)
|
|
163
|
+
- [DocumentVersionMetadata](docs/DocumentVersionMetadata.md)
|
|
164
|
+
- [DocumentVersionMetadataUpdate](docs/DocumentVersionMetadataUpdate.md)
|
|
165
|
+
- [DocumentVersionResponse](docs/DocumentVersionResponse.md)
|
|
166
|
+
- [EmailSentResponse](docs/EmailSentResponse.md)
|
|
167
|
+
- [EmailVerificationRequest](docs/EmailVerificationRequest.md)
|
|
168
|
+
- [EmbeddingModel](docs/EmbeddingModel.md)
|
|
169
|
+
- [FolderResponse](docs/FolderResponse.md)
|
|
170
|
+
- [FolderResponseOrDocumentResponse](docs/FolderResponseOrDocumentResponse.md)
|
|
171
|
+
- [HTTPValidationError](docs/HTTPValidationError.md)
|
|
172
|
+
- [HealthCheckResponse](docs/HealthCheckResponse.md)
|
|
173
|
+
- [IdpType](docs/IdpType.md)
|
|
174
|
+
- [IngestDocumentResponse](docs/IngestDocumentResponse.md)
|
|
175
|
+
- [InviteResponse](docs/InviteResponse.md)
|
|
176
|
+
- [InviteStatus](docs/InviteStatus.md)
|
|
177
|
+
- [InviteUserRequest](docs/InviteUserRequest.md)
|
|
178
|
+
- [LineageEdgeResponse](docs/LineageEdgeResponse.md)
|
|
179
|
+
- [LineageGraphResponse](docs/LineageGraphResponse.md)
|
|
180
|
+
- [LineageNodeResponse](docs/LineageNodeResponse.md)
|
|
181
|
+
- [LocationInner](docs/LocationInner.md)
|
|
182
|
+
- [MessageRole](docs/MessageRole.md)
|
|
183
|
+
- [OAuth2Config](docs/OAuth2Config.md)
|
|
184
|
+
- [PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator](docs/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md)
|
|
185
|
+
- [PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator](docs/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.md)
|
|
186
|
+
- [PaginatedResponseDocumentResponse](docs/PaginatedResponseDocumentResponse.md)
|
|
187
|
+
- [PaginatedResponseDocumentVersionResponse](docs/PaginatedResponseDocumentVersionResponse.md)
|
|
188
|
+
- [PaginatedResponseFolderResponse](docs/PaginatedResponseFolderResponse.md)
|
|
189
|
+
- [PaginatedResponseInviteResponse](docs/PaginatedResponseInviteResponse.md)
|
|
190
|
+
- [PaginatedResponsePathPartResponse](docs/PaginatedResponsePathPartResponse.md)
|
|
191
|
+
- [PaginatedResponsePermissionResponse](docs/PaginatedResponsePermissionResponse.md)
|
|
192
|
+
- [PaginatedResponseTagResponse](docs/PaginatedResponseTagResponse.md)
|
|
193
|
+
- [PaginatedResponseTenantResponse](docs/PaginatedResponseTenantResponse.md)
|
|
194
|
+
- [PaginatedResponseTenantUserResponse](docs/PaginatedResponseTenantUserResponse.md)
|
|
195
|
+
- [PaginatedResponseThreadMessageResponse](docs/PaginatedResponseThreadMessageResponse.md)
|
|
196
|
+
- [PaginatedResponseThreadResponse](docs/PaginatedResponseThreadResponse.md)
|
|
197
|
+
- [PaginatedResponseWorkflowSummaryResponse](docs/PaginatedResponseWorkflowSummaryResponse.md)
|
|
198
|
+
- [PartType](docs/PartType.md)
|
|
199
|
+
- [PasswordResetRequest](docs/PasswordResetRequest.md)
|
|
200
|
+
- [PasswordResetWithTokenRequest](docs/PasswordResetWithTokenRequest.md)
|
|
201
|
+
- [PathOrder](docs/PathOrder.md)
|
|
202
|
+
- [PathPartResponse](docs/PathPartResponse.md)
|
|
203
|
+
- [PathPartTagsResponse](docs/PathPartTagsResponse.md)
|
|
204
|
+
- [PermissionCapability](docs/PermissionCapability.md)
|
|
205
|
+
- [PermissionResponse](docs/PermissionResponse.md)
|
|
206
|
+
- [PipelineState](docs/PipelineState.md)
|
|
207
|
+
- [PipelineStatus](docs/PipelineStatus.md)
|
|
208
|
+
- [Polygon](docs/Polygon.md)
|
|
209
|
+
- [PolygonReference](docs/PolygonReference.md)
|
|
210
|
+
- [RootResponse](docs/RootResponse.md)
|
|
211
|
+
- [ScoredChunkResponse](docs/ScoredChunkResponse.md)
|
|
212
|
+
- [SectionContentItem](docs/SectionContentItem.md)
|
|
213
|
+
- [SectionContentItemOrChunkContentItem](docs/SectionContentItemOrChunkContentItem.md)
|
|
214
|
+
- [SectionResponse](docs/SectionResponse.md)
|
|
215
|
+
- [SignInRequest](docs/SignInRequest.md)
|
|
216
|
+
- [TagResponse](docs/TagResponse.md)
|
|
217
|
+
- [TenantResponse](docs/TenantResponse.md)
|
|
218
|
+
- [TenantUserEditRequest](docs/TenantUserEditRequest.md)
|
|
219
|
+
- [TenantUserResponse](docs/TenantUserResponse.md)
|
|
220
|
+
- [TenantUserRole](docs/TenantUserRole.md)
|
|
221
|
+
- [ThreadMessageResponse](docs/ThreadMessageResponse.md)
|
|
222
|
+
- [ThreadResponse](docs/ThreadResponse.md)
|
|
223
|
+
- [UpdateChunkContentRequest](docs/UpdateChunkContentRequest.md)
|
|
224
|
+
- [UpdateChunkMetadataRequest](docs/UpdateChunkMetadataRequest.md)
|
|
225
|
+
- [UpdateDocumentRequest](docs/UpdateDocumentRequest.md)
|
|
226
|
+
- [UpdateFolderRequest](docs/UpdateFolderRequest.md)
|
|
227
|
+
- [UpdatePermissionRequest](docs/UpdatePermissionRequest.md)
|
|
228
|
+
- [UpdateSectionRequest](docs/UpdateSectionRequest.md)
|
|
229
|
+
- [UpdateTagRequest](docs/UpdateTagRequest.md)
|
|
230
|
+
- [UpdateTenantRequest](docs/UpdateTenantRequest.md)
|
|
231
|
+
- [UpdateThreadRequest](docs/UpdateThreadRequest.md)
|
|
232
|
+
- [UpdateUserRequest](docs/UpdateUserRequest.md)
|
|
233
|
+
- [UserResponse](docs/UserResponse.md)
|
|
234
|
+
- [ValidationError](docs/ValidationError.md)
|
|
235
|
+
- [WorkflowAction](docs/WorkflowAction.md)
|
|
236
|
+
- [WorkflowActionResponse](docs/WorkflowActionResponse.md)
|
|
237
|
+
- [WorkflowDetailResponse](docs/WorkflowDetailResponse.md)
|
|
238
|
+
- [WorkflowSummaryResponse](docs/WorkflowSummaryResponse.md)
|
|
239
|
+
|
|
240
|
+
### Authorization
|
|
241
|
+
|
|
242
|
+
Endpoints do not require authorization.
|
|
37
243
|
|
|
38
|
-
```
|
|
39
|
-
npm install @knowledge-stack/ksapi@1.23.4 --save
|
|
40
|
-
```
|
|
41
244
|
|
|
42
|
-
|
|
245
|
+
## About
|
|
43
246
|
|
|
247
|
+
This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
|
|
248
|
+
and is automatically generated by the
|
|
249
|
+
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
250
|
+
|
|
251
|
+
- API version: `0.1.0`
|
|
252
|
+
- Package version: `1.24.0`
|
|
253
|
+
- Generator version: `7.20.0`
|
|
254
|
+
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
255
|
+
|
|
256
|
+
The generated npm module supports the following:
|
|
257
|
+
|
|
258
|
+
- Environments
|
|
259
|
+
* Node.js
|
|
260
|
+
* Webpack
|
|
261
|
+
* Browserify
|
|
262
|
+
- Language levels
|
|
263
|
+
* ES5 - you must have a Promises/A+ library installed
|
|
264
|
+
* ES6
|
|
265
|
+
- Module systems
|
|
266
|
+
* CommonJS
|
|
267
|
+
* ES6 module system
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
## Development
|
|
271
|
+
|
|
272
|
+
### Building
|
|
273
|
+
|
|
274
|
+
To build the TypeScript source code, you need to have Node.js and npm installed.
|
|
275
|
+
After cloning the repository, navigate to the project directory and run:
|
|
276
|
+
|
|
277
|
+
```bash
|
|
278
|
+
npm install
|
|
279
|
+
npm run build
|
|
44
280
|
```
|
|
45
|
-
|
|
281
|
+
|
|
282
|
+
### Publishing
|
|
283
|
+
|
|
284
|
+
Once you've built the package, you can publish it to npm:
|
|
285
|
+
|
|
286
|
+
```bash
|
|
287
|
+
npm publish
|
|
46
288
|
```
|
|
289
|
+
|
|
290
|
+
## License
|
|
291
|
+
|
|
292
|
+
[]()
|