@knowledge-stack/ksapi 1.66.2 → 1.67.0

package/dist/esm/models/ScoredChunkResponse.js

@@ -0,0 +1,108 @@
+/* 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 ScoredChunkResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ScoredChunkResponse interface.
+ */
+export function instanceOfScoredChunkResponse(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;
+    if (!('score' in value) || value['score'] === undefined)
+        return false;
+    return true;
+}
+export function ScoredChunkResponseFromJSON(json) {
+    return ScoredChunkResponseFromJSONTyped(json, false);
+}
+export function ScoredChunkResponseFromJSONTyped(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']),
+        'score': json['score'],
+    };
+}
+export function ScoredChunkResponseToJSON(json) {
+    return ScoredChunkResponseToJSONTyped(json, false);
+}
+export function ScoredChunkResponseToJSONTyped(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']),
+        'score': value['score'],
+    };
+}

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

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+/**
+ * Sort order options for search results.
+ * @export
+ */
+export declare const SearchSortOrder: {
+    readonly Name: "NAME";
+    readonly UpdatedAt: "UPDATED_AT";
+    readonly CreatedAt: "CREATED_AT";
+};
+export type SearchSortOrder = typeof SearchSortOrder[keyof typeof SearchSortOrder];
+export declare function instanceOfSearchSortOrder(value: any): boolean;
+export declare function SearchSortOrderFromJSON(json: any): SearchSortOrder;
+export declare function SearchSortOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchSortOrder;
+export declare function SearchSortOrderToJSON(value?: SearchSortOrder | null): any;
+export declare function SearchSortOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): SearchSortOrder;

package/dist/esm/models/SearchSortOrder.js

