@knowledge-stack/ksapi 1.120.1 → 1.121.0

package/docs/ToolStatus.md

@@ -0,0 +1,32 @@
+
+# ToolStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ToolStatus } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ToolStatus
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ToolStatus
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WorkflowRunAsset.md

@@ -0,0 +1,45 @@
+
+# WorkflowRunAsset
+
+One input or output file/reference of a run, actionable in one call.  ``id`` is the PDO id (``path_part.metadata_obj_id``); ``path_part_id`` is the underlying path part (kept for approval-state / path-part lookups). Route on ``part_type`` to pick the API that takes ``id``: ``DOCUMENT`` → download_document / bulk-download (active version); ``DOCUMENT_VERSION`` → download_document_version (a version-pinned input, e.g. a cloned run\'s inputs); ``FOLDER`` / ``DATA_SOURCE`` / ``API_CONNECTION`` → list/query via that type\'s endpoint. Output assets are always ``DOCUMENT``.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`pathPartId` | string
+`name` | string
+`partType` | [PartType](PartType.md)
+`materializedPath` | string
+`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
+
+## Example
+
+```typescript
+import type { WorkflowRunAsset } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "pathPartId": null,
+  "name": null,
+  "partType": null,
+  "materializedPath": null,
+  "approvalState": null,
+} satisfies WorkflowRunAsset
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WorkflowRunAsset
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WorkflowRunResponse.md

@@ -28,7 +28,10 @@ Name | Type
 `outputsPathPartId` | string
 `discussionsPathPartId` | string
 `inputPathPartIds` | Array<string>
-`outputsPathPartIds` | Array<string>
+`outputAssets` | [Array<WorkflowRunAsset>](WorkflowRunAsset.md)
+`inputAssets` | [Array<WorkflowRunAsset>](WorkflowRunAsset.md)
+`inputsPath` | string
+`outputsPath` | string
 `excludedCommonFiles` | [Array<ExcludedCommonFile>](ExcludedCommonFile.md)
 `runThreadId` | string
 `owner` | [UserInfo](UserInfo.md)
@@ -64,7 +67,10 @@ const example = {
   "outputsPathPartId": null,
   "discussionsPathPartId": null,
   "inputPathPartIds": null,
-  "outputsPathPartIds": null,
+  "outputAssets": null,
+  "inputAssets": null,
+  "inputsPath": null,
+  "outputsPath": null,
   "excludedCommonFiles": null,
   "runThreadId": null,
   "owner": null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.120.1",
+  "version": "1.121.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/models/CreateThreadMessageRequest.ts

@@ -20,13 +20,6 @@ import {
     MessageRoleToJSON,
     MessageRoleToJSONTyped,
 } from './MessageRole';
-import type { ThreadMessageDetailsInput } from './ThreadMessageDetailsInput';
-import {
-    ThreadMessageDetailsInputFromJSON,
-    ThreadMessageDetailsInputFromJSONTyped,
-    ThreadMessageDetailsInputToJSON,
-    ThreadMessageDetailsInputToJSONTyped,
-} from './ThreadMessageDetailsInput';
 import type { ThreadMessageContent } from './ThreadMessageContent';
 import {
     ThreadMessageContentFromJSON,
@@ -34,6 +27,13 @@ import {
     ThreadMessageContentToJSON,
     ThreadMessageContentToJSONTyped,
 } from './ThreadMessageContent';
+import type { ThreadMessageDetails } from './ThreadMessageDetails';
+import {
+    ThreadMessageDetailsFromJSON,
+    ThreadMessageDetailsFromJSONTyped,
+    ThreadMessageDetailsToJSON,
+    ThreadMessageDetailsToJSONTyped,
+} from './ThreadMessageDetails';
 
 /**
  * 
@@ -61,10 +61,10 @@ export interface CreateThreadMessageRequest {
     content: ThreadMessageContent;
     /**
      * Message details (execution steps). Omit for user messages.
-     * @type {ThreadMessageDetailsInput}
+     * @type {ThreadMessageDetails}
      * @memberof CreateThreadMessageRequest
      */
-    details?: ThreadMessageDetailsInput | null;
+    details?: ThreadMessageDetails | null;
 }
 
 
@@ -108,7 +108,7 @@ export function CreateThreadMessageRequestFromJSONTyped(json: any, ignoreDiscrim
         'messageId': json['message_id'] == null ? undefined : json['message_id'],
         'role': MessageRoleFromJSON(json['role']),
         'content': ThreadMessageContentFromJSON(json['content']),
-        'details': json['details'] == null ? undefined : ThreadMessageDetailsInputFromJSON(json['details']),
+        'details': json['details'] == null ? undefined : ThreadMessageDetailsFromJSON(json['details']),
     };
 }
 
