@knowledge-stack/ksapi 1.19.5 → 1.20.1

package/src/apis/DocumentsApi.ts

@@ -42,38 +42,38 @@ import {
 
 export interface CreateDocumentOperationRequest {
     createDocumentRequest: CreateDocumentRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface DeleteDocumentRequest {
     documentId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface GetDocumentRequest {
     documentId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface IngestDocumentRequest {
     file: Blob;
-    folderId: string;
-    ksUat?: string;
-    name?: string;
+    pathPartId: string;
+    ksUat?: string | null;
+    name?: string | null;
 }
 
 export interface ListDocumentsRequest {
-    parentPathPartId?: string;
+    parentPathPartId?: string | null;
     sortOrder?: PathOrder;
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface UpdateDocumentOperationRequest {
     documentId: string;
     updateDocumentRequest: UpdateDocumentRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**
@@ -138,7 +138,7 @@ export interface DocumentsApiInterface {
      * Upload a file, create document + version, and trigger ingestion workflow.  Returns 201 with the Temporal workflow ID.  Design decision — S3 upload happens *before* the DB write: We pre-generate document and version UUIDs, upload the source file to S3, and only then persist the DB records. If the DB write fails, an orphaned S3 object is left behind (acceptable storage cost cleaned up by the S3 deletion cronjob). The reverse — a committed DB record pointing to a missing S3 object — would crash downstream pipeline activities that expect the file to exist.
      * @summary Ingest Document Handler
      * @param {Blob} file 
-     * @param {string} folderId Parent folder ID
+     * @param {string} pathPartId Parent path part ID (must be a FOLDER type)
      * @param {string} [ksUat] 
      * @param {string} [name] Document name (defaults to filename)
      * @param {*} [options] Override http request option.
@@ -154,7 +154,7 @@ export interface DocumentsApiInterface {
     ingestDocument(requestParameters: IngestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
 
     /**
-     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists documents in the root folder.
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
      * @summary List Documents Handler
      * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
      * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
@@ -168,7 +168,7 @@ export interface DocumentsApiInterface {
     listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>>;
 
     /**
-     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists documents in the root folder.
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
      * List Documents Handler
      */
     listDocuments(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse>;
@@ -328,10 +328,10 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
             );
         }
 
-        if (requestParameters['folderId'] == null) {
+        if (requestParameters['pathPartId'] == null) {
             throw new runtime.RequiredError(
-                'folderId',
-                'Required parameter "folderId" was null or undefined when calling ingestDocument().'
+                'pathPartId',
+                'Required parameter "pathPartId" was null or undefined when calling ingestDocument().'
             );
         }
 
@@ -359,8 +359,8 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
             formParams.append('file', requestParameters['file'] as any);
         }
 
-        if (requestParameters['folderId'] != null) {
-            formParams.append('folder_id', requestParameters['folderId'] as any);
+        if (requestParameters['pathPartId'] != null) {
+            formParams.append('path_part_id', requestParameters['pathPartId'] as any);
         }
 
         if (requestParameters['name'] != null) {
@@ -391,7 +391,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists documents in the root folder.
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
      * List Documents Handler
      */
     async listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseDocumentResponse>> {
@@ -429,7 +429,7 @@ export class DocumentsApi extends runtime.BaseAPI implements DocumentsApiInterfa
     }
 
     /**
-     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists documents in the root folder.
+     * List documents in a folder.  Returns only direct child documents (depth=1) of the specified parent folder. If parent_path_part_id is not provided, lists top-level documents.
      * List Documents Handler
      */
     async listDocuments(requestParameters: ListDocumentsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseDocumentResponse> {

package/src/apis/FoldersApi.ts

@@ -42,17 +42,17 @@ import {
 
 export interface CreateFolderOperationRequest {
     createFolderRequest: CreateFolderRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface DeleteFolderRequest {
     folderId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface GetFolderRequest {
     folderId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListFolderContentsRequest {
@@ -61,21 +61,21 @@ export interface ListFolderContentsRequest {
     sortOrder?: PathOrder;
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListFoldersRequest {
-    parentPathPartId?: string;
+    parentPathPartId?: string | null;
     sortOrder?: PathOrder;
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface UpdateFolderOperationRequest {
     folderId: string;
     updateFolderRequest: UpdateFolderRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**
@@ -158,7 +158,7 @@ export interface FoldersApiInterface {
     listFolderContents(requestParameters: ListFolderContentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderDocumentResponse>;
 
     /**
-     * List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists folders in the root folder.
+     * List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders.  At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
      * @summary List Folders Handler
      * @param {string} [parentPathPartId] Parent PathPart ID (defaults to root)
      * @param {PathOrder} [sortOrder] Sort order for results (default: LOGICAL)
@@ -172,7 +172,7 @@ export interface FoldersApiInterface {
     listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>>;
 
     /**
-     * List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists folders in the root folder.
+     * List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders.  At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
      * List Folders Handler
      */
     listFolders(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse>;
@@ -376,7 +376,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
     }
 
     /**
-     * List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists folders in the root folder.
+     * List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders.  At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
      * List Folders Handler
      */
     async listFoldersRaw(requestParameters: ListFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFolderResponse>> {
@@ -414,7 +414,7 @@ export class FoldersApi extends runtime.BaseAPI implements FoldersApiInterface {
     }
 
     /**
-     * List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists folders in the root folder.
+     * List child folders of a parent folder.  Returns only direct child folders (depth=1) of the specified parent. If parent_path_part_id is not provided, lists top-level folders.  At root level, the /users folder is hidden and replaced with the current user\'s personal folder (/users/{user_id}) displayed as \"Personal\".
      * List Folders Handler
      */
     async listFolders(requestParameters: ListFoldersRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFolderResponse> {

package/src/apis/InvitesApi.ts

@@ -36,25 +36,25 @@ import {
 
 export interface AcceptInviteRequest {
     inviteId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface CreateInviteRequest {
     inviteUserRequest: InviteUserRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface DeleteInviteRequest {
     inviteId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListInvitesRequest {
-    email?: string;
+    email?: string | null;
     status?: InviteStatus;
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**

package/src/apis/PathPartsApi.ts

@@ -33,16 +33,16 @@ import {
 
 export interface GetPathPartRequest {
     pathPartId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListPathPartsRequest {
-    parentPathId?: string;
+    parentPathId?: string | null;
     maxDepth?: number;
     sortOrder?: PathOrder;
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**

package/src/apis/SectionsApi.ts

@@ -33,23 +33,23 @@ import {
 
 export interface CreateSectionOperationRequest {
     createSectionRequest: CreateSectionRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface DeleteSectionRequest {
     sectionId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface GetSectionRequest {
     sectionId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface UpdateSectionOperationRequest {
     sectionId: string;
     updateSectionRequest: UpdateSectionRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**

package/src/apis/TagsApi.ts

@@ -40,40 +40,40 @@ import {
 export interface AttachTagToPathPartRequest {
     tagId: string;
     tagPathPartRequest: TagPathPartRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface CreateTagOperationRequest {
     createTagRequest: CreateTagRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface DeleteTagRequest {
     tagId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface DetachTagFromPathPartRequest {
     tagId: string;
     pathPartId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface GetTagRequest {
     tagId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListTagsRequest {
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface UpdateTagOperationRequest {
     tagId: string;
     updateTagRequest: UpdateTagRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**

package/src/apis/TenantsApi.ts

@@ -39,36 +39,36 @@ import {
 
 export interface CreateTenantOperationRequest {
     createTenantRequest: CreateTenantRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface DeleteTenantRequest {
     tenantId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface GetTenantRequest {
     tenantId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListTenantUsersRequest {
     tenantId: string;
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListTenantsRequest {
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface UpdateTenantOperationRequest {
     tenantId: string;
     updateTenantRequest: UpdateTenantRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**

package/src/apis/ThreadMessagesApi.ts

@@ -34,21 +34,21 @@ import {
 export interface CreateThreadMessageOperationRequest {
     threadId: string;
     createThreadMessageRequest: CreateThreadMessageRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface GetThreadMessageRequest {
     threadId: string;
     messageId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListThreadMessagesRequest {
     threadId: string;
-    before?: Date;
+    before?: Date | null;
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**

package/src/apis/ThreadsApi.ts

@@ -36,30 +36,30 @@ import {
 
 export interface CreateThreadOperationRequest {
     createThreadRequest: CreateThreadRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface DeleteThreadRequest {
     threadId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface GetThreadRequest {
     threadId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListThreadsRequest {
-    parentPathPartId?: string;
+    parentPathPartId?: string | null;
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface UpdateThreadOperationRequest {
     threadId: string;
     updateThreadRequest: UpdateThreadRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**

package/src/apis/UserPermissionsApi.ts

@@ -36,13 +36,13 @@ import {
 
 export interface CreateUserPermissionRequest {
     createPermissionRequest: CreatePermissionRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface DeleteUserPermissionRequest {
     permissionId: string;
     tenantId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListUserPermissionsRequest {
@@ -50,14 +50,14 @@ export interface ListUserPermissionsRequest {
     userId: string;
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface UpdateUserPermissionRequest {
     permissionId: string;
     tenantId: string;
     updatePermissionRequest: UpdatePermissionRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**

package/src/apis/UsersApi.ts

@@ -29,12 +29,12 @@ import {
 } from '../models/index';
 
 export interface GetMeRequest {
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface UpdateMeRequest {
     updateUserRequest: UpdateUserRequest;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**

package/src/apis/WorkflowsApi.ts

@@ -36,19 +36,19 @@ import {
 
 export interface GetWorkflowRequest {
     workflowId: string;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface ListWorkflowsRequest {
     limit?: number;
     offset?: number;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 export interface WorkflowActionRequest {
     workflowId: string;
     action: WorkflowAction;
-    ksUat?: string;
+    ksUat?: string | null;
 }
 
 /**

package/src/models/ChunkMetadataInput.ts

@@ -33,6 +33,12 @@ export interface ChunkMetadataInput {
      * @memberof ChunkMetadataInput
      */
     polygons?: Array<PolygonReference>;
+    /**
+     * Full s3:// URI to the visual asset for this chunk. Set for IMAGE and TABLE chunks.
+     * @type {string}
+     * @memberof ChunkMetadataInput
+     */
+    s3Url?: string | null;
 }
 
 /**
@@ -53,6 +59,7 @@ export function ChunkMetadataInputFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
+        's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
     };
 }
 
@@ -68,6 +75,7 @@ export function ChunkMetadataInputToJSONTyped(value?: ChunkMetadataInput | null,
     return {
         
         'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
+        's3_url': value['s3Url'],
     };
 }
 

package/src/models/ChunkMetadataOutput.ts

@@ -33,6 +33,12 @@ export interface ChunkMetadataOutput {
      * @memberof ChunkMetadataOutput
      */
     polygons?: Array<PolygonReference>;
+    /**
+     * Full s3:// URI to the visual asset for this chunk. Set for IMAGE and TABLE chunks.
+     * @type {string}
+     * @memberof ChunkMetadataOutput
+     */
+    s3Url?: string | null;
 }
 
 /**
@@ -53,6 +59,7 @@ export function ChunkMetadataOutputFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'polygons': json['polygons'] == null ? undefined : ((json['polygons'] as Array<any>).map(PolygonReferenceFromJSON)),
+        's3Url': json['s3_url'] == null ? undefined : json['s3_url'],
     };
 }
 
@@ -68,6 +75,7 @@ export function ChunkMetadataOutputToJSONTyped(value?: ChunkMetadataOutput | nul
     return {
         
         'polygons': value['polygons'] == null ? undefined : ((value['polygons'] as Array<any>).map(PolygonReferenceToJSON)),
+        's3_url': value['s3Url'],
     };
 }
 

package/src/models/ChunkResponse.ts

@@ -59,13 +59,13 @@ export interface ChunkResponse {
      */
     content: string;
     /**
-     * Type of chunk content
+     * 
      * @type {ChunkType}
      * @memberof ChunkResponse
      */
     chunkType: ChunkType;
     /**
-     * Chunk metadata
+     * 
      * @type {ChunkMetadataOutput}
      * @memberof ChunkResponse
      */
@@ -81,13 +81,13 @@ export interface ChunkResponse {
      * @type {string}
      * @memberof ChunkResponse
      */
-    prevSiblingPathId?: string;
+    prevSiblingPathId?: string | null;
     /**
      * Next sibling PathPart ID
      * @type {string}
      * @memberof ChunkResponse
      */
-    nextSiblingPathId?: string;
+    nextSiblingPathId?: string | null;
     /**
      * Full materialized path from root
      * @type {string}

package/src/models/ChunkSearchRequest.ts

@@ -41,19 +41,19 @@ export interface ChunkSearchRequest {
      */
     query: string;
     /**
-     * Embedding model to use
+     * 
      * @type {EmbeddingModel}
      * @memberof ChunkSearchRequest
      */
     model?: EmbeddingModel;
     /**
-     * Path part IDs to search within (non-CHUNK types). Defaults to tenant's /KS_ROOT/shared.
+     * Path part IDs to search within (non-CHUNK types). Defaults to tenant's /shared.
      * @type {Array<string>}
      * @memberof ChunkSearchRequest
      */
-    parentPathIds?: Array<string>;
+    parentPathIds?: Array<string> | null;
     /**
-     * Filter by chunk type (TEXT, TABLE, IMAGE, UNKNOWN)
+     * 
      * @type {ChunkType}
      * @memberof ChunkSearchRequest
      */
@@ -63,7 +63,7 @@ export interface ChunkSearchRequest {
      * @type {Date}
      * @memberof ChunkSearchRequest
      */
-    updatedAt?: Date;
+    updatedAt?: Date | null;
     /**
      * Number of results (1-50)
      * @type {number}
@@ -155,6 +155,3 @@ export const ChunkSearchRequestPropertyValidationAttributesMap: {
     },
 }
 
-export const ChunkSearchRequestAdditionalPropertiesValidationAttributes: { maxProperties?: number, minProperties?: number } = {
-}
-