@knowledge-stack/ksapi 1.62.2 → 1.64.0

package/src/models/PaginatedResponseWorkflowRunResponse.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 { WorkflowRunResponse } from './WorkflowRunResponse';
+import {
+    WorkflowRunResponseFromJSON,
+    WorkflowRunResponseFromJSONTyped,
+    WorkflowRunResponseToJSON,
+    WorkflowRunResponseToJSONTyped,
+} from './WorkflowRunResponse';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedResponseWorkflowRunResponse
+ */
+export interface PaginatedResponseWorkflowRunResponse {
+    /**
+     * List of items
+     * @type {Array<WorkflowRunResponse>}
+     * @memberof PaginatedResponseWorkflowRunResponse
+     */
+    items: Array<WorkflowRunResponse>;
+    /**
+     * Total number of items
+     * @type {number}
+     * @memberof PaginatedResponseWorkflowRunResponse
+     */
+    total: number;
+    /**
+     * Number of items per page
+     * @type {number}
+     * @memberof PaginatedResponseWorkflowRunResponse
+     */
+    limit: number;
+    /**
+     * Number of items to skip
+     * @type {number}
+     * @memberof PaginatedResponseWorkflowRunResponse
+     */
+    offset: number;
+}
+
+/**
+ * Check if a given object implements the PaginatedResponseWorkflowRunResponse interface.
+ */
+export function instanceOfPaginatedResponseWorkflowRunResponse(value: object): value is PaginatedResponseWorkflowRunResponse {
+    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 PaginatedResponseWorkflowRunResponseFromJSON(json: any): PaginatedResponseWorkflowRunResponse {
+    return PaginatedResponseWorkflowRunResponseFromJSONTyped(json, false);
+}
+
+export function PaginatedResponseWorkflowRunResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedResponseWorkflowRunResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(WorkflowRunResponseFromJSON)),
+        'total': json['total'],
+        'limit': json['limit'],
+        'offset': json['offset'],
+    };
+}
+
+export function PaginatedResponseWorkflowRunResponseToJSON(json: any): PaginatedResponseWorkflowRunResponse {
+    return PaginatedResponseWorkflowRunResponseToJSONTyped(json, false);
+}
+
+export function PaginatedResponseWorkflowRunResponseToJSONTyped(value?: PaginatedResponseWorkflowRunResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(WorkflowRunResponseToJSON)),
+        'total': value['total'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+    };
+}
+
+export const PaginatedResponseWorkflowRunResponsePropertyValidationAttributesMap: {
+    [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/PartType.ts

@@ -24,7 +24,9 @@ export const PartType = {
     Section: 'SECTION',
     Chunk: 'CHUNK',
     Thread: 'THREAD',
-    ThreadMessage: 'THREAD_MESSAGE'
+    ThreadMessage: 'THREAD_MESSAGE',
+    WorkflowDefinition: 'WORKFLOW_DEFINITION',
+    WorkflowRun: 'WORKFLOW_RUN'
 } as const;
 export type PartType = typeof PartType[keyof typeof PartType];
 

package/src/models/ReferenceType.ts

@@ -25,6 +25,8 @@ export const ReferenceType = {
     Chunk: 'CHUNK',
     Thread: 'THREAD',
     ThreadMessage: 'THREAD_MESSAGE',
+    WorkflowDefinition: 'WORKFLOW_DEFINITION',
+    WorkflowRun: 'WORKFLOW_RUN',
     Image: 'image',
     Memory: 'memory',
     Tag: 'tag',

package/src/models/SelfHostedRunnerConfig.ts

@@ -0,0 +1,96 @@
+/* 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';
+/**
+ * Configuration for self-hosted workflow runner.
+ * @export
+ * @interface SelfHostedRunnerConfig
+ */
+export interface SelfHostedRunnerConfig {
+    /**
+     * 
+     * @type {string}
+     * @memberof SelfHostedRunnerConfig
+     */
+    url: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SelfHostedRunnerConfig
+     */
+    webhookSecret: string;
+}
+
+/**
+ * Check if a given object implements the SelfHostedRunnerConfig interface.
+ */
+export function instanceOfSelfHostedRunnerConfig(value: object): value is SelfHostedRunnerConfig {
+    if (!('url' in value) || value['url'] === undefined) return false;
+    if (!('webhookSecret' in value) || value['webhookSecret'] === undefined) return false;
+    return true;
+}
+
+export function SelfHostedRunnerConfigFromJSON(json: any): SelfHostedRunnerConfig {
+    return SelfHostedRunnerConfigFromJSONTyped(json, false);
+}
+
+export function SelfHostedRunnerConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): SelfHostedRunnerConfig {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'url': json['url'],
+        'webhookSecret': json['webhook_secret'],
+    };
+}
+
+export function SelfHostedRunnerConfigToJSON(json: any): SelfHostedRunnerConfig {
+    return SelfHostedRunnerConfigToJSONTyped(json, false);
+}
+
+export function SelfHostedRunnerConfigToJSONTyped(value?: SelfHostedRunnerConfig | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'url': value['url'],
+        'webhook_secret': value['webhookSecret'],
+    };
+}
+
+export const SelfHostedRunnerConfigPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    url: {
+        maxLength: 2083,
+        minLength: 1,
+    },
+}
+