@@ -126,7 +126,7 @@ export function CreateThreadMessageRequestToJSONTyped(value?: CreateThreadMessag
         'message_id': value['messageId'],
         'role': MessageRoleToJSON(value['role']),
         'content': ThreadMessageContentToJSON(value['content']),
-        'details': ThreadMessageDetailsInputToJSON(value['details']),
+        'details': ThreadMessageDetailsToJSON(value['details']),
     };
 }
 

package/src/models/DocEditPart.ts

@@ -0,0 +1,191 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface DocEditPart
+ */
+export interface DocEditPart {
+    /**
+     * Stable per-message part id (uuid)
+     * @type {string}
+     * @memberof DocEditPart
+     */
+    id: string;
+    /**
+     * 0-based order within the message
+     * @type {number}
+     * @memberof DocEditPart
+     */
+    seq: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DocEditPart
+     */
+    startTime: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DocEditPart
+     */
+    endTime?: Date | null;
+    /**
+     * 
+     * @type {DocEditPartKindEnum}
+     * @memberof DocEditPart
+     */
+    kind?: DocEditPartKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocEditPart
+     */
+    toolCallId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocEditPart
+     */
+    documentId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocEditPart
+     */
+    baseVersionId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocEditPart
+     */
+    newVersionId: string;
+    /**
+     * 
+     * @type {DocEditPartDocFormatEnum}
+     * @memberof DocEditPart
+     */
+    docFormat: DocEditPartDocFormatEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof DocEditPart
+     */
+    approvalId?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const DocEditPartKindEnum = {
+    DocEdit: 'doc_edit'
+} as const;
+export type DocEditPartKindEnum = typeof DocEditPartKindEnum[keyof typeof DocEditPartKindEnum];
+
+/**
+ * @export
+ */
+export const DocEditPartDocFormatEnum = {
+    Docx: 'docx',
+    Xlsx: 'xlsx'
+} as const;
+export type DocEditPartDocFormatEnum = typeof DocEditPartDocFormatEnum[keyof typeof DocEditPartDocFormatEnum];
+
+export const DocEditPartPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    seq: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the DocEditPart interface.
+ */
+export function instanceOfDocEditPart(value: object): value is DocEditPart {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('seq' in value) || value['seq'] === undefined) return false;
+    if (!('startTime' in value) || value['startTime'] === undefined) return false;
+    if (!('documentId' in value) || value['documentId'] === undefined) return false;
+    if (!('newVersionId' in value) || value['newVersionId'] === undefined) return false;
+    if (!('docFormat' in value) || value['docFormat'] === undefined) return false;
+    return true;
+}
+
+export function DocEditPartFromJSON(json: any): DocEditPart {
+    return DocEditPartFromJSONTyped(json, false);
+}
+
+export function DocEditPartFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocEditPart {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'seq': json['seq'],
+        'startTime': (new Date(json['start_time'])),
+        'endTime': json['end_time'] == null ? undefined : (new Date(json['end_time'])),
+        'kind': json['kind'] == null ? undefined : json['kind'],
+        'toolCallId': json['tool_call_id'] == null ? undefined : json['tool_call_id'],
+        'documentId': json['document_id'],
+        'baseVersionId': json['base_version_id'] == null ? undefined : json['base_version_id'],
+        'newVersionId': json['new_version_id'],
+        'docFormat': json['doc_format'],
+        'approvalId': json['approval_id'] == null ? undefined : json['approval_id'],
+    };
+}
+
+export function DocEditPartToJSON(json: any): DocEditPart {
+    return DocEditPartToJSONTyped(json, false);
+}
+
+export function DocEditPartToJSONTyped(value?: DocEditPart | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'seq': value['seq'],
+        'start_time': value['startTime'].toISOString(),
+        'end_time': value['endTime'] == null ? value['endTime'] : value['endTime'].toISOString(),
+        'kind': value['kind'],
+        'tool_call_id': value['toolCallId'],
+        'document_id': value['documentId'],
+        'base_version_id': value['baseVersionId'],
+        'new_version_id': value['newVersionId'],
+        'doc_format': value['docFormat'],
+        'approval_id': value['approvalId'],
+    };
+}
+

package/src/models/Input.ts

