@knowledge-stack/ksapi 1.65.7 → 1.66.1

package/dist/src/models/ChunkNeighborsResponse.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.
+ */
+import { SectionContentItemOrChunkContentItemFromJSON, SectionContentItemOrChunkContentItemToJSON, } from './SectionContentItemOrChunkContentItem';
+export const ChunkNeighborsResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ChunkNeighborsResponse interface.
+ */
+export function instanceOfChunkNeighborsResponse(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    if (!('anchorIndex' in value) || value['anchorIndex'] === undefined)
+        return false;
+    return true;
+}
+export function ChunkNeighborsResponseFromJSON(json) {
+    return ChunkNeighborsResponseFromJSONTyped(json, false);
+}
+export function ChunkNeighborsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(SectionContentItemOrChunkContentItemFromJSON)),
+        'anchorIndex': json['anchor_index'],
+    };
+}
+export function ChunkNeighborsResponseToJSON(json) {
+    return ChunkNeighborsResponseToJSONTyped(json, false);
+}
+export function ChunkNeighborsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(SectionContentItemOrChunkContentItemToJSON)),
+        'anchor_index': value['anchorIndex'],
+    };
+}

package/dist/src/models/ChunkResponse.d.ts

@@ -0,0 +1,153 @@
+/**
+ * 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 { ChunkDocumentResponse } from './ChunkDocumentResponse';
+import type { ChunkMetadataOutput } from './ChunkMetadataOutput';
+import type { ChunkType } from './ChunkType';
+import type { ChunkDocumentVersionResponse } from './ChunkDocumentVersionResponse';
+/**
+ * Chunk response model.
+ * @export
+ * @interface ChunkResponse
+ */
+export interface ChunkResponse {
+    /**
+     * Chunk ID
+     * @type {string}
+     * @memberof ChunkResponse
+     */
+    id: string;
+    /**
+     * PathPart ID
+     * @type {string}
+     * @memberof ChunkResponse
+     */
+    pathPartId: string;
+    /**
+     * ChunkContent ID
+     * @type {string}
+     * @memberof ChunkResponse
+     */
+    contentId: string;
+    /**
+     * Chunk text content
+     * @type {string}
+     * @memberof ChunkResponse
+     */
+    content: string;
+    /**
+     *
+     * @type {ChunkType}
+     * @memberof ChunkResponse
+     */
+    chunkType: ChunkType;
+    /**
+     *
+     * @type {ChunkMetadataOutput}
+     * @memberof ChunkResponse
+     */
+    chunkMetadata: ChunkMetadataOutput;
+    /**
+     * Number of tokens in chunk content
+     * @type {number}
+     * @memberof ChunkResponse
+     */
+    numTokens?: number | null;
+    /**
+     * Parent PathPart ID
+     * @type {string}
+     * @memberof ChunkResponse
+     */
+    parentPathId: string;
+    /**
+     * Previous sibling PathPart ID
+     * @type {string}
+     * @memberof ChunkResponse
+     */
+    prevSiblingPathId?: string | null;
+    /**
+     * Next sibling PathPart ID
+     * @type {string}
+     * @memberof ChunkResponse
+     */
+    nextSiblingPathId?: string | null;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof ChunkResponse
+     */
+    materializedPath: string;
+    /**
+     * Whether this chunk is system-managed
+     * @type {boolean}
+     * @memberof ChunkResponse
+     */
+    systemManaged: boolean;
+    /**
+     * Tenant ID
+     * @type {string}
+     * @memberof ChunkResponse
+     */
+    tenantId: string;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof ChunkResponse
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof ChunkResponse
+     */
+    updatedAt: Date;
+    /**
+     * Presigned URLs to download the chunk's visual assets (6-hour validity)
+     * @type {Array<string>}
+     * @memberof ChunkResponse
+     */
+    assetS3Urls?: Array<string>;
+    /**
+     *
+     * @type {ChunkDocumentResponse}
+     * @memberof ChunkResponse
+     */
+    document?: ChunkDocumentResponse;
+    /**
+     *
+     * @type {ChunkDocumentVersionResponse}
+     * @memberof ChunkResponse
+     */
+    documentVersion?: ChunkDocumentVersionResponse;
+}
+export declare const ChunkResponsePropertyValidationAttributesMap: {
+    [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 ChunkResponse interface.
+ */
+export declare function instanceOfChunkResponse(value: object): value is ChunkResponse;
+export declare function ChunkResponseFromJSON(json: any): ChunkResponse;
+export declare function ChunkResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkResponse;
+export declare function ChunkResponseToJSON(json: any): ChunkResponse;
+export declare function ChunkResponseToJSONTyped(value?: ChunkResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/src/models/ChunkResponse.js

@@ -0,0 +1,104 @@
+/* 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 { ChunkDocumentResponseFromJSON, ChunkDocumentResponseToJSON, } from './ChunkDocumentResponse';
+import { ChunkMetadataOutputFromJSON, ChunkMetadataOutputToJSON, } from './ChunkMetadataOutput';
+import { ChunkTypeFromJSON, ChunkTypeToJSON, } from './ChunkType';
+import { ChunkDocumentVersionResponseFromJSON, ChunkDocumentVersionResponseToJSON, } from './ChunkDocumentVersionResponse';
+export const ChunkResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ChunkResponse interface.
+ */
+export function instanceOfChunkResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined)
+        return false;
+    if (!('contentId' in value) || value['contentId'] === undefined)
+        return false;
+    if (!('content' in value) || value['content'] === undefined)
+        return false;
+    if (!('chunkType' in value) || value['chunkType'] === undefined)
+        return false;
+    if (!('chunkMetadata' in value) || value['chunkMetadata'] === undefined)
+        return false;
+    if (!('parentPathId' in value) || value['parentPathId'] === undefined)
+        return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined)
+        return false;
+    if (!('systemManaged' in value) || value['systemManaged'] === undefined)
+        return false;
+    if (!('tenantId' in value) || value['tenantId'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+export function ChunkResponseFromJSON(json) {
+    return ChunkResponseFromJSONTyped(json, false);
+}
+export function ChunkResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'pathPartId': json['path_part_id'],
+        'contentId': json['content_id'],
+        'content': json['content'],
+        'chunkType': ChunkTypeFromJSON(json['chunk_type']),
+        'chunkMetadata': ChunkMetadataOutputFromJSON(json['chunk_metadata']),
+        'numTokens': json['num_tokens'] == null ? undefined : json['num_tokens'],
+        'parentPathId': json['parent_path_id'],
+        'prevSiblingPathId': json['prev_sibling_path_id'] == null ? undefined : json['prev_sibling_path_id'],
+        'nextSiblingPathId': json['next_sibling_path_id'] == null ? undefined : json['next_sibling_path_id'],
+        'materializedPath': json['materialized_path'],
+        'systemManaged': json['system_managed'],
+        'tenantId': json['tenant_id'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+        'assetS3Urls': json['asset_s3_urls'] == null ? undefined : json['asset_s3_urls'],
+        'document': json['document'] == null ? undefined : ChunkDocumentResponseFromJSON(json['document']),
+        'documentVersion': json['document_version'] == null ? undefined : ChunkDocumentVersionResponseFromJSON(json['document_version']),
+    };
+}
+export function ChunkResponseToJSON(json) {
+    return ChunkResponseToJSONTyped(json, false);
+}
+export function ChunkResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'path_part_id': value['pathPartId'],
+        'content_id': value['contentId'],
+        'content': value['content'],
+        'chunk_type': ChunkTypeToJSON(value['chunkType']),
+        'chunk_metadata': ChunkMetadataOutputToJSON(value['chunkMetadata']),
+        'num_tokens': value['numTokens'],
+        'parent_path_id': value['parentPathId'],
+        'prev_sibling_path_id': value['prevSiblingPathId'],
+        'next_sibling_path_id': value['nextSiblingPathId'],
+        'materialized_path': value['materializedPath'],
+        'system_managed': value['systemManaged'],
+        'tenant_id': value['tenantId'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+        'asset_s3_urls': value['assetS3Urls'],
+        'document': ChunkDocumentResponseToJSON(value['document']),
+        'document_version': ChunkDocumentVersionResponseToJSON(value['documentVersion']),
+    };
+}

package/dist/src/models/ChunkSearchRequest.d.ts

@@ -0,0 +1,103 @@
+/**
+ * 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 { ChunkType } from './ChunkType';
+import type { SearchType } from './SearchType';
+/**
+ * Request body for chunk search (dense vector or full-text BM25).
+ * @export
+ * @interface ChunkSearchRequest
+ */
+export interface ChunkSearchRequest {
+    /**
+     * Search query text
+     * @type {string}
+     * @memberof ChunkSearchRequest
+     */
+    query: string;
+    /**
+     *
+     * @type {SearchType}
+     * @memberof ChunkSearchRequest
+     */
+    searchType?: SearchType;
+    /**
+     * Path part IDs to search within (non-CHUNK types). Defaults to tenant's /shared.
+     * @type {Array<string>}
+     * @memberof ChunkSearchRequest
+     */
+    parentPathIds?: Array<string> | null;
+    /**
+     * Filter by tag IDs (AND logic — chunks must have ALL specified tags)
+     * @type {Array<string>}
+     * @memberof ChunkSearchRequest
+     */
+    tagIds?: Array<string> | null;
+    /**
+     * Filter by chunk types (TEXT, TABLE, IMAGE, HTML, UNKNOWN). Only chunks matching one of the listed types are returned.
+     * @type {Array<ChunkType>}
+     * @memberof ChunkSearchRequest
+     */
+    chunkTypes?: Array<ChunkType> | null;
+    /**
+     * Only chunks ingested after this timestamp
+     * @type {Date}
+     * @memberof ChunkSearchRequest
+     */
+    ingestionTimeAfter?: Date | null;
+    /**
+     * Only return chunks from the active document version
+     * @type {boolean}
+     * @memberof ChunkSearchRequest
+     */
+    activeVersionOnly?: boolean;
+    /**
+     * Number of results (1-50)
+     * @type {number}
+     * @memberof ChunkSearchRequest
+     */
+    topK?: number;
+    /**
+     * Minimum similarity score
+     * @type {number}
+     * @memberof ChunkSearchRequest
+     */
+    scoreThreshold?: number;
+    /**
+     * Include ancestor document_id and document_version_id in each result
+     * @type {boolean}
+     * @memberof ChunkSearchRequest
+     */
+    withDocument?: boolean;
+}
+export declare const ChunkSearchRequestPropertyValidationAttributesMap: {
+    [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 ChunkSearchRequest interface.
+ */
+export declare function instanceOfChunkSearchRequest(value: object): value is ChunkSearchRequest;
+export declare function ChunkSearchRequestFromJSON(json: any): ChunkSearchRequest;
+export declare function ChunkSearchRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChunkSearchRequest;
+export declare function ChunkSearchRequestToJSON(json: any): ChunkSearchRequest;
+export declare function ChunkSearchRequestToJSONTyped(value?: ChunkSearchRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/src/models/ChunkSearchRequest.js

@@ -0,0 +1,78 @@
+/* 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 { ChunkTypeFromJSON, ChunkTypeToJSON, } from './ChunkType';
+import { SearchTypeFromJSON, SearchTypeToJSON, } from './SearchType';
+export const ChunkSearchRequestPropertyValidationAttributesMap = {
+    query: {
+        minLength: 1,
+    },
+    chunkTypes: {
+        minItems: 1,
+        uniqueItems: false,
+    },
+    topK: {
+        maximum: 50,
+        exclusiveMaximum: false,
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+};
+/**
+ * Check if a given object implements the ChunkSearchRequest interface.
+ */
+export function instanceOfChunkSearchRequest(value) {
+    if (!('query' in value) || value['query'] === undefined)
+        return false;
+    return true;
+}
+export function ChunkSearchRequestFromJSON(json) {
+    return ChunkSearchRequestFromJSONTyped(json, false);
+}
+export function ChunkSearchRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'query': json['query'],
+        'searchType': json['search_type'] == null ? undefined : 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(ChunkTypeFromJSON)),
+        'ingestionTimeAfter': json['ingestion_time_after'] == null ? undefined : (new Date(json['ingestion_time_after'])),
+        'activeVersionOnly': json['active_version_only'] == null ? undefined : json['active_version_only'],
+        'topK': json['top_k'] == null ? undefined : json['top_k'],
+        'scoreThreshold': json['score_threshold'] == null ? undefined : json['score_threshold'],
+        'withDocument': json['with_document'] == null ? undefined : json['with_document'],
+    };
+}
+export function ChunkSearchRequestToJSON(json) {
+    return ChunkSearchRequestToJSONTyped(json, false);
+}
+export function ChunkSearchRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'query': value['query'],
+        'search_type': SearchTypeToJSON(value['searchType']),
+        'parent_path_ids': value['parentPathIds'],
+        'tag_ids': value['tagIds'],
+        'chunk_types': value['chunkTypes'] == null ? undefined : (value['chunkTypes'].map(ChunkTypeToJSON)),
+        'ingestion_time_after': value['ingestionTimeAfter'] == null ? value['ingestionTimeAfter'] : value['ingestionTimeAfter'].toISOString(),
+        'active_version_only': value['activeVersionOnly'],
+        'top_k': value['topK'],
+        'score_threshold': value['scoreThreshold'],
+        'with_document': value['withDocument'],
+    };
+}

