@knowledge-stack/ksapi 1.62.1 → 1.63.0

package/src/models/FeedbackEventResponse.ts

@@ -0,0 +1,188 @@
+/* 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 { mapValues } from '../runtime';
+import type { FeedbackTargetType } from './FeedbackTargetType';
+import {
+    FeedbackTargetTypeFromJSON,
+    FeedbackTargetTypeFromJSONTyped,
+    FeedbackTargetTypeToJSON,
+    FeedbackTargetTypeToJSONTyped,
+} from './FeedbackTargetType';
+import type { FeedbackRating } from './FeedbackRating';
+import {
+    FeedbackRatingFromJSON,
+    FeedbackRatingFromJSONTyped,
+    FeedbackRatingToJSON,
+    FeedbackRatingToJSONTyped,
+} from './FeedbackRating';
+import type { FeedbackReason } from './FeedbackReason';
+import {
+    FeedbackReasonFromJSON,
+    FeedbackReasonFromJSONTyped,
+    FeedbackReasonToJSON,
+    FeedbackReasonToJSONTyped,
+} 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 function instanceOfFeedbackEventResponse(value: object): value is FeedbackEventResponse {
+    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: any): FeedbackEventResponse {
+    return FeedbackEventResponseFromJSONTyped(json, false);
+}
+
+export function FeedbackEventResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeedbackEventResponse {
+    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: any): FeedbackEventResponse {
+    return FeedbackEventResponseToJSONTyped(json, false);
+}
+
+export function FeedbackEventResponseToJSONTyped(value?: FeedbackEventResponse | null, ignoreDiscriminator: boolean = false): any {
+    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: {
+    [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/src/models/FeedbackRating.ts

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

package/src/models/FeedbackReason.ts

@@ -0,0 +1,62 @@
+/* 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'
+} as const;
+export type FeedbackReason = typeof FeedbackReason[keyof typeof FeedbackReason];
+
+
+export function instanceOfFeedbackReason(value: any): boolean {
+    for (const key in FeedbackReason) {
+        if (Object.prototype.hasOwnProperty.call(FeedbackReason, key)) {
+            if (FeedbackReason[key as keyof typeof FeedbackReason] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function FeedbackReasonFromJSON(json: any): FeedbackReason {
+    return FeedbackReasonFromJSONTyped(json, false);
+}
+
+export function FeedbackReasonFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeedbackReason {
+    return json as FeedbackReason;
+}
+
+export function FeedbackReasonToJSON(value?: FeedbackReason | null): any {
+    return value as any;
+}
+
+export function FeedbackReasonToJSONTyped(value: any, ignoreDiscriminator: boolean): FeedbackReason {
+    return value as FeedbackReason;
+}
+

package/src/models/FeedbackTargetType.ts

@@ -0,0 +1,56 @@
+/* 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'
+} as const;
+export type FeedbackTargetType = typeof FeedbackTargetType[keyof typeof FeedbackTargetType];
+
+
+export function instanceOfFeedbackTargetType(value: any): boolean {
+    for (const key in FeedbackTargetType) {
+        if (Object.prototype.hasOwnProperty.call(FeedbackTargetType, key)) {
+            if (FeedbackTargetType[key as keyof typeof FeedbackTargetType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function FeedbackTargetTypeFromJSON(json: any): FeedbackTargetType {
+    return FeedbackTargetTypeFromJSONTyped(json, false);
+}
+
+export function FeedbackTargetTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeedbackTargetType {
+    return json as FeedbackTargetType;
+}
+
+export function FeedbackTargetTypeToJSON(value?: FeedbackTargetType | null): any {
+    return value as any;
+}
+
+export function FeedbackTargetTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): FeedbackTargetType {
+    return value as FeedbackTargetType;
+}
+

package/src/models/PaginatedResponseFeedbackEventResponse.ts

@@ -0,0 +1,130 @@
+/* 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 { mapValues } from '../runtime';
+import type { FeedbackEventResponse } from './FeedbackEventResponse';
+import {
+    FeedbackEventResponseFromJSON,
+    FeedbackEventResponseFromJSONTyped,
+    FeedbackEventResponseToJSON,
+    FeedbackEventResponseToJSONTyped,
+} 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 function instanceOfPaginatedResponseFeedbackEventResponse(value: object): value is PaginatedResponseFeedbackEventResponse {
+    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: any): PaginatedResponseFeedbackEventResponse {
+    return PaginatedResponseFeedbackEventResponseFromJSONTyped(json, false);
+}
+
+export function PaginatedResponseFeedbackEventResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseFeedbackEventResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(FeedbackEventResponseFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+
+export function PaginatedResponseFeedbackEventResponseToJSON(json: any): PaginatedResponseFeedbackEventResponse {
+    return PaginatedResponseFeedbackEventResponseToJSONTyped(json, false);
+}
+
+export function PaginatedResponseFeedbackEventResponseToJSONTyped(value?: PaginatedResponseFeedbackEventResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(FeedbackEventResponseToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}
+
+export 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
+    }
+} = {
+    total: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    limit: {
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+}
+

package/src/models/SubmitFeedbackRequest.ts

@@ -0,0 +1,152 @@
+/* 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 { mapValues } from '../runtime';
+import type { FeedbackTargetType } from './FeedbackTargetType';
+import {
+    FeedbackTargetTypeFromJSON,
+    FeedbackTargetTypeFromJSONTyped,
+    FeedbackTargetTypeToJSON,
+    FeedbackTargetTypeToJSONTyped,
+} from './FeedbackTargetType';
+import type { FeedbackRating } from './FeedbackRating';
+import {
+    FeedbackRatingFromJSON,
+    FeedbackRatingFromJSONTyped,
+    FeedbackRatingToJSON,
+    FeedbackRatingToJSONTyped,
+} from './FeedbackRating';
+import type { FeedbackReason } from './FeedbackReason';
+import {
+    FeedbackReasonFromJSON,
+    FeedbackReasonFromJSONTyped,
+    FeedbackReasonToJSON,
+    FeedbackReasonToJSONTyped,
+} 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 function instanceOfSubmitFeedbackRequest(value: object): value is SubmitFeedbackRequest {
+    if (!('targetType' in value) || value['targetType'] === undefined) return false;
+    if (!('targetId' in value) || value['targetId'] === undefined) return false;
+    if (!('rating' in value) || value['rating'] === undefined) return false;
+    return true;
+}
+
+export function SubmitFeedbackRequestFromJSON(json: any): SubmitFeedbackRequest {
+    return SubmitFeedbackRequestFromJSONTyped(json, false);
+}
+
+export function SubmitFeedbackRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubmitFeedbackRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'targetType': FeedbackTargetTypeFromJSON(json['target_type']),
+        'targetId': json['target_id'],
+        'rating': FeedbackRatingFromJSON(json['rating']),
+        'reason': json['reason'] == null ? undefined : FeedbackReasonFromJSON(json['reason']),
+        'comment': json['comment'] == null ? undefined : json['comment'],
+        'extraMetadata': json['extra_metadata'] == null ? undefined : json['extra_metadata'],
+    };
+}
+
+export function SubmitFeedbackRequestToJSON(json: any): SubmitFeedbackRequest {
+    return SubmitFeedbackRequestToJSONTyped(json, false);
+}
+
+export function SubmitFeedbackRequestToJSONTyped(value?: SubmitFeedbackRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'target_type': FeedbackTargetTypeToJSON(value['targetType']),
+        'target_id': value['targetId'],
+        'rating': FeedbackRatingToJSON(value['rating']),
+        'reason': FeedbackReasonToJSON(value['reason']),
+        'comment': value['comment'],
+        'extra_metadata': value['extraMetadata'],
+    };
+}
+
+export 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
+    }
+} = {
+    comment: {
+        maxLength: 4000,
+    },
+}
+

package/src/models/index.ts

@@ -50,6 +50,10 @@ export * from './EmailVerificationRequest';
 export * from './EnrichedCitation';
 export * from './EnrichedThreadMessageContent';
 export * from './FeaturesResponse';
+export * from './FeedbackEventResponse';
+export * from './FeedbackRating';
+export * from './FeedbackReason';
+export * from './FeedbackTargetType';
 export * from './FolderAction';
 export * from './FolderActionResponse';
 export * from './FolderResponse';
@@ -78,6 +82,7 @@ export * from './PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDi
 export * from './PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator';
 export * from './PaginatedResponseDocumentResponse';
 export * from './PaginatedResponseDocumentVersionResponse';
+export * from './PaginatedResponseFeedbackEventResponse';
 export * from './PaginatedResponseFolderResponse';
 export * from './PaginatedResponseGroupPermissionResponse';
 export * from './PaginatedResponseGroupResponse';
@@ -121,6 +126,7 @@ export * from './SignInRequest';
 export * from './StepInput';
 export * from './StepKind';
 export * from './StepOutput';
+export * from './SubmitFeedbackRequest';
 export * from './SubtreeChunkGroup';
 export * from './SubtreeChunksResponse';
 export * from './SupportedLanguage';