@@ -0,0 +1,63 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface Input
+ */
+export interface Input {
+}
+export const InputPropertyValidationAttributesMap: {
+    [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 Input interface.
+ */
+export function instanceOfInput(value: object): value is Input {
+    return true;
+}
+
+export function InputFromJSON(json: any): Input {
+    return InputFromJSONTyped(json, false);
+}
+
+export function InputFromJSONTyped(json: any, ignoreDiscriminator: boolean): Input {
+    return json;
+}
+
+export function InputToJSON(json: any): Input {
+    return InputToJSONTyped(json, false);
+}
+
+export function InputToJSONTyped(value?: Input | null, ignoreDiscriminator: boolean = false): any {
+    return value;
+}
+

package/src/models/MessageUsage.ts

@@ -0,0 +1,100 @@
+/* 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';
+/**
+ * Token counts only — the run's model lives on ``details.model_id``.
+ * @export
+ * @interface MessageUsage
+ */
+export interface MessageUsage {
+    /**
+     * 
+     * @type {number}
+     * @memberof MessageUsage
+     */
+    inputTokens: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MessageUsage
+     */
+    outputTokens: number;
+}
+export const MessageUsagePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    inputTokens: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+    outputTokens: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the MessageUsage interface.
+ */
+export function instanceOfMessageUsage(value: object): value is MessageUsage {
+    if (!('inputTokens' in value) || value['inputTokens'] === undefined) return false;
+    if (!('outputTokens' in value) || value['outputTokens'] === undefined) return false;
+    return true;
+}
+
+export function MessageUsageFromJSON(json: any): MessageUsage {
+    return MessageUsageFromJSONTyped(json, false);
+}
+
+export function MessageUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): MessageUsage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'inputTokens': json['input_tokens'],
+        'outputTokens': json['output_tokens'],
+    };
+}
+
+export function MessageUsageToJSON(json: any): MessageUsage {
+    return MessageUsageToJSONTyped(json, false);
+}
+
+export function MessageUsageToJSONTyped(value?: MessageUsage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'input_tokens': value['inputTokens'],
+        'output_tokens': value['outputTokens'],
+    };
+}
+

package/src/models/ReasoningPart.ts

@@ -0,0 +1,140 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface ReasoningPart
+ */
+export interface ReasoningPart {
+    /**
+     * Stable per-message part id (uuid)
+     * @type {string}
+     * @memberof ReasoningPart
+     */
+    id: string;
+    /**
+     * 0-based order within the message
+     * @type {number}
+     * @memberof ReasoningPart
+     */
+    seq: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ReasoningPart
+     */
+    startTime: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ReasoningPart
+     */
+    endTime?: Date | null;
+    /**
+     * 
+     * @type {ReasoningPartKindEnum}
+     * @memberof ReasoningPart
+     */
+    kind?: ReasoningPartKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ReasoningPart
+     */
+    text: string;
+}
+
+
+/**
+ * @export
+ */
+export const ReasoningPartKindEnum = {
+    Reasoning: 'reasoning'
+} as const;
+export type ReasoningPartKindEnum = typeof ReasoningPartKindEnum[keyof typeof ReasoningPartKindEnum];
+
+export const ReasoningPartPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    seq: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the ReasoningPart interface.
+ */
+export function instanceOfReasoningPart(value: object): value is ReasoningPart {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('seq' in value) || value['seq'] === undefined) return false;
+    if (!('startTime' in value) || value['startTime'] === undefined) return false;
+    if (!('text' in value) || value['text'] === undefined) return false;
+    return true;
+}
+
+export function ReasoningPartFromJSON(json: any): ReasoningPart {
+    return ReasoningPartFromJSONTyped(json, false);
+}
+
+export function ReasoningPartFromJSONTyped(json: any, ignoreDiscriminator: boolean): ReasoningPart {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'seq': json['seq'],
+        'startTime': (new Date(json['start_time'])),
+        'endTime': json['end_time'] == null ? undefined : (new Date(json['end_time'])),
+        'kind': json['kind'] == null ? undefined : json['kind'],
+        'text': json['text'],
+    };
+}
+
+export function ReasoningPartToJSON(json: any): ReasoningPart {
+    return ReasoningPartToJSONTyped(json, false);
+}
+
+export function ReasoningPartToJSONTyped(value?: ReasoningPart | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'seq': value['seq'],
+        'start_time': value['startTime'].toISOString(),
+        'end_time': value['endTime'] == null ? value['endTime'] : value['endTime'].toISOString(),
+        'kind': value['kind'],
+        'text': value['text'],
+    };
+}
+