package/src/models/SelfHostedRunnerConfigResponse.ts

@@ -0,0 +1,87 @@
+/* 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';
+/**
+ * Response-safe version of runner config — excludes webhook_secret.
+ * @export
+ * @interface SelfHostedRunnerConfigResponse
+ */
+export interface SelfHostedRunnerConfigResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof SelfHostedRunnerConfigResponse
+     */
+    url: string;
+}
+
+/**
+ * Check if a given object implements the SelfHostedRunnerConfigResponse interface.
+ */
+export function instanceOfSelfHostedRunnerConfigResponse(value: object): value is SelfHostedRunnerConfigResponse {
+    if (!('url' in value) || value['url'] === undefined) return false;
+    return true;
+}
+
+export function SelfHostedRunnerConfigResponseFromJSON(json: any): SelfHostedRunnerConfigResponse {
+    return SelfHostedRunnerConfigResponseFromJSONTyped(json, false);
+}
+
+export function SelfHostedRunnerConfigResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SelfHostedRunnerConfigResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'url': json['url'],
+    };
+}
+
+export function SelfHostedRunnerConfigResponseToJSON(json: any): SelfHostedRunnerConfigResponse {
+    return SelfHostedRunnerConfigResponseToJSONTyped(json, false);
+}
+
+export function SelfHostedRunnerConfigResponseToJSONTyped(value?: SelfHostedRunnerConfigResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'url': value['url'],
+    };
+}
+
+export const SelfHostedRunnerConfigResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    url: {
+        maxLength: 2083,
+        minLength: 1,
+    },
+}
+

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/UpdateWorkflowDefinitionRequest.ts

@@ -0,0 +1,200 @@
+/* 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 { SelfHostedRunnerConfig } from './SelfHostedRunnerConfig';
+import {
+    SelfHostedRunnerConfigFromJSON,
+    SelfHostedRunnerConfigFromJSONTyped,
+    SelfHostedRunnerConfigToJSON,
+    SelfHostedRunnerConfigToJSONTyped,
+} from './SelfHostedRunnerConfig';
+import type { WorkflowRunnerType } from './WorkflowRunnerType';
+import {
+    WorkflowRunnerTypeFromJSON,
+    WorkflowRunnerTypeFromJSONTyped,
+    WorkflowRunnerTypeToJSON,
+    WorkflowRunnerTypeToJSONTyped,
+} from './WorkflowRunnerType';
+
+/**
+ * Full replacement (PUT semantics). All fields are required.
+ * @export
+ * @interface UpdateWorkflowDefinitionRequest
+ */
+export interface UpdateWorkflowDefinitionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    description?: string | null;
+    /**
+     * 
+     * @type {WorkflowRunnerType}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    runnerType: WorkflowRunnerType;
+    /**
+     * 
+     * @type {SelfHostedRunnerConfig}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    runnerConfig?: SelfHostedRunnerConfig;
+    /**
+     * 
+     * @type {number}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    maxRunDurationSeconds?: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    sourcePathPartIds: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    instructionPathPartIds: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    outputPathPartIds: Array<string>;
+    /**
+     * 
+     * @type {string}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    templatePathPartId?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof UpdateWorkflowDefinitionRequest
+     */
+    isActive?: boolean;
+}
+
+
+
+/**
+ * Check if a given object implements the UpdateWorkflowDefinitionRequest interface.
+ */
+export function instanceOfUpdateWorkflowDefinitionRequest(value: object): value is UpdateWorkflowDefinitionRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('runnerType' in value) || value['runnerType'] === undefined) return false;
+    if (!('sourcePathPartIds' in value) || value['sourcePathPartIds'] === undefined) return false;
+    if (!('instructionPathPartIds' in value) || value['instructionPathPartIds'] === undefined) return false;
+    if (!('outputPathPartIds' in value) || value['outputPathPartIds'] === undefined) return false;
+    return true;
+}
+
+export function UpdateWorkflowDefinitionRequestFromJSON(json: any): UpdateWorkflowDefinitionRequest {
+    return UpdateWorkflowDefinitionRequestFromJSONTyped(json, false);
+}
+
+export function UpdateWorkflowDefinitionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateWorkflowDefinitionRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'runnerType': WorkflowRunnerTypeFromJSON(json['runner_type']),
+        'runnerConfig': json['runner_config'] == null ? undefined : SelfHostedRunnerConfigFromJSON(json['runner_config']),
+        'maxRunDurationSeconds': json['max_run_duration_seconds'] == null ? undefined : json['max_run_duration_seconds'],
+        'sourcePathPartIds': json['source_path_part_ids'],
+        'instructionPathPartIds': json['instruction_path_part_ids'],
+        'outputPathPartIds': json['output_path_part_ids'],
+        'templatePathPartId': json['template_path_part_id'] == null ? undefined : json['template_path_part_id'],
+        'isActive': json['is_active'] == null ? undefined : json['is_active'],
+    };
+}
+
+export function UpdateWorkflowDefinitionRequestToJSON(json: any): UpdateWorkflowDefinitionRequest {
+    return UpdateWorkflowDefinitionRequestToJSONTyped(json, false);
+}
+
+export function UpdateWorkflowDefinitionRequestToJSONTyped(value?: UpdateWorkflowDefinitionRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'runner_type': WorkflowRunnerTypeToJSON(value['runnerType']),
+        'runner_config': SelfHostedRunnerConfigToJSON(value['runnerConfig']),
+        'max_run_duration_seconds': value['maxRunDurationSeconds'],
+        'source_path_part_ids': value['sourcePathPartIds'],
+        'instruction_path_part_ids': value['instructionPathPartIds'],
+        'output_path_part_ids': value['outputPathPartIds'],
+        'template_path_part_id': value['templatePathPartId'],
+        'is_active': value['isActive'],
+    };
+}
+
+export const UpdateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    name: {
+        maxLength: 255,
+    },
+    maxRunDurationSeconds: {
+        maximum: 86400,
+        exclusiveMaximum: false,
+        minimum: 60,
+        exclusiveMinimum: false,
+    },
+    sourcePathPartIds: {
+        maxItems: 20,
+        minItems: 1,
+        uniqueItems: false,
+    },
+    instructionPathPartIds: {
+        maxItems: 20,
+        minItems: 1,
+        uniqueItems: false,
+    },
+    outputPathPartIds: {
+        maxItems: 20,
+        minItems: 1,
+        uniqueItems: false,
+    },
+}
+