@knowledge-stack/ksapi 1.66.2 → 1.67.0

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

@@ -0,0 +1,36 @@
+/**
+ * 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 declare const ReferenceType: {
+    readonly Folder: "FOLDER";
+    readonly Document: "DOCUMENT";
+    readonly DocumentVersion: "DOCUMENT_VERSION";
+    readonly Section: "SECTION";
+    readonly Chunk: "CHUNK";
+    readonly Thread: "THREAD";
+    readonly ThreadMessage: "THREAD_MESSAGE";
+    readonly WorkflowDefinition: "WORKFLOW_DEFINITION";
+    readonly WorkflowRun: "WORKFLOW_RUN";
+    readonly Image: "image";
+    readonly Memory: "memory";
+    readonly Tag: "tag";
+    readonly User: "user";
+};
+export type ReferenceType = typeof ReferenceType[keyof typeof ReferenceType];
+export declare function instanceOfReferenceType(value: any): boolean;
+export declare function ReferenceTypeFromJSON(json: any): ReferenceType;
+export declare function ReferenceTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReferenceType;
+export declare function ReferenceTypeToJSON(value?: ReferenceType | null): any;
+export declare function ReferenceTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): ReferenceType;

package/dist/esm/models/ReferenceType.js

@@ -0,0 +1,54 @@
+/* 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 ReferenceType = {
+    Folder: 'FOLDER',
+    Document: 'DOCUMENT',
+    DocumentVersion: 'DOCUMENT_VERSION',
+    Section: 'SECTION',
+    Chunk: 'CHUNK',
+    Thread: 'THREAD',
+    ThreadMessage: 'THREAD_MESSAGE',
+    WorkflowDefinition: 'WORKFLOW_DEFINITION',
+    WorkflowRun: 'WORKFLOW_RUN',
+    Image: 'image',
+    Memory: 'memory',
+    Tag: 'tag',
+    User: 'user'
+};
+export function instanceOfReferenceType(value) {
+    for (const key in ReferenceType) {
+        if (Object.prototype.hasOwnProperty.call(ReferenceType, key)) {
+            if (ReferenceType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function ReferenceTypeFromJSON(json) {
+    return ReferenceTypeFromJSONTyped(json, false);
+}
+export function ReferenceTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function ReferenceTypeToJSON(value) {
+    return value;
+}
+export function ReferenceTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,70 @@
+/**
+ * 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 { ReferenceType } from './ReferenceType';
+/**
+ * A parsed reference enriched with display name and path from the database.
+ *
+ * Uses ``extra="ignore"`` (not ``"forbid"``) because SDK dicts may contain
+ * fields not yet modelled here.  Adding ``"forbid"`` would cause runtime
+ * deserialization failures whenever the SDK adds a new field.
+ * @export
+ * @interface ResolvedReferenceInput
+ */
+export interface ResolvedReferenceInput {
+    /**
+     *
+     * @type {ReferenceType}
+     * @memberof ResolvedReferenceInput
+     */
+    refType: ReferenceType;
+    /**
+     *
+     * @type {string}
+     * @memberof ResolvedReferenceInput
+     */
+    entityId: string;
+    /**
+     * Human-readable name for the entity
+     * @type {string}
+     * @memberof ResolvedReferenceInput
+     */
+    displayName: string;
+    /**
+     * Full materialized path (None for entities without path parts, e.g. tags, users)
+     * @type {string}
+     * @memberof ResolvedReferenceInput
+     */
+    materializedPath?: string | null;
+}
+export declare const ResolvedReferenceInputPropertyValidationAttributesMap: {
+    [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 ResolvedReferenceInput interface.
+ */
+export declare function instanceOfResolvedReferenceInput(value: object): value is ResolvedReferenceInput;
+export declare function ResolvedReferenceInputFromJSON(json: any): ResolvedReferenceInput;
+export declare function ResolvedReferenceInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResolvedReferenceInput;
+export declare function ResolvedReferenceInputToJSON(json: any): ResolvedReferenceInput;
+export declare function ResolvedReferenceInputToJSONTyped(value?: ResolvedReferenceInput | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ResolvedReferenceInput.js

@@ -0,0 +1,55 @@
+/* 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 { ReferenceTypeFromJSON, ReferenceTypeToJSON, } from './ReferenceType';
+export const ResolvedReferenceInputPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ResolvedReferenceInput interface.
+ */
+export function instanceOfResolvedReferenceInput(value) {
+    if (!('refType' in value) || value['refType'] === undefined)
+        return false;
+    if (!('entityId' in value) || value['entityId'] === undefined)
+        return false;
+    if (!('displayName' in value) || value['displayName'] === undefined)
+        return false;
+    return true;
+}
+export function ResolvedReferenceInputFromJSON(json) {
+    return ResolvedReferenceInputFromJSONTyped(json, false);
+}
+export function ResolvedReferenceInputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'refType': ReferenceTypeFromJSON(json['ref_type']),
+        'entityId': json['entity_id'],
+        'displayName': json['display_name'],
+        'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
+    };
+}
+export function ResolvedReferenceInputToJSON(json) {
+    return ResolvedReferenceInputToJSONTyped(json, false);
+}
+export function ResolvedReferenceInputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ref_type': ReferenceTypeToJSON(value['refType']),
+        'entity_id': value['entityId'],
+        'display_name': value['displayName'],
+        'materialized_path': value['materializedPath'],
+    };
+}

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

@@ -0,0 +1,69 @@
+/**
+ * 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.
+ */
+/**
+ * A parsed reference enriched with display name and path from the database.
+ *
+ * Uses ``extra="ignore"`` (not ``"forbid"``) because SDK dicts may contain
+ * fields not yet modelled here.  Adding ``"forbid"`` would cause runtime
+ * deserialization failures whenever the SDK adds a new field.
+ * @export
+ * @interface ResolvedReferenceOutput
+ */
+export interface ResolvedReferenceOutput {
+    /**
+     *
+     * @type {string}
+     * @memberof ResolvedReferenceOutput
+     */
+    refType: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ResolvedReferenceOutput
+     */
+    entityId: string;
+    /**
+     * Human-readable name for the entity
+     * @type {string}
+     * @memberof ResolvedReferenceOutput
+     */
+    displayName: string;
+    /**
+     * Full materialized path (None for entities without path parts, e.g. tags, users)
+     * @type {string}
+     * @memberof ResolvedReferenceOutput
+     */
+    materializedPath?: string | null;
+}
+export declare const ResolvedReferenceOutputPropertyValidationAttributesMap: {
+    [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 ResolvedReferenceOutput interface.
+ */
+export declare function instanceOfResolvedReferenceOutput(value: object): value is ResolvedReferenceOutput;
+export declare function ResolvedReferenceOutputFromJSON(json: any): ResolvedReferenceOutput;
+export declare function ResolvedReferenceOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResolvedReferenceOutput;
+export declare function ResolvedReferenceOutputToJSON(json: any): ResolvedReferenceOutput;
+export declare function ResolvedReferenceOutputToJSONTyped(value?: ResolvedReferenceOutput | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ResolvedReferenceOutput.js

@@ -0,0 +1,54 @@
+/* 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 ResolvedReferenceOutputPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the ResolvedReferenceOutput interface.
+ */
+export function instanceOfResolvedReferenceOutput(value) {
+    if (!('refType' in value) || value['refType'] === undefined)
+        return false;
+    if (!('entityId' in value) || value['entityId'] === undefined)
+        return false;
+    if (!('displayName' in value) || value['displayName'] === undefined)
+        return false;
+    return true;
+}
+export function ResolvedReferenceOutputFromJSON(json) {
+    return ResolvedReferenceOutputFromJSONTyped(json, false);
+}
+export function ResolvedReferenceOutputFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'refType': json['ref_type'],
+        'entityId': json['entity_id'],
+        'displayName': json['display_name'],
+        'materializedPath': json['materialized_path'] == null ? undefined : json['materialized_path'],
+    };
+}
+export function ResolvedReferenceOutputToJSON(json) {
+    return ResolvedReferenceOutputToJSONTyped(json, false);
+}
+export function ResolvedReferenceOutputToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ref_type': value['refType'],
+        'entity_id': value['entityId'],
+        'display_name': value['displayName'],
+        'materialized_path': value['materializedPath'],
+    };
+}

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

@@ -0,0 +1,53 @@
+/**
+ * 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 RootResponse
+ */
+export interface RootResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof RootResponse
+     */
+    service?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RootResponse
+     */
+    docs?: string;
+}
+export declare const RootResponsePropertyValidationAttributesMap: {
+    [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 RootResponse interface.
+ */
+export declare function instanceOfRootResponse(value: object): value is RootResponse;
+export declare function RootResponseFromJSON(json: any): RootResponse;
+export declare function RootResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RootResponse;
+export declare function RootResponseToJSON(json: any): RootResponse;
+export declare function RootResponseToJSONTyped(value?: RootResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/RootResponse.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.
+ */
+export const RootResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the RootResponse interface.
+ */
+export function instanceOfRootResponse(value) {
+    return true;
+}
+export function RootResponseFromJSON(json) {
+    return RootResponseFromJSONTyped(json, false);
+}
+export function RootResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'service': json['service'] == null ? undefined : json['service'],
+        'docs': json['docs'] == null ? undefined : json['docs'],
+    };
+}
+export function RootResponseToJSON(json) {
+    return RootResponseToJSONTyped(json, false);
+}
+export function RootResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'service': value['service'],
+        'docs': value['docs'],
+    };
+}

package/dist/esm/models/SSOInitiateResponse.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 SSOInitiateResponse
+ */
+export interface SSOInitiateResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof SSOInitiateResponse
+     */
+    redirectUrl: string;
+}
+export declare const SSOInitiateResponsePropertyValidationAttributesMap: {
+    [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 SSOInitiateResponse interface.
+ */
+export declare function instanceOfSSOInitiateResponse(value: object): value is SSOInitiateResponse;
+export declare function SSOInitiateResponseFromJSON(json: any): SSOInitiateResponse;
+export declare function SSOInitiateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SSOInitiateResponse;
+export declare function SSOInitiateResponseToJSON(json: any): SSOInitiateResponse;
+export declare function SSOInitiateResponseToJSONTyped(value?: SSOInitiateResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/SSOInitiateResponse.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.
+ */
+export const SSOInitiateResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the SSOInitiateResponse interface.
+ */
+export function instanceOfSSOInitiateResponse(value) {
+    if (!('redirectUrl' in value) || value['redirectUrl'] === undefined)
+        return false;
+    return true;
+}
+export function SSOInitiateResponseFromJSON(json) {
+    return SSOInitiateResponseFromJSONTyped(json, false);
+}
+export function SSOInitiateResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'redirectUrl': json['redirect_url'],
+    };
+}
+export function SSOInitiateResponseToJSON(json) {
+    return SSOInitiateResponseToJSONTyped(json, false);
+}
+export function SSOInitiateResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'redirect_url': value['redirectUrl'],
+    };
+}

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

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