@knowledge-stack/ksapi 1.30.0 → 1.32.0

package/dist/esm/models/FolderActionResponse.js

@@ -0,0 +1,53 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FolderActionFromJSON, FolderActionToJSON, } from './FolderAction';
+/**
+ * Check if a given object implements the FolderActionResponse interface.
+ */
+export function instanceOfFolderActionResponse(value) {
+    if (!('folderId' in value) || value['folderId'] === undefined)
+        return false;
+    if (!('action' in value) || value['action'] === undefined)
+        return false;
+    if (!('workflowId' in value) || value['workflowId'] === undefined)
+        return false;
+    return true;
+}
+export function FolderActionResponseFromJSON(json) {
+    return FolderActionResponseFromJSONTyped(json, false);
+}
+export function FolderActionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'folderId': json['folder_id'],
+        'action': FolderActionFromJSON(json['action']),
+        'workflowId': json['workflow_id'],
+    };
+}
+export function FolderActionResponseToJSON(json) {
+    return FolderActionResponseToJSONTyped(json, false);
+}
+export function FolderActionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'folder_id': value['folderId'],
+        'action': FolderActionToJSON(value['action']),
+        'workflow_id': value['workflowId'],
+    };
+}
+export const FolderActionResponsePropertyValidationAttributesMap = {};

package/dist/esm/models/SearchType.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Search type for chunk search.
+ * @export
+ */
+export declare const SearchType: {
+    readonly DenseOnly: "dense_only";
+    readonly FullText: "full_text";
+};
+export type SearchType = typeof SearchType[keyof typeof SearchType];
+export declare function instanceOfSearchType(value: any): boolean;
+export declare function SearchTypeFromJSON(json: any): SearchType;
+export declare function SearchTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchType;
+export declare function SearchTypeToJSON(value?: SearchType | null): any;
+export declare function SearchTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): SearchType;

package/dist/esm/models/SearchType.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Search type for chunk search.
+ * @export
+ */
+export const SearchType = {
+    DenseOnly: 'dense_only',
+    FullText: 'full_text'
+};
+export function instanceOfSearchType(value) {
+    for (const key in SearchType) {
+        if (Object.prototype.hasOwnProperty.call(SearchType, key)) {
+            if (SearchType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function SearchTypeFromJSON(json) {
+    return SearchTypeFromJSONTyped(json, false);
+}
+export function SearchTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function SearchTypeToJSON(value) {
+    return value;
+}
+export function SearchTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/esm/models/index.d.ts

@@ -28,7 +28,8 @@ export * from './DocumentVersionMetadataUpdate';
 export * from './DocumentVersionResponse';
 export * from './EmailSentResponse';
 export * from './EmailVerificationRequest';
-export * from './EmbeddingModel';
+export * from './FolderAction';
+export * from './FolderActionResponse';
 export * from './FolderResponse';
 export * from './FolderResponseOrDocumentResponse';
 export * from './HTTPValidationError';
@@ -73,6 +74,7 @@ export * from './PolygonReference';
 export * from './RootResponse';
 export * from './SSOInitiateResponse';
 export * from './ScoredChunkResponse';
+export * from './SearchType';
 export * from './SectionContentItem';
 export * from './SectionContentItemOrChunkContentItem';
 export * from './SectionResponse';

package/dist/esm/models/index.js

@@ -30,7 +30,8 @@ export * from './DocumentVersionMetadataUpdate';
 export * from './DocumentVersionResponse';
 export * from './EmailSentResponse';
 export * from './EmailVerificationRequest';
-export * from './EmbeddingModel';
+export * from './FolderAction';
+export * from './FolderActionResponse';
 export * from './FolderResponse';
 export * from './FolderResponseOrDocumentResponse';
 export * from './HTTPValidationError';
@@ -75,6 +76,7 @@ export * from './PolygonReference';
 export * from './RootResponse';
 export * from './SSOInitiateResponse';
 export * from './ScoredChunkResponse';
+export * from './SearchType';
 export * from './SectionContentItem';
 export * from './SectionContentItemOrChunkContentItem';
 export * from './SectionResponse';

package/dist/models/ChunkSearchRequest.d.ts

@@ -9,10 +9,10 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { EmbeddingModel } from './EmbeddingModel';
 import type { ChunkType } from './ChunkType';
+import type { SearchType } from './SearchType';
 /**
- * Request body for semantic chunk search.
+ * Request body for chunk search (dense vector or full-text BM25).
  * @export
  * @interface ChunkSearchRequest
  */
@@ -25,10 +25,10 @@ export interface ChunkSearchRequest {
     query: string;
     /**
      *
-     * @type {EmbeddingModel}
+     * @type {SearchType}
      * @memberof ChunkSearchRequest
      */
-    model?: EmbeddingModel;
+    searchType?: SearchType;
     /**
      * Path part IDs to search within (non-CHUNK types). Defaults to tenant's /shared.
      * @type {Array<string>}

package/dist/models/ChunkSearchRequest.js

@@ -19,8 +19,8 @@ exports.ChunkSearchRequestFromJSON = ChunkSearchRequestFromJSON;
 exports.ChunkSearchRequestFromJSONTyped = ChunkSearchRequestFromJSONTyped;
 exports.ChunkSearchRequestToJSON = ChunkSearchRequestToJSON;
 exports.ChunkSearchRequestToJSONTyped = ChunkSearchRequestToJSONTyped;
-const EmbeddingModel_1 = require("./EmbeddingModel");
 const ChunkType_1 = require("./ChunkType");
+const SearchType_1 = require("./SearchType");
 /**
  * Check if a given object implements the ChunkSearchRequest interface.
  */
@@ -38,7 +38,7 @@ function ChunkSearchRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'query': json['query'],
-        'model': json['model'] == null ? undefined : (0, EmbeddingModel_1.EmbeddingModelFromJSON)(json['model']),
+        'searchType': json['search_type'] == null ? undefined : (0, SearchType_1.SearchTypeFromJSON)(json['search_type']),
         'parentPathIds': json['parent_path_ids'] == null ? undefined : json['parent_path_ids'],
         'tagIds': json['tag_ids'] == null ? undefined : json['tag_ids'],
         'chunkTypes': json['chunk_types'] == null ? undefined : (json['chunk_types'].map(ChunkType_1.ChunkTypeFromJSON)),
@@ -57,7 +57,7 @@ function ChunkSearchRequestToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         'query': value['query'],
-        'model': (0, EmbeddingModel_1.EmbeddingModelToJSON)(value['model']),
+        'search_type': (0, SearchType_1.SearchTypeToJSON)(value['searchType']),
         'parent_path_ids': value['parentPathIds'],
         'tag_ids': value['tagIds'],
         'chunk_types': value['chunkTypes'] == null ? undefined : (value['chunkTypes'].map(ChunkType_1.ChunkTypeToJSON)),

package/dist/models/FolderAction.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Supported folder actions.
+ * @export
+ */
+export declare const FolderAction: {
+    readonly Reembed: "reembed";
+};
+export type FolderAction = typeof FolderAction[keyof typeof FolderAction];
+export declare function instanceOfFolderAction(value: any): boolean;
+export declare function FolderActionFromJSON(json: any): FolderAction;
+export declare function FolderActionFromJSONTyped(json: any, ignoreDiscriminator: boolean): FolderAction;
+export declare function FolderActionToJSON(value?: FolderAction | null): any;
+export declare function FolderActionToJSONTyped(value: any, ignoreDiscriminator: boolean): FolderAction;

package/dist/models/FolderAction.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FolderAction = void 0;
+exports.instanceOfFolderAction = instanceOfFolderAction;
+exports.FolderActionFromJSON = FolderActionFromJSON;
+exports.FolderActionFromJSONTyped = FolderActionFromJSONTyped;
+exports.FolderActionToJSON = FolderActionToJSON;
+exports.FolderActionToJSONTyped = FolderActionToJSONTyped;
+/**
+ * Supported folder actions.
+ * @export
+ */
+exports.FolderAction = {
+    Reembed: 'reembed'
+};
+function instanceOfFolderAction(value) {
+    for (const key in exports.FolderAction) {
+        if (Object.prototype.hasOwnProperty.call(exports.FolderAction, key)) {
+            if (exports.FolderAction[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function FolderActionFromJSON(json) {
+    return FolderActionFromJSONTyped(json, false);
+}
+function FolderActionFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function FolderActionToJSON(value) {
+    return value;
+}
+function FolderActionToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/FolderActionResponse.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { FolderAction } from './FolderAction';
+/**
+ * Response for folder action endpoints.
+ * @export
+ * @interface FolderActionResponse
+ */
+export interface FolderActionResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof FolderActionResponse
+     */
+    folderId: string;
+    /**
+     *
+     * @type {FolderAction}
+     * @memberof FolderActionResponse
+     */
+    action: FolderAction;
+    /**
+     *
+     * @type {string}
+     * @memberof FolderActionResponse
+     */
+    workflowId: string;
+}
+/**
+ * Check if a given object implements the FolderActionResponse interface.
+ */
+export declare function instanceOfFolderActionResponse(value: object): value is FolderActionResponse;
+export declare function FolderActionResponseFromJSON(json: any): FolderActionResponse;
+export declare function FolderActionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FolderActionResponse;
+export declare function FolderActionResponseToJSON(json: any): FolderActionResponse;
+export declare function FolderActionResponseToJSONTyped(value?: FolderActionResponse | null, ignoreDiscriminator?: boolean): any;
+export declare const FolderActionResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/models/FolderActionResponse.js

@@ -0,0 +1,61 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FolderActionResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfFolderActionResponse = instanceOfFolderActionResponse;
+exports.FolderActionResponseFromJSON = FolderActionResponseFromJSON;
+exports.FolderActionResponseFromJSONTyped = FolderActionResponseFromJSONTyped;
+exports.FolderActionResponseToJSON = FolderActionResponseToJSON;
+exports.FolderActionResponseToJSONTyped = FolderActionResponseToJSONTyped;
+const FolderAction_1 = require("./FolderAction");
+/**
+ * Check if a given object implements the FolderActionResponse interface.
+ */
+function instanceOfFolderActionResponse(value) {
+    if (!('folderId' in value) || value['folderId'] === undefined)
+        return false;
+    if (!('action' in value) || value['action'] === undefined)
+        return false;
+    if (!('workflowId' in value) || value['workflowId'] === undefined)
+        return false;
+    return true;
+}
+function FolderActionResponseFromJSON(json) {
+    return FolderActionResponseFromJSONTyped(json, false);
+}
+function FolderActionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'folderId': json['folder_id'],
+        'action': (0, FolderAction_1.FolderActionFromJSON)(json['action']),
+        'workflowId': json['workflow_id'],
+    };
+}
+function FolderActionResponseToJSON(json) {
+    return FolderActionResponseToJSONTyped(json, false);
+}
+function FolderActionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'folder_id': value['folderId'],
+        'action': (0, FolderAction_1.FolderActionToJSON)(value['action']),
+        'workflow_id': value['workflowId'],
+    };
+}
+exports.FolderActionResponsePropertyValidationAttributesMap = {};

package/dist/models/SearchType.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Search type for chunk search.
+ * @export
+ */
+export declare const SearchType: {
+    readonly DenseOnly: "dense_only";
+    readonly FullText: "full_text";
+};
+export type SearchType = typeof SearchType[keyof typeof SearchType];
+export declare function instanceOfSearchType(value: any): boolean;
+export declare function SearchTypeFromJSON(json: any): SearchType;
+export declare function SearchTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchType;
+export declare function SearchTypeToJSON(value?: SearchType | null): any;
+export declare function SearchTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): SearchType;

package/dist/models/SearchType.js

@@ -0,0 +1,51 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchType = void 0;
+exports.instanceOfSearchType = instanceOfSearchType;
+exports.SearchTypeFromJSON = SearchTypeFromJSON;
+exports.SearchTypeFromJSONTyped = SearchTypeFromJSONTyped;
+exports.SearchTypeToJSON = SearchTypeToJSON;
+exports.SearchTypeToJSONTyped = SearchTypeToJSONTyped;
+/**
+ * Search type for chunk search.
+ * @export
+ */
+exports.SearchType = {
+    DenseOnly: 'dense_only',
+    FullText: 'full_text'
+};
+function instanceOfSearchType(value) {
+    for (const key in exports.SearchType) {
+        if (Object.prototype.hasOwnProperty.call(exports.SearchType, key)) {
+            if (exports.SearchType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+function SearchTypeFromJSON(json) {
+    return SearchTypeFromJSONTyped(json, false);
+}
+function SearchTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+function SearchTypeToJSON(value) {
+    return value;
+}
+function SearchTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/models/index.d.ts

@@ -28,7 +28,8 @@ export * from './DocumentVersionMetadataUpdate';
 export * from './DocumentVersionResponse';
 export * from './EmailSentResponse';
 export * from './EmailVerificationRequest';
-export * from './EmbeddingModel';
+export * from './FolderAction';
+export * from './FolderActionResponse';
 export * from './FolderResponse';
 export * from './FolderResponseOrDocumentResponse';
 export * from './HTTPValidationError';
@@ -73,6 +74,7 @@ export * from './PolygonReference';
 export * from './RootResponse';
 export * from './SSOInitiateResponse';
 export * from './ScoredChunkResponse';
+export * from './SearchType';
 export * from './SectionContentItem';
 export * from './SectionContentItemOrChunkContentItem';
 export * from './SectionResponse';

package/dist/models/index.js

@@ -46,7 +46,8 @@ __exportStar(require("./DocumentVersionMetadataUpdate"), exports);
 __exportStar(require("./DocumentVersionResponse"), exports);
 __exportStar(require("./EmailSentResponse"), exports);
 __exportStar(require("./EmailVerificationRequest"), exports);
-__exportStar(require("./EmbeddingModel"), exports);
+__exportStar(require("./FolderAction"), exports);
+__exportStar(require("./FolderActionResponse"), exports);
 __exportStar(require("./FolderResponse"), exports);
 __exportStar(require("./FolderResponseOrDocumentResponse"), exports);
 __exportStar(require("./HTTPValidationError"), exports);
@@ -91,6 +92,7 @@ __exportStar(require("./PolygonReference"), exports);
 __exportStar(require("./RootResponse"), exports);
 __exportStar(require("./SSOInitiateResponse"), exports);
 __exportStar(require("./ScoredChunkResponse"), exports);
+__exportStar(require("./SearchType"), exports);
 __exportStar(require("./SectionContentItem"), exports);
 __exportStar(require("./SectionContentItemOrChunkContentItem"), exports);
 __exportStar(require("./SectionResponse"), exports);

package/docs/ChunkSearchRequest.md

@@ -1,14 +1,14 @@
 
 # ChunkSearchRequest
 
-Request body for semantic chunk search.
+Request body for chunk search (dense vector or full-text BM25).
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `query` | string
-`model` | [EmbeddingModel](EmbeddingModel.md)
+`searchType` | [SearchType](SearchType.md)
 `parentPathIds` | Array<string>
 `tagIds` | Array<string>
 `chunkTypes` | [Array<ChunkType>](ChunkType.md)
@@ -25,7 +25,7 @@ import type { ChunkSearchRequest } from '@knowledge-stack/ksapi'
 // TODO: Update the object below with actual values
 const example = {
   "query": null,
-  "model": null,
+  "searchType": null,
   "parentPathIds": null,
   "tagIds": null,
   "chunkTypes": null,

package/docs/ChunksApi.md

@@ -376,7 +376,7 @@ No authorization required
 
 Search Chunks Handler
 
-Semantic search over chunks using Qdrant vector similarity.  Combines vector similarity with path-based authorization and optional metadata filters. Uses Qdrant for vector search and hydrates results from Postgres.
+Search over chunks using dense vector similarity or BM25 full-text.  Combines vector/keyword search with path-based authorization and optional metadata filters. Uses Qdrant for search and hydrates results from Postgres.
 
 ### Example
 

package/docs/{EmbeddingModel.md → FolderAction.md}

@@ -1,7 +1,7 @@
 
-# EmbeddingModel
+# FolderAction
 
-Supported embedding models.
+Supported folder actions.
 
 ## Properties
 
@@ -11,11 +11,11 @@ Name | Type
 ## Example
 
 ```typescript
-import type { EmbeddingModel } from '@knowledge-stack/ksapi'
+import type { FolderAction } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
-} satisfies EmbeddingModel
+} satisfies FolderAction
 
 console.log(example)
 
@@ -24,7 +24,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as EmbeddingModel
+const exampleParsed = JSON.parse(exampleJSON) as FolderAction
 console.log(exampleParsed)
 ```
 

package/docs/FolderActionResponse.md

@@ -0,0 +1,39 @@
+
+# FolderActionResponse
+
+Response for folder action endpoints.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`folderId` | string
+`action` | [FolderAction](FolderAction.md)
+`workflowId` | string
+
+## Example
+
+```typescript
+import type { FolderActionResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "folderId": null,
+  "action": null,
+  "workflowId": null,
+} satisfies FolderActionResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FolderActionResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+