@knowledge-stack/ksapi 1.120.0 → 1.121.0

package/src/models/ToolPart.ts

@@ -0,0 +1,212 @@
+/* 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 { ToolStatus } from './ToolStatus';
+import {
+    ToolStatusFromJSON,
+    ToolStatusFromJSONTyped,
+    ToolStatusToJSON,
+    ToolStatusToJSONTyped,
+} from './ToolStatus';
+import type { Input } from './Input';
+import {
+    InputFromJSON,
+    InputFromJSONTyped,
+    InputToJSON,
+    InputToJSONTyped,
+} from './Input';
+
+/**
+ * 
+ * @export
+ * @interface ToolPart
+ */
+export interface ToolPart {
+    /**
+     * Stable per-message part id (uuid)
+     * @type {string}
+     * @memberof ToolPart
+     */
+    id: string;
+    /**
+     * 0-based order within the message
+     * @type {number}
+     * @memberof ToolPart
+     */
+    seq: number;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ToolPart
+     */
+    startTime: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ToolPart
+     */
+    endTime?: Date | null;
+    /**
+     * 
+     * @type {ToolPartKindEnum}
+     * @memberof ToolPart
+     */
+    kind?: ToolPartKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ToolPart
+     */
+    toolCallId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ToolPart
+     */
+    toolName: string;
+    /**
+     * 
+     * @type {Input}
+     * @memberof ToolPart
+     */
+    input?: Input | null;
+    /**
+     * 
+     * @type {ToolStatus}
+     * @memberof ToolPart
+     */
+    status?: ToolStatus;
+    /**
+     * 
+     * @type {any}
+     * @memberof ToolPart
+     */
+    result?: any | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ToolPart
+     */
+    isError?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof ToolPart
+     */
+    durationMs?: number | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof ToolPart
+     */
+    extras?: { [key: string]: any; } | null;
+}
+
+
+/**
+ * @export
+ */
+export const ToolPartKindEnum = {
+    Tool: 'tool'
+} as const;
+export type ToolPartKindEnum = typeof ToolPartKindEnum[keyof typeof ToolPartKindEnum];
+
+export const ToolPartPropertyValidationAttributesMap: {
+    [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 ToolPart interface.
+ */
+export function instanceOfToolPart(value: object): value is ToolPart {
+    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 (!('toolCallId' in value) || value['toolCallId'] === undefined) return false;
+    if (!('toolName' in value) || value['toolName'] === undefined) return false;
+    return true;
+}
+
+export function ToolPartFromJSON(json: any): ToolPart {
+    return ToolPartFromJSONTyped(json, false);
+}
+
+export function ToolPartFromJSONTyped(json: any, ignoreDiscriminator: boolean): ToolPart {
+    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'],
+        'toolName': json['tool_name'],
+        'input': json['input'] == null ? undefined : InputFromJSON(json['input']),
+        'status': json['status'] == null ? undefined : ToolStatusFromJSON(json['status']),
+        'result': json['result'] == null ? undefined : json['result'],
+        'isError': json['is_error'] == null ? undefined : json['is_error'],
+        'durationMs': json['duration_ms'] == null ? undefined : json['duration_ms'],
+        'extras': json['extras'] == null ? undefined : json['extras'],
+    };
+}
+
+export function ToolPartToJSON(json: any): ToolPart {
+    return ToolPartToJSONTyped(json, false);
+}
+
+export function ToolPartToJSONTyped(value?: ToolPart | 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'],
+        'tool_name': value['toolName'],
+        'input': InputToJSON(value['input']),
+        'status': ToolStatusToJSON(value['status']),
+        'result': value['result'],
+        'is_error': value['isError'],
+        'duration_ms': value['durationMs'],
+        'extras': value['extras'],
+    };
+}
+

package/src/models/ToolStatus.ts