package/dist/src/models/Citation.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 Citation
+ */
+export interface Citation {
+    /**
+     *
+     * @type {string}
+     * @memberof Citation
+     */
+    chunkId: string;
+    /**
+     * The quote from the chunk
+     * @type {string}
+     * @memberof Citation
+     */
+    quote: string;
+    /**
+     * The 0-based start character of the quote in the chunk
+     * @type {number}
+     * @memberof Citation
+     */
+    startChar: number;
+    /**
+     * The length of the quote
+     * @type {number}
+     * @memberof Citation
+     */
+    length: number;
+}
+export declare const CitationPropertyValidationAttributesMap: {
+    [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 Citation interface.
+ */
+export declare function instanceOfCitation(value: object): value is Citation;
+export declare function CitationFromJSON(json: any): Citation;
+export declare function CitationFromJSONTyped(json: any, ignoreDiscriminator: boolean): Citation;
+export declare function CitationToJSON(json: any): Citation;
+export declare function CitationToJSONTyped(value?: Citation | null, ignoreDiscriminator?: boolean): any;

package/dist/src/models/Citation.js

@@ -0,0 +1,61 @@
+/* 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 CitationPropertyValidationAttributesMap = {
+    startChar: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+};
+/**
+ * Check if a given object implements the Citation interface.
+ */
+export function instanceOfCitation(value) {
+    if (!('chunkId' in value) || value['chunkId'] === undefined)
+        return false;
+    if (!('quote' in value) || value['quote'] === undefined)
+        return false;
+    if (!('startChar' in value) || value['startChar'] === undefined)
+        return false;
+    if (!('length' in value) || value['length'] === undefined)
+        return false;
+    return true;
+}
+export function CitationFromJSON(json) {
+    return CitationFromJSONTyped(json, false);
+}
+export function CitationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'chunkId': json['chunk_id'],
+        'quote': json['quote'],
+        'startChar': json['start_char'],
+        'length': json['length'],
+    };
+}
+export function CitationToJSON(json) {
+    return CitationToJSONTyped(json, false);
+}
+export function CitationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'chunk_id': value['chunkId'],
+        'quote': value['quote'],
+        'start_char': value['startChar'],
+        'length': value['length'],
+    };
+}

package/dist/src/models/ClearVersionContentsResponse.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.
+ */
+/**
+ * Response model for the clear version contents endpoint.
+ * @export
+ * @interface ClearVersionContentsResponse
+ */
+export interface ClearVersionContentsResponse {
+    /**
+     * Number of top-level children deleted
+     * @type {number}
+     * @memberof ClearVersionContentsResponse
+     */
+    deleted: number;
+}
+export declare const ClearVersionContentsResponsePropertyValidationAttributesMap: {
+    [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 ClearVersionContentsResponse interface.
+ */
+export declare function instanceOfClearVersionContentsResponse(value: object): value is ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseFromJSON(json: any): ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseToJSON(json: any): ClearVersionContentsResponse;
+export declare function ClearVersionContentsResponseToJSONTyped(value?: ClearVersionContentsResponse | null, ignoreDiscriminator?: boolean): any;