@@ -0,0 +1,44 @@
+/* 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.
+ */
+/**
+ * Sort order options for search results.
+ * @export
+ */
+export const SearchSortOrder = {
+    Name: 'NAME',
+    UpdatedAt: 'UPDATED_AT',
+    CreatedAt: 'CREATED_AT'
+};
+export function instanceOfSearchSortOrder(value) {
+    for (const key in SearchSortOrder) {
+        if (Object.prototype.hasOwnProperty.call(SearchSortOrder, key)) {
+            if (SearchSortOrder[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function SearchSortOrderFromJSON(json) {
+    return SearchSortOrderFromJSONTyped(json, false);
+}
+export function SearchSortOrderFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function SearchSortOrderToJSON(value) {
+    return value;
+}
+export function SearchSortOrderToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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/SearchablePartType.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.
+ */
+/**
+ * Part types that can be searched.
+ * @export
+ */
+export declare const SearchablePartType: {
+    readonly Folder: "FOLDER";
+    readonly Document: "DOCUMENT";
+};
+export type SearchablePartType = typeof SearchablePartType[keyof typeof SearchablePartType];
+export declare function instanceOfSearchablePartType(value: any): boolean;
+export declare function SearchablePartTypeFromJSON(json: any): SearchablePartType;
+export declare function SearchablePartTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchablePartType;
+export declare function SearchablePartTypeToJSON(value?: SearchablePartType | null): any;
+export declare function SearchablePartTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): SearchablePartType;

package/dist/esm/models/SearchablePartType.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.
+ */
+/**
+ * Part types that can be searched.
+ * @export
+ */
+export const SearchablePartType = {
+    Folder: 'FOLDER',
+    Document: 'DOCUMENT'
+};
+export function instanceOfSearchablePartType(value) {
+    for (const key in SearchablePartType) {
+        if (Object.prototype.hasOwnProperty.call(SearchablePartType, key)) {
+            if (SearchablePartType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function SearchablePartTypeFromJSON(json) {
+    return SearchablePartTypeFromJSONTyped(json, false);
+}
+export function SearchablePartTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function SearchablePartTypeToJSON(value) {
+    return value;
+}
+export function SearchablePartTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,114 @@
+/**
+ * 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 a section item in document version contents.
+ * @export
+ * @interface SectionContentItem
+ */
+export interface SectionContentItem {
+    /**
+     * Path part type
+     * @type {SectionContentItemPartTypeEnum}
+     * @memberof SectionContentItem
+     */
+    partType: SectionContentItemPartTypeEnum;
+    /**
+     * PathPart ID
+     * @type {string}
+     * @memberof SectionContentItem
+     */
+    pathPartId: string;
+    /**
+     * PathPart name
+     * @type {string}
+     * @memberof SectionContentItem
+     */
+    name: string;
+    /**
+     * Parent PathPart ID
+     * @type {string}
+     * @memberof SectionContentItem
+     */
+    parentPathId: string;
+    /**
+     * Section ID
+     * @type {string}
+     * @memberof SectionContentItem
+     */
+    metadataObjId: string;
+    /**
+     * Depth relative to document version root
+     * @type {number}
+     * @memberof SectionContentItem
+     */
+    depth: number;
+    /**
+     * Section page number
+     * @type {number}
+     * @memberof SectionContentItem
+     */
+    pageNumber?: number | null;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof SectionContentItem
+     */
+    materializedPath: string;
+    /**
+     * Whether this item is system-managed
+     * @type {boolean}
+     * @memberof SectionContentItem
+     */
+    systemManaged: boolean;
+    /**
+     * Creation timestamp
+     * @type {Date}
+     * @memberof SectionContentItem
+     */
+    createdAt: Date;
+    /**
+     * Last update timestamp
+     * @type {Date}
+     * @memberof SectionContentItem
+     */
+    updatedAt: Date;
+}
+/**
+ * @export
+ */
+export declare const SectionContentItemPartTypeEnum: {
+    readonly Section: "SECTION";
+};
+export type SectionContentItemPartTypeEnum = typeof SectionContentItemPartTypeEnum[keyof typeof SectionContentItemPartTypeEnum];
+export declare const SectionContentItemPropertyValidationAttributesMap: {
+    [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 SectionContentItem interface.
+ */
+export declare function instanceOfSectionContentItem(value: object): value is SectionContentItem;
+export declare function SectionContentItemFromJSON(json: any): SectionContentItem;
+export declare function SectionContentItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): SectionContentItem;
+export declare function SectionContentItemToJSON(json: any): SectionContentItem;
+export declare function SectionContentItemToJSONTyped(value?: SectionContentItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SectionContentItem.js

@@ -0,0 +1,88 @@
+/* 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
+ */
+export const SectionContentItemPartTypeEnum = {
+    Section: 'SECTION'
+};
+export const SectionContentItemPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the SectionContentItem interface.
+ */
+export function instanceOfSectionContentItem(value) {
+    if (!('partType' in value) || value['partType'] === undefined)
+        return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('parentPathId' in value) || value['parentPathId'] === undefined)
+        return false;
+    if (!('metadataObjId' in value) || value['metadataObjId'] === undefined)
+        return false;
+    if (!('depth' in value) || value['depth'] === undefined)
+        return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined)
+        return false;
+    if (!('systemManaged' in value) || value['systemManaged'] === 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 SectionContentItemFromJSON(json) {
+    return SectionContentItemFromJSONTyped(json, false);
+}
+export function SectionContentItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'partType': json['part_type'],
+        'pathPartId': json['path_part_id'],
+        'name': json['name'],
+        'parentPathId': json['parent_path_id'],
+        'metadataObjId': json['metadata_obj_id'],
+        'depth': json['depth'],
+        'pageNumber': json['page_number'] == null ? undefined : json['page_number'],
+        'materializedPath': json['materialized_path'],
+        'systemManaged': json['system_managed'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+export function SectionContentItemToJSON(json) {
+    return SectionContentItemToJSONTyped(json, false);
+}
+export function SectionContentItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'part_type': value['partType'],
+        'path_part_id': value['pathPartId'],
+        'name': value['name'],
+        'parent_path_id': value['parentPathId'],
+        'metadata_obj_id': value['metadataObjId'],
+        'depth': value['depth'],
+        'page_number': value['pageNumber'],
+        'materialized_path': value['materializedPath'],
+        'system_managed': value['systemManaged'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}

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

@@ -0,0 +1,27 @@
+/**
+ * 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 { ChunkContentItem } from './ChunkContentItem';
+import type { SectionContentItem } from './SectionContentItem';
+/**
+ * @type SectionContentItemOrChunkContentItem
+ *
+ * @export
+ */
+export type SectionContentItemOrChunkContentItem = {
+    partType: 'CHUNK';
+} & ChunkContentItem | {
+    partType: 'SECTION';
+} & SectionContentItem;
+export declare function SectionContentItemOrChunkContentItemFromJSON(json: any): SectionContentItemOrChunkContentItem;
+export declare function SectionContentItemOrChunkContentItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): SectionContentItemOrChunkContentItem;
+export declare function SectionContentItemOrChunkContentItemToJSON(json: any): any;
+export declare function SectionContentItemOrChunkContentItemToJSONTyped(value?: SectionContentItemOrChunkContentItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SectionContentItemOrChunkContentItem.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.
+ */
+import { ChunkContentItemFromJSONTyped, ChunkContentItemToJSON, } from './ChunkContentItem';
+import { SectionContentItemFromJSONTyped, SectionContentItemToJSON, } from './SectionContentItem';
+export function SectionContentItemOrChunkContentItemFromJSON(json) {
+    return SectionContentItemOrChunkContentItemFromJSONTyped(json, false);
+}
+export function SectionContentItemOrChunkContentItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    switch (json['part_type']) {
+        case 'CHUNK':
+            return Object.assign({}, ChunkContentItemFromJSONTyped(json, true), { partType: 'CHUNK' });
+        case 'SECTION':
+            return Object.assign({}, SectionContentItemFromJSONTyped(json, true), { partType: 'SECTION' });
+        default:
+            return json;
+    }
+}
+export function SectionContentItemOrChunkContentItemToJSON(json) {
+    return SectionContentItemOrChunkContentItemToJSONTyped(json, false);
+}
+export function SectionContentItemOrChunkContentItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    switch (value['partType']) {
+        case 'CHUNK':
+            return Object.assign({}, ChunkContentItemToJSON(value), { partType: 'CHUNK' });
+        case 'SECTION':
+            return Object.assign({}, SectionContentItemToJSON(value), { partType: 'SECTION' });
+        default:
+            return value;
+    }
+}