@@ -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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const ToolStatus = {
+    Running: 'running',
+    Success: 'success',
+    Error: 'error',
+    Canceled: 'canceled'
+} as const;
+export type ToolStatus = typeof ToolStatus[keyof typeof ToolStatus];
+
+
+export function instanceOfToolStatus(value: any): boolean {
+    for (const key in ToolStatus) {
+        if (Object.prototype.hasOwnProperty.call(ToolStatus, key)) {
+            if (ToolStatus[key as keyof typeof ToolStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ToolStatusFromJSON(json: any): ToolStatus {
+    return ToolStatusFromJSONTyped(json, false);
+}
+
+export function ToolStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): ToolStatus {
+    return json as ToolStatus;
+}
+
+export function ToolStatusToJSON(value?: ToolStatus | null): any {
+    return value as any;
+}
+
+export function ToolStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): ToolStatus {
+    return value as ToolStatus;
+}
+

package/src/models/WorkflowRunAsset.ts

@@ -0,0 +1,153 @@
+/* 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 { PartType } from './PartType';
+import {
+    PartTypeFromJSON,
+    PartTypeFromJSONTyped,
+    PartTypeToJSON,
+    PartTypeToJSONTyped,
+} from './PartType';
+import type { PathPartApprovalState } from './PathPartApprovalState';
+import {
+    PathPartApprovalStateFromJSON,
+    PathPartApprovalStateFromJSONTyped,
+    PathPartApprovalStateToJSON,
+    PathPartApprovalStateToJSONTyped,
+} from './PathPartApprovalState';
+
+/**
+ * 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``.
+ * @export
+ * @interface WorkflowRunAsset
+ */
+export interface WorkflowRunAsset {
+    /**
+     * PDO id accepted by the download / list-contents APIs
+     * @type {string}
+     * @memberof WorkflowRunAsset
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowRunAsset
+     */
+    pathPartId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowRunAsset
+     */
+    name: string;
+    /**
+     * 
+     * @type {PartType}
+     * @memberof WorkflowRunAsset
+     */
+    partType: PartType;
+    /**
+     * 
+     * @type {string}
+     * @memberof WorkflowRunAsset
+     */
+    materializedPath: string;
+    /**
+     * 
+     * @type {PathPartApprovalState}
+     * @memberof WorkflowRunAsset
+     */
+    approvalState: PathPartApprovalState;
+}
+
+
+export const WorkflowRunAssetPropertyValidationAttributesMap: {
+    [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 WorkflowRunAsset interface.
+ */
+export function instanceOfWorkflowRunAsset(value: object): value is WorkflowRunAsset {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('partType' in value) || value['partType'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
+    if (!('approvalState' in value) || value['approvalState'] === undefined) return false;
+    return true;
+}
+
+export function WorkflowRunAssetFromJSON(json: any): WorkflowRunAsset {
+    return WorkflowRunAssetFromJSONTyped(json, false);
+}
+
+export function WorkflowRunAssetFromJSONTyped(json: any, ignoreDiscriminator: boolean): WorkflowRunAsset {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'pathPartId': json['path_part_id'],
+        'name': json['name'],
+        'partType': PartTypeFromJSON(json['part_type']),
+        'materializedPath': json['materialized_path'],
+        'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
+    };
+}
+
+export function WorkflowRunAssetToJSON(json: any): WorkflowRunAsset {
+    return WorkflowRunAssetToJSONTyped(json, false);
+}
+
+export function WorkflowRunAssetToJSONTyped(value?: WorkflowRunAsset | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'path_part_id': value['pathPartId'],
+        'name': value['name'],
+        'part_type': PartTypeToJSON(value['partType']),
+        'materialized_path': value['materializedPath'],
+        'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
+    };
+}
+

package/src/models/WorkflowRunResponse.ts

@@ -20,6 +20,13 @@ import {
     ItemPermissionsToJSON,
     ItemPermissionsToJSONTyped,
 } from './ItemPermissions';
+import type { WorkflowRunAsset } from './WorkflowRunAsset';
+import {
+    WorkflowRunAssetFromJSON,
+    WorkflowRunAssetFromJSONTyped,
+    WorkflowRunAssetToJSON,
+    WorkflowRunAssetToJSONTyped,
+} from './WorkflowRunAsset';
 import type { WorkflowRunSnapshot } from './WorkflowRunSnapshot';
 import {
     WorkflowRunSnapshotFromJSON,
@@ -199,11 +206,29 @@ export interface WorkflowRunResponse {
      */
     inputPathPartIds?: Array<string>;
     /**
-     * 
-     * @type {Array<string>}
+     * Generated files under ``outputs/`` (recursing nested folders), each carrying the DOCUMENT PDO ``id`` to feed straight to download / bulk-download. Empty until the run produces output.
+     * @type {Array<WorkflowRunAsset>}
+     * @memberof WorkflowRunResponse
+     */
+    outputAssets?: Array<WorkflowRunAsset>;
+    /**
+     * The run's input context: pinned KB references (``input_path_part_ids``) plus any files uploaded under ``inputs/``, each resolved to its PDO ``id`` + metadata.
+     * @type {Array<WorkflowRunAsset>}
+     * @memberof WorkflowRunResponse
+     */
+    inputAssets?: Array<WorkflowRunAsset>;
+    /**
+     * Full materialized path of the run's ``inputs/`` folder
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    inputsPath: string;
+    /**
+     * Full materialized path of the run's ``outputs/`` folder
+     * @type {string}
      * @memberof WorkflowRunResponse
      */
-    outputsPathPartIds: Array<string>;
+    outputsPath: string;
     /**
      * Definition common files that were excluded from this run at Start (deleted or unreadable by the starter). Empty until Start builds the snapshot, and empty for the common happy path.
      * @type {Array<ExcludedCommonFile>}
@@ -291,7 +316,8 @@ export function instanceOfWorkflowRunResponse(value: object): value is WorkflowR
     if (!('inputsPathPartId' in value) || value['inputsPathPartId'] === undefined) return false;
     if (!('outputsPathPartId' in value) || value['outputsPathPartId'] === undefined) return false;
     if (!('discussionsPathPartId' in value) || value['discussionsPathPartId'] === undefined) return false;
-    if (!('outputsPathPartIds' in value) || value['outputsPathPartIds'] === undefined) return false;
+    if (!('inputsPath' in value) || value['inputsPath'] === undefined) return false;
+    if (!('outputsPath' in value) || value['outputsPath'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
@@ -328,7 +354,10 @@ export function WorkflowRunResponseFromJSONTyped(json: any, ignoreDiscriminator:
         'outputsPathPartId': json['outputs_path_part_id'],
         'discussionsPathPartId': json['discussions_path_part_id'],
         'inputPathPartIds': json['input_path_part_ids'] == null ? undefined : json['input_path_part_ids'],
-        'outputsPathPartIds': json['outputs_path_part_ids'],
+        'outputAssets': json['output_assets'] == null ? undefined : ((json['output_assets'] as Array<any>).map(WorkflowRunAssetFromJSON)),
+        'inputAssets': json['input_assets'] == null ? undefined : ((json['input_assets'] as Array<any>).map(WorkflowRunAssetFromJSON)),
+        'inputsPath': json['inputs_path'],
+        'outputsPath': json['outputs_path'],
         'excludedCommonFiles': json['excluded_common_files'] == null ? undefined : ((json['excluded_common_files'] as Array<any>).map(ExcludedCommonFileFromJSON)),
         'runThreadId': json['run_thread_id'] == null ? undefined : json['run_thread_id'],
         'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
@@ -370,7 +399,10 @@ export function WorkflowRunResponseToJSONTyped(value?: WorkflowRunResponse | nul
         'outputs_path_part_id': value['outputsPathPartId'],
         'discussions_path_part_id': value['discussionsPathPartId'],
         'input_path_part_ids': value['inputPathPartIds'],
-        'outputs_path_part_ids': value['outputsPathPartIds'],
+        'output_assets': value['outputAssets'] == null ? undefined : ((value['outputAssets'] as Array<any>).map(WorkflowRunAssetToJSON)),
+        'input_assets': value['inputAssets'] == null ? undefined : ((value['inputAssets'] as Array<any>).map(WorkflowRunAssetToJSON)),
+        'inputs_path': value['inputsPath'],
+        'outputs_path': value['outputsPath'],
         'excluded_common_files': value['excludedCommonFiles'] == null ? undefined : ((value['excludedCommonFiles'] as Array<any>).map(ExcludedCommonFileToJSON)),
         'run_thread_id': value['runThreadId'],
         'owner': UserInfoToJSON(value['owner']),

package/src/models/index.ts

@@ -85,6 +85,7 @@ export * from './DiffSpan';
 export * from './DirectorySyncResponse';
 export * from './DisplayNameFormat';
 export * from './DissolveSectionResponse';
+export * from './DocEditPart';
 export * from './DocumentBlockChange';
 export * from './DocumentCheckoutResponse';
 export * from './DocumentDiff';
@@ -135,6 +136,7 @@ export * from './ImageTaxonomy';
 export * from './InformationStatistics';
 export * from './IngestDocumentResponse';
 export * from './IngestionMode';
+export * from './Input';
 export * from './InputOrigin';
 export * from './InputSnapshot';
 export * from './InstantiateWorkflowTemplateRequest';
@@ -156,6 +158,7 @@ export * from './MemoryChunkResponse';
 export * from './MemoryKind';
 export * from './MemoryScope';
 export * from './MessageRole';
+export * from './MessageUsage';
 export * from './MeteredQuotaStatus';
 export * from './ModelTableRequest';
 export * from './ModelTableResult';
@@ -210,6 +213,7 @@ export * from './Polygon';
 export * from './PolygonReference';
 export * from './ProposeMemoryChunkRequest';
 export * from './ProposedMemoryChunkResponse';
+export * from './ReasoningPart';
 export * from './ReferenceType';
 export * from './RequestPhoneChangeRequest';
 export * from './ResolvedReferenceInput';
@@ -234,9 +238,8 @@ export * from './SheetVisibilityChange';
 export * from './SignInRequest';
 export * from './SortDirection';
 export * from './StartWorkflowRunRequest';
-export * from './StepInput';
+export * from './Step';
 export * from './StepKind';
-export * from './StepOutput';
 export * from './StructuredChange';
 export * from './StructuredChangeType';
 export * from './StructuredDiff';
@@ -262,12 +265,15 @@ export * from './TenantUserOrder';
 export * from './TenantUserResponse';
 export * from './TenantUserRole';
 export * from './TextDiff';
+export * from './TextPart';
+export * from './TextPartOrReasoningPartOrToolPartOrDocEditPart';
 export * from './ThreadMessageContent';
-export * from './ThreadMessageDetailsInput';
-export * from './ThreadMessageDetailsOutput';
+export * from './ThreadMessageDetails';
 export * from './ThreadMessageResponse';
 export * from './ThreadOrder';
 export * from './ThreadResponse';
+export * from './ToolPart';
+export * from './ToolStatus';
 export * from './TransferOwnerRequest';
 export * from './TransferOwnerResponse';
 export * from './TrashItemResponse';
@@ -307,6 +313,7 @@ export * from './WorkflowDefinitionOrder';
 export * from './WorkflowDefinitionResponse';
 export * from './WorkflowDetailResponse';
 export * from './WorkflowExecutionState';
+export * from './WorkflowRunAsset';
 export * from './WorkflowRunCallbackRequest';
 export * from './WorkflowRunOrder';
 export * from './WorkflowRunResponse';

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

@@ -1,91 +0,0 @@
-/**
- * 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 { Args } from './Args';
-import type { StepKind } from './StepKind';
-/**
- *
- * @export
- * @interface StepOutput
- */
-export interface StepOutput {
-    /**
-     * Stable step identifier within the message
-     * @type {string}
-     * @memberof StepOutput
-     */
-    id: string;
-    /**
-     * The name of the step
-     * @type {string}
-     * @memberof StepOutput
-     */
-    name: string;
-    /**
-     *
-     * @type {StepKind}
-     * @memberof StepOutput
-     */
-    kind: StepKind;
-    /**
-     *
-     * @type {Args}
-     * @memberof StepOutput
-     */
-    args?: Args | null;
-    /**
-     *
-     * @type {string}
-     * @memberof StepOutput
-     */
-    detail?: string | null;
-    /**
-     * The start time of the step
-     * @type {Date}
-     * @memberof StepOutput
-     */
-    startTime: Date;
-    /**
-     *
-     * @type {Date}
-     * @memberof StepOutput
-     */
-    endTime?: Date | null;
-    /**
-     *
-     * @type {Array<StepOutput>}
-     * @memberof StepOutput
-     */
-    steps?: Array<StepOutput> | null;
-}
-export declare const StepOutputPropertyValidationAttributesMap: {
-    [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 StepOutput interface.
- */
-export declare function instanceOfStepOutput(value: object): value is StepOutput;
-export declare function StepOutputFromJSON(json: any): StepOutput;
-export declare function StepOutputFromJSONTyped(json: any, ignoreDiscriminator: boolean): StepOutput;
-export declare function StepOutputToJSON(json: any): StepOutput;
-export declare function StepOutputToJSONTyped(value?: StepOutput | null, ignoreDiscriminator?: boolean): any;