@knowledge-stack/ksapi 1.104.0 → 1.106.0

package/src/models/StartWorkflowRunRequest.ts

@@ -0,0 +1,91 @@
+/* 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';
+/**
+ * Optional JSON body for ``POST /v1/workflow-runs/{id}/start``.
+ * 
+ * The whole body is optional: an absent body starts the run with just
+ * the localized "Started workflow: X" opening message, exactly as
+ * before. When ``user_message`` is set it is appended to that opening
+ * thread message AND injected into the runner's first user turn, so the
+ * agent acts on it as guidance layered on the workflow instruction.
+ * @export
+ * @interface StartWorkflowRunRequest
+ */
+export interface StartWorkflowRunRequest {
+    /**
+     * Free-text instruction shown in the run thread and passed to the agent as additional guidance on top of the workflow instruction. Optional.
+     * @type {string}
+     * @memberof StartWorkflowRunRequest
+     */
+    userMessage?: string | null;
+}
+export const StartWorkflowRunRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    userMessage: {
+        maxLength: 4000,
+    },
+}
+
+
+/**
+ * Check if a given object implements the StartWorkflowRunRequest interface.
+ */
+export function instanceOfStartWorkflowRunRequest(value: object): value is StartWorkflowRunRequest {
+    return true;
+}
+
+export function StartWorkflowRunRequestFromJSON(json: any): StartWorkflowRunRequest {
+    return StartWorkflowRunRequestFromJSONTyped(json, false);
+}
+
+export function StartWorkflowRunRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): StartWorkflowRunRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'userMessage': json['user_message'] == null ? undefined : json['user_message'],
+    };
+}
+
+export function StartWorkflowRunRequestToJSON(json: any): StartWorkflowRunRequest {
+    return StartWorkflowRunRequestToJSONTyped(json, false);
+}
+
+export function StartWorkflowRunRequestToJSONTyped(value?: StartWorkflowRunRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'user_message': value['userMessage'],
+    };
+}
+

package/src/models/WorkflowRunSnapshot.ts

@@ -66,6 +66,12 @@ export interface WorkflowRunSnapshot {
      * @memberof WorkflowRunSnapshot
      */
     inputs: Array<InputSnapshot>;
+    /**
+     * Optional free-text message the caller supplied at Start. Pinned here so the runner injects it into the agent's first user turn and it survives retry, redrive, and workflow-thread follow-ups (all of which re-assemble the prompt from this snapshot).
+     * @type {string}
+     * @memberof WorkflowRunSnapshot
+     */
+    userMessage?: string | null;
 }
 export const WorkflowRunSnapshotPropertyValidationAttributesMap: {
     [property: string]: {
@@ -82,6 +88,9 @@ export const WorkflowRunSnapshotPropertyValidationAttributesMap: {
         uniqueItems?: boolean
     }
 } = {
+    userMessage: {
+        maxLength: 4000,
+    },
 }
 
 
@@ -110,6 +119,7 @@ export function WorkflowRunSnapshotFromJSONTyped(json: any, ignoreDiscriminator:
         'maxRunDurationSeconds': json['max_run_duration_seconds'],
         'instruction': InstructionSnapshotFromJSON(json['instruction']),
         'inputs': ((json['inputs'] as Array<any>).map(InputSnapshotFromJSON)),
+        'userMessage': json['user_message'] == null ? undefined : json['user_message'],
     };
 }
 
@@ -128,6 +138,7 @@ export function WorkflowRunSnapshotToJSONTyped(value?: WorkflowRunSnapshot | nul
         'max_run_duration_seconds': value['maxRunDurationSeconds'],
         'instruction': InstructionSnapshotToJSON(value['instruction']),
         'inputs': ((value['inputs'] as Array<any>).map(InputSnapshotToJSON)),
+        'user_message': value['userMessage'],
     };
 }
 

package/src/models/index.ts

@@ -213,6 +213,7 @@ export * from './SetApprovalStateRequest';
 export * from './SetWorkflowRunApprovalRequest';
 export * from './SignInRequest';
 export * from './SortDirection';
+export * from './StartWorkflowRunRequest';
 export * from './StepInput';
 export * from './StepKind';
 export * from './StepOutput';