@knowledge-stack/ksapi 1.62.1 → 1.63.0

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

@@ -0,0 +1,106 @@
+/**
+ * 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 { FeedbackTargetType } from './FeedbackTargetType';
+import type { FeedbackRating } from './FeedbackRating';
+import type { FeedbackReason } from './FeedbackReason';
+/**
+ * Response schema for a single FeedbackEvent.
+ * @export
+ * @interface FeedbackEventResponse
+ */
+export interface FeedbackEventResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof FeedbackEventResponse
+     */
+    id: string;
+    /**
+     *
+     * @type {FeedbackTargetType}
+     * @memberof FeedbackEventResponse
+     */
+    targetType: FeedbackTargetType;
+    /**
+     *
+     * @type {string}
+     * @memberof FeedbackEventResponse
+     */
+    targetId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FeedbackEventResponse
+     */
+    userId: string;
+    /**
+     *
+     * @type {FeedbackRating}
+     * @memberof FeedbackEventResponse
+     */
+    rating: FeedbackRating;
+    /**
+     *
+     * @type {FeedbackReason}
+     * @memberof FeedbackEventResponse
+     */
+    reason: FeedbackReason;
+    /**
+     *
+     * @type {string}
+     * @memberof FeedbackEventResponse
+     */
+    comment: string | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof FeedbackEventResponse
+     */
+    extraMetadata: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {Date}
+     * @memberof FeedbackEventResponse
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof FeedbackEventResponse
+     */
+    updatedAt: Date;
+}
+/**
+ * Check if a given object implements the FeedbackEventResponse interface.
+ */
+export declare function instanceOfFeedbackEventResponse(value: object): value is FeedbackEventResponse;
+export declare function FeedbackEventResponseFromJSON(json: any): FeedbackEventResponse;
+export declare function FeedbackEventResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeedbackEventResponse;
+export declare function FeedbackEventResponseToJSON(json: any): FeedbackEventResponse;
+export declare function FeedbackEventResponseToJSONTyped(value?: FeedbackEventResponse | null, ignoreDiscriminator?: boolean): any;
+export declare const FeedbackEventResponsePropertyValidationAttributesMap: {
+    [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/esm/models/FeedbackEventResponse.js

@@ -0,0 +1,83 @@
+/* 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 { FeedbackTargetTypeFromJSON, FeedbackTargetTypeToJSON, } from './FeedbackTargetType';
+import { FeedbackRatingFromJSON, FeedbackRatingToJSON, } from './FeedbackRating';
+import { FeedbackReasonFromJSON, FeedbackReasonToJSON, } from './FeedbackReason';
+/**
+ * Check if a given object implements the FeedbackEventResponse interface.
+ */
+export function instanceOfFeedbackEventResponse(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('targetType' in value) || value['targetType'] === undefined)
+        return false;
+    if (!('targetId' in value) || value['targetId'] === undefined)
+        return false;
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('rating' in value) || value['rating'] === undefined)
+        return false;
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    if (!('comment' in value) || value['comment'] === undefined)
+        return false;
+    if (!('extraMetadata' in value) || value['extraMetadata'] === 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 FeedbackEventResponseFromJSON(json) {
+    return FeedbackEventResponseFromJSONTyped(json, false);
+}
+export function FeedbackEventResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'targetType': FeedbackTargetTypeFromJSON(json['target_type']),
+        'targetId': json['target_id'],
+        'userId': json['user_id'],
+        'rating': FeedbackRatingFromJSON(json['rating']),
+        'reason': FeedbackReasonFromJSON(json['reason']),
+        'comment': json['comment'],
+        'extraMetadata': json['extra_metadata'],
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+export function FeedbackEventResponseToJSON(json) {
+    return FeedbackEventResponseToJSONTyped(json, false);
+}
+export function FeedbackEventResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'target_type': FeedbackTargetTypeToJSON(value['targetType']),
+        'target_id': value['targetId'],
+        'user_id': value['userId'],
+        'rating': FeedbackRatingToJSON(value['rating']),
+        'reason': FeedbackReasonToJSON(value['reason']),
+        'comment': value['comment'],
+        'extra_metadata': value['extraMetadata'],
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}
+export const FeedbackEventResponsePropertyValidationAttributesMap = {};

package/dist/esm/models/FeedbackRating.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.
+ */
+/**
+ *
+ * @export
+ */
+export declare const FeedbackRating: {
+    readonly Up: "UP";
+    readonly Down: "DOWN";
+};
+export type FeedbackRating = typeof FeedbackRating[keyof typeof FeedbackRating];
+export declare function instanceOfFeedbackRating(value: any): boolean;
+export declare function FeedbackRatingFromJSON(json: any): FeedbackRating;
+export declare function FeedbackRatingFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeedbackRating;
+export declare function FeedbackRatingToJSON(value?: FeedbackRating | null): any;
+export declare function FeedbackRatingToJSONTyped(value: any, ignoreDiscriminator: boolean): FeedbackRating;

package/dist/esm/models/FeedbackRating.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.
+ */
+/**
+ *
+ * @export
+ */
+export const FeedbackRating = {
+    Up: 'UP',
+    Down: 'DOWN'
+};
+export function instanceOfFeedbackRating(value) {
+    for (const key in FeedbackRating) {
+        if (Object.prototype.hasOwnProperty.call(FeedbackRating, key)) {
+            if (FeedbackRating[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function FeedbackRatingFromJSON(json) {
+    return FeedbackRatingFromJSONTyped(json, false);
+}
+export function FeedbackRatingFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function FeedbackRatingToJSON(value) {
+    return value;
+}
+export function FeedbackRatingToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,34 @@
+/**
+ * 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 FeedbackReason: {
+    readonly Incorrect: "INCORRECT";
+    readonly MissingInfo: "MISSING_INFO";
+    readonly NotRelevant: "NOT_RELEVANT";
+    readonly BadCitations: "BAD_CITATIONS";
+    readonly Hallucination: "HALLUCINATION";
+    readonly OcrError: "OCR_ERROR";
+    readonly ParsingError: "PARSING_ERROR";
+    readonly StructureIssue: "STRUCTURE_ISSUE";
+    readonly TableError: "TABLE_ERROR";
+    readonly Formatting: "FORMATTING";
+    readonly Other: "OTHER";
+};
+export type FeedbackReason = typeof FeedbackReason[keyof typeof FeedbackReason];
+export declare function instanceOfFeedbackReason(value: any): boolean;
+export declare function FeedbackReasonFromJSON(json: any): FeedbackReason;
+export declare function FeedbackReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeedbackReason;
+export declare function FeedbackReasonToJSON(value?: FeedbackReason | null): any;
+export declare function FeedbackReasonToJSONTyped(value: any, ignoreDiscriminator: boolean): FeedbackReason;

package/dist/esm/models/FeedbackReason.js

@@ -0,0 +1,52 @@
+/* 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 FeedbackReason = {
+    Incorrect: 'INCORRECT',
+    MissingInfo: 'MISSING_INFO',
+    NotRelevant: 'NOT_RELEVANT',
+    BadCitations: 'BAD_CITATIONS',
+    Hallucination: 'HALLUCINATION',
+    OcrError: 'OCR_ERROR',
+    ParsingError: 'PARSING_ERROR',
+    StructureIssue: 'STRUCTURE_ISSUE',
+    TableError: 'TABLE_ERROR',
+    Formatting: 'FORMATTING',
+    Other: 'OTHER'
+};
+export function instanceOfFeedbackReason(value) {
+    for (const key in FeedbackReason) {
+        if (Object.prototype.hasOwnProperty.call(FeedbackReason, key)) {
+            if (FeedbackReason[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function FeedbackReasonFromJSON(json) {
+    return FeedbackReasonFromJSONTyped(json, false);
+}
+export function FeedbackReasonFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function FeedbackReasonToJSON(value) {
+    return value;
+}
+export function FeedbackReasonToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

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

@@ -0,0 +1,28 @@
+/**
+ * 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 FeedbackTargetType: {
+    readonly Thread: "THREAD";
+    readonly Message: "MESSAGE";
+    readonly Document: "DOCUMENT";
+    readonly DocumentVersion: "DOCUMENT_VERSION";
+    readonly Chunk: "CHUNK";
+};
+export type FeedbackTargetType = typeof FeedbackTargetType[keyof typeof FeedbackTargetType];
+export declare function instanceOfFeedbackTargetType(value: any): boolean;
+export declare function FeedbackTargetTypeFromJSON(json: any): FeedbackTargetType;
+export declare function FeedbackTargetTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeedbackTargetType;
+export declare function FeedbackTargetTypeToJSON(value?: FeedbackTargetType | null): any;
+export declare function FeedbackTargetTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): FeedbackTargetType;

package/dist/esm/models/FeedbackTargetType.js

@@ -0,0 +1,46 @@
+/* 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 FeedbackTargetType = {
+    Thread: 'THREAD',
+    Message: 'MESSAGE',
+    Document: 'DOCUMENT',
+    DocumentVersion: 'DOCUMENT_VERSION',
+    Chunk: 'CHUNK'
+};
+export function instanceOfFeedbackTargetType(value) {
+    for (const key in FeedbackTargetType) {
+        if (Object.prototype.hasOwnProperty.call(FeedbackTargetType, key)) {
+            if (FeedbackTargetType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function FeedbackTargetTypeFromJSON(json) {
+    return FeedbackTargetTypeFromJSONTyped(json, false);
+}
+export function FeedbackTargetTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function FeedbackTargetTypeToJSON(value) {
+    return value;
+}
+export function FeedbackTargetTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/esm/models/PaginatedResponseFeedbackEventResponse.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 { FeedbackEventResponse } from './FeedbackEventResponse';
+/**
+ *
+ * @export
+ * @interface PaginatedResponseFeedbackEventResponse
+ */
+export interface PaginatedResponseFeedbackEventResponse {
+    /**
+     * List of items
+     * @type {Array<FeedbackEventResponse>}
+     * @memberof PaginatedResponseFeedbackEventResponse
+     */
+    items: Array<FeedbackEventResponse>;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof PaginatedResponseFeedbackEventResponse
+     */
+    total: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof PaginatedResponseFeedbackEventResponse
+     */
+    limit: number;
+    /**
+     * Number of items to skip
+     * @type {number}
+     * @memberof PaginatedResponseFeedbackEventResponse
+     */
+    offset: number;
+}
+/**
+ * Check if a given object implements the PaginatedResponseFeedbackEventResponse interface.
+ */
+export declare function instanceOfPaginatedResponseFeedbackEventResponse(value: object): value is PaginatedResponseFeedbackEventResponse;
+export declare function PaginatedResponseFeedbackEventResponseFromJSON(json: any): PaginatedResponseFeedbackEventResponse;
+export declare function PaginatedResponseFeedbackEventResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseFeedbackEventResponse;
+export declare function PaginatedResponseFeedbackEventResponseToJSON(json: any): PaginatedResponseFeedbackEventResponse;
+export declare function PaginatedResponseFeedbackEventResponseToJSONTyped(value?: PaginatedResponseFeedbackEventResponse | null, ignoreDiscriminator?: boolean): any;
+export declare const PaginatedResponseFeedbackEventResponsePropertyValidationAttributesMap: {
+    [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/esm/models/PaginatedResponseFeedbackEventResponse.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 { FeedbackEventResponseFromJSON, FeedbackEventResponseToJSON, } from './FeedbackEventResponse';
+/**
+ * Check if a given object implements the PaginatedResponseFeedbackEventResponse interface.
+ */
+export function instanceOfPaginatedResponseFeedbackEventResponse(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 PaginatedResponseFeedbackEventResponseFromJSON(json) {
+    return PaginatedResponseFeedbackEventResponseFromJSONTyped(json, false);
+}
+export function PaginatedResponseFeedbackEventResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(FeedbackEventResponseFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+export function PaginatedResponseFeedbackEventResponseToJSON(json) {
+    return PaginatedResponseFeedbackEventResponseToJSONTyped(json, false);
+}
+export function PaginatedResponseFeedbackEventResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(FeedbackEventResponseToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}
+export const PaginatedResponseFeedbackEventResponsePropertyValidationAttributesMap = {
+    total: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    limit: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+};

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

@@ -0,0 +1,82 @@
+/**
+ * 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 { FeedbackTargetType } from './FeedbackTargetType';
+import type { FeedbackRating } from './FeedbackRating';
+import type { FeedbackReason } from './FeedbackReason';
+/**
+ * Request to create or update feedback on a knowledge entity.
+ * @export
+ * @interface SubmitFeedbackRequest
+ */
+export interface SubmitFeedbackRequest {
+    /**
+     *
+     * @type {FeedbackTargetType}
+     * @memberof SubmitFeedbackRequest
+     */
+    targetType: FeedbackTargetType;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmitFeedbackRequest
+     */
+    targetId: string;
+    /**
+     *
+     * @type {FeedbackRating}
+     * @memberof SubmitFeedbackRequest
+     */
+    rating: FeedbackRating;
+    /**
+     *
+     * @type {FeedbackReason}
+     * @memberof SubmitFeedbackRequest
+     */
+    reason?: FeedbackReason;
+    /**
+     *
+     * @type {string}
+     * @memberof SubmitFeedbackRequest
+     */
+    comment?: string | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof SubmitFeedbackRequest
+     */
+    extraMetadata?: {
+        [key: string]: any;
+    } | null;
+}
+/**
+ * Check if a given object implements the SubmitFeedbackRequest interface.
+ */
+export declare function instanceOfSubmitFeedbackRequest(value: object): value is SubmitFeedbackRequest;
+export declare function SubmitFeedbackRequestFromJSON(json: any): SubmitFeedbackRequest;
+export declare function SubmitFeedbackRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmitFeedbackRequest;
+export declare function SubmitFeedbackRequestToJSON(json: any): SubmitFeedbackRequest;
+export declare function SubmitFeedbackRequestToJSONTyped(value?: SubmitFeedbackRequest | null, ignoreDiscriminator?: boolean): any;
+export declare const SubmitFeedbackRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};