@knowledge-stack/ksapi 1.83.0 → 1.84.0

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

@@ -0,0 +1,47 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface EditMemoryChunkRequest
+ */
+export interface EditMemoryChunkRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof EditMemoryChunkRequest
+     */
+    body: string;
+}
+export declare const EditMemoryChunkRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the EditMemoryChunkRequest interface.
+ */
+export declare function instanceOfEditMemoryChunkRequest(value: object): value is EditMemoryChunkRequest;
+export declare function EditMemoryChunkRequestFromJSON(json: any): EditMemoryChunkRequest;
+export declare function EditMemoryChunkRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): EditMemoryChunkRequest;
+export declare function EditMemoryChunkRequestToJSON(json: any): EditMemoryChunkRequest;
+export declare function EditMemoryChunkRequestToJSONTyped(value?: EditMemoryChunkRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EditMemoryChunkRequest.js

@@ -0,0 +1,49 @@
+/* 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.
+ */
+export const EditMemoryChunkRequestPropertyValidationAttributesMap = {
+    body: {
+        maxLength: 16384,
+        minLength: 1,
+    },
+};
+/**
+ * Check if a given object implements the EditMemoryChunkRequest interface.
+ */
+export function instanceOfEditMemoryChunkRequest(value) {
+    if (!('body' in value) || value['body'] === undefined)
+        return false;
+    return true;
+}
+export function EditMemoryChunkRequestFromJSON(json) {
+    return EditMemoryChunkRequestFromJSONTyped(json, false);
+}
+export function EditMemoryChunkRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'body': json['body'],
+    };
+}
+export function EditMemoryChunkRequestToJSON(json) {
+    return EditMemoryChunkRequestToJSONTyped(json, false);
+}
+export function EditMemoryChunkRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'body': value['body'],
+    };
+}

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

@@ -0,0 +1,83 @@
+/**
+ * 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.
+ */
+/**
+ * One event row, anchored to a path_part subject.
+ *
+ * ``kind`` is namespaced ``domain.action`` (e.g. ``workflow.approval``,
+ * ``document.created``). ``payload`` is the domain-specific structured
+ * JSON associated with the event.
+ * @export
+ * @interface EventResponse
+ */
+export interface EventResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof EventResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EventResponse
+     */
+    subjectPathPartId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EventResponse
+     */
+    kind: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof EventResponse
+     */
+    ts: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof EventResponse
+     */
+    actorUserId: string | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof EventResponse
+     */
+    payload: {
+        [key: string]: any;
+    };
+}
+export declare const EventResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the EventResponse interface.
+ */
+export declare function instanceOfEventResponse(value: object): value is EventResponse;
+export declare function EventResponseFromJSON(json: any): EventResponse;
+export declare function EventResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EventResponse;
+export declare function EventResponseToJSON(json: any): EventResponse;
+export declare function EventResponseToJSONTyped(value?: EventResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EventResponse.js

@@ -0,0 +1,64 @@
+/* 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.
+ */
+export const EventResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the EventResponse interface.
+ */
+export function instanceOfEventResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('subjectPathPartId' in value) || value['subjectPathPartId'] === undefined)
+        return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('ts' in value) || value['ts'] === undefined)
+        return false;
+    if (!('actorUserId' in value) || value['actorUserId'] === undefined)
+        return false;
+    if (!('payload' in value) || value['payload'] === undefined)
+        return false;
+    return true;
+}
+export function EventResponseFromJSON(json) {
+    return EventResponseFromJSONTyped(json, false);
+}
+export function EventResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'subjectPathPartId': json['subject_path_part_id'],
+        'kind': json['kind'],
+        'ts': (new Date(json['ts'])),
+        'actorUserId': json['actor_user_id'],
+        'payload': json['payload'],
+    };
+}
+export function EventResponseToJSON(json) {
+    return EventResponseToJSONTyped(json, false);
+}
+export function EventResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'subject_path_part_id': value['subjectPathPartId'],
+        'kind': value['kind'],
+        'ts': value['ts'].toISOString(),
+        'actor_user_id': value['actorUserId'],
+        'payload': value['payload'],
+    };
+}

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

@@ -0,0 +1,48 @@
+/**
+ * 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 { MemoryChunkResponse } from './MemoryChunkResponse';
+/**
+ *
+ * @export
+ * @interface ListMemoryChunksResponse
+ */
+export interface ListMemoryChunksResponse {
+    /**
+     *
+     * @type {Array<MemoryChunkResponse>}
+     * @memberof ListMemoryChunksResponse
+     */
+    chunks: Array<MemoryChunkResponse>;
+}
+export declare const ListMemoryChunksResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the ListMemoryChunksResponse interface.
+ */
+export declare function instanceOfListMemoryChunksResponse(value: object): value is ListMemoryChunksResponse;
+export declare function ListMemoryChunksResponseFromJSON(json: any): ListMemoryChunksResponse;
+export declare function ListMemoryChunksResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListMemoryChunksResponse;
+export declare function ListMemoryChunksResponseToJSON(json: any): ListMemoryChunksResponse;
+export declare function ListMemoryChunksResponseToJSONTyped(value?: ListMemoryChunksResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ListMemoryChunksResponse.js

@@ -0,0 +1,45 @@
+/* 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 { MemoryChunkResponseFromJSON, MemoryChunkResponseToJSON, } from './MemoryChunkResponse';
+export const ListMemoryChunksResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ListMemoryChunksResponse interface.
+ */
+export function instanceOfListMemoryChunksResponse(value) {
+    if (!('chunks' in value) || value['chunks'] === undefined)
+        return false;
+    return true;
+}
+export function ListMemoryChunksResponseFromJSON(json) {
+    return ListMemoryChunksResponseFromJSONTyped(json, false);
+}
+export function ListMemoryChunksResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'chunks': (json['chunks'].map(MemoryChunkResponseFromJSON)),
+    };
+}
+export function ListMemoryChunksResponseToJSON(json) {
+    return ListMemoryChunksResponseToJSONTyped(json, false);
+}
+export function ListMemoryChunksResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'chunks': (value['chunks'].map(MemoryChunkResponseToJSON)),
+    };
+}

package/dist/esm/models/MemoryChunkResponse.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 { MemoryKind } from './MemoryKind';
+/**
+ * Parsed view of one fenced chunk in MEMORY.md.
+ * @export
+ * @interface MemoryChunkResponse
+ */
+export interface MemoryChunkResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof MemoryChunkResponse
+     */
+    chunkId: string;
+    /**
+     *
+     * @type {MemoryKind}
+     * @memberof MemoryChunkResponse
+     */
+    kind: MemoryKind;
+    /**
+     *
+     * @type {string}
+     * @memberof MemoryChunkResponse
+     */
+    body: string;
+}
+export declare const MemoryChunkResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the MemoryChunkResponse interface.
+ */
+export declare function instanceOfMemoryChunkResponse(value: object): value is MemoryChunkResponse;
+export declare function MemoryChunkResponseFromJSON(json: any): MemoryChunkResponse;
+export declare function MemoryChunkResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): MemoryChunkResponse;
+export declare function MemoryChunkResponseToJSON(json: any): MemoryChunkResponse;
+export declare function MemoryChunkResponseToJSONTyped(value?: MemoryChunkResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/MemoryChunkResponse.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 { MemoryKindFromJSON, MemoryKindToJSON, } from './MemoryKind';
+export const MemoryChunkResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the MemoryChunkResponse interface.
+ */
+export function instanceOfMemoryChunkResponse(value) {
+    if (!('chunkId' in value) || value['chunkId'] === undefined)
+        return false;
+    if (!('kind' in value) || value['kind'] === undefined)
+        return false;
+    if (!('body' in value) || value['body'] === undefined)
+        return false;
+    return true;
+}
+export function MemoryChunkResponseFromJSON(json) {
+    return MemoryChunkResponseFromJSONTyped(json, false);
+}
+export function MemoryChunkResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'chunkId': json['chunk_id'],
+        'kind': MemoryKindFromJSON(json['kind']),
+        'body': json['body'],
+    };
+}
+export function MemoryChunkResponseToJSON(json) {
+    return MemoryChunkResponseToJSONTyped(json, false);
+}
+export function MemoryChunkResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'chunk_id': value['chunkId'],
+        'kind': MemoryKindToJSON(value['kind']),
+        'body': value['body'],
+    };
+}

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

@@ -0,0 +1,29 @@
+/**
+ * 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.
+ */
+/**
+ * Category of a memory chunk inside a MEMORY.md document.
+ *
+ * Stored inside the chunk's HTML-comment fence as ``kind=<value>``.
+ * Not a Postgres enum — memory is file-backed, not table-backed.
+ * @export
+ */
+export declare const MemoryKind: {
+    readonly Correction: "CORRECTION";
+    readonly Preference: "PREFERENCE";
+    readonly Example: "EXAMPLE";
+};
+export type MemoryKind = typeof MemoryKind[keyof typeof MemoryKind];
+export declare function instanceOfMemoryKind(value: any): boolean;
+export declare function MemoryKindFromJSON(json: any): MemoryKind;
+export declare function MemoryKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): MemoryKind;
+export declare function MemoryKindToJSON(value?: MemoryKind | null): any;
+export declare function MemoryKindToJSONTyped(value: any, ignoreDiscriminator: boolean): MemoryKind;

package/dist/esm/models/MemoryKind.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Category of a memory chunk inside a MEMORY.md document.
+ *
+ * Stored inside the chunk's HTML-comment fence as ``kind=<value>``.
+ * Not a Postgres enum — memory is file-backed, not table-backed.
+ * @export
+ */
+export const MemoryKind = {
+    Correction: 'CORRECTION',
+    Preference: 'PREFERENCE',
+    Example: 'EXAMPLE'
+};
+export function instanceOfMemoryKind(value) {
+    for (const key in MemoryKind) {
+        if (Object.prototype.hasOwnProperty.call(MemoryKind, key)) {
+            if (MemoryKind[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function MemoryKindFromJSON(json) {
+    return MemoryKindFromJSONTyped(json, false);
+}
+export function MemoryKindFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function MemoryKindToJSON(value) {
+    return value;
+}
+export function MemoryKindToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,66 @@
+/**
+ * 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 { EventResponse } from './EventResponse';
+/**
+ *
+ * @export
+ * @interface PaginatedResponseEventResponse
+ */
+export interface PaginatedResponseEventResponse {
+    /**
+     * List of items
+     * @type {Array<EventResponse>}
+     * @memberof PaginatedResponseEventResponse
+     */
+    items: Array<EventResponse>;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof PaginatedResponseEventResponse
+     */
+    total: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof PaginatedResponseEventResponse
+     */
+    limit: number;
+    /**
+     * Number of items to skip
+     * @type {number}
+     * @memberof PaginatedResponseEventResponse
+     */
+    offset: number;
+}
+export declare const PaginatedResponseEventResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};
+/**
+ * Check if a given object implements the PaginatedResponseEventResponse interface.
+ */
+export declare function instanceOfPaginatedResponseEventResponse(value: object): value is PaginatedResponseEventResponse;
+export declare function PaginatedResponseEventResponseFromJSON(json: any): PaginatedResponseEventResponse;
+export declare function PaginatedResponseEventResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseEventResponse;
+export declare function PaginatedResponseEventResponseToJSON(json: any): PaginatedResponseEventResponse;
+export declare function PaginatedResponseEventResponseToJSONTyped(value?: PaginatedResponseEventResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PaginatedResponseEventResponse.js

@@ -0,0 +1,70 @@
+/* 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 { EventResponseFromJSON, EventResponseToJSON, } from './EventResponse';
+export const PaginatedResponseEventResponsePropertyValidationAttributesMap = {
+    total: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    limit: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+};
+/**
+ * Check if a given object implements the PaginatedResponseEventResponse interface.
+ */
+export function instanceOfPaginatedResponseEventResponse(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('limit' in value) || value['limit'] === undefined)
+        return false;
+    if (!('offset' in value) || value['offset'] === undefined)
+        return false;
+    return true;
+}
+export function PaginatedResponseEventResponseFromJSON(json) {
+    return PaginatedResponseEventResponseFromJSONTyped(json, false);
+}
+export function PaginatedResponseEventResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(EventResponseFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+export function PaginatedResponseEventResponseToJSON(json) {
+    return PaginatedResponseEventResponseToJSONTyped(json, false);
+}
+export function PaginatedResponseEventResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(EventResponseToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}

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

@@ -116,17 +116,17 @@ export interface ScoredChunkResponse {
      */
     assetS3Urls?: Array<string>;
     /**
-     *
+     * Ancestor document info (populated when with_document=true)
      * @type {ChunkDocumentResponse}
      * @memberof ScoredChunkResponse
      */
-    document?: ChunkDocumentResponse;
+    document?: ChunkDocumentResponse | null;
     /**
-     *
+     * Ancestor document version info (populated when with_document=true)
      * @type {ChunkDocumentVersionResponse}
      * @memberof ScoredChunkResponse
      */
-    documentVersion?: ChunkDocumentVersionResponse;
+    documentVersion?: ChunkDocumentVersionResponse | null;
     /**
      * Search ranking score returned by Qdrant
      * @type {number}