@workglow/ai 0.0.102 → 0.0.103

package/dist/job/AiJob.d.ts

@@ -5,6 +5,7 @@
  */
 import { IJobExecuteContext, Job } from "@workglow/job-queue";
 import { TaskInput, TaskOutput, type StreamEvent } from "@workglow/task-graph";
+import type { JsonSchema } from "@workglow/util";
 import type { ModelConfig } from "../model/ModelSchema";
 /**
  * Input data for the AiJob
@@ -15,6 +16,8 @@ export interface AiJobInput<Input extends TaskInput = TaskInput> {
     taskInput: Input & {
         model: ModelConfig;
     };
+    /** JSON Schema for structured output, when the task declares x-structured-output. */
+    outputSchema?: JsonSchema;
 }
 /**
  * Extends the base Job class to provide custom execution functionality

package/dist/job/AiJob.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AiJob.d.ts","sourceRoot":"","sources":["../../src/job/AiJob.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAEL,kBAAkB,EAClB,GAAG,EAGJ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,KAAK,SAAS,SAAS,GAAG,SAAS;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,KAAK,GAAG;QAAE,KAAK,EAAE,WAAW,CAAA;KAAE,CAAC;CAC3C;AAED;;;GAGG;AACH,qBAAa,KAAK,CAChB,KAAK,SAAS,UAAU,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,EAC3D,MAAM,SAAS,UAAU,GAAG,UAAU,CACtC,SAAQ,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACG,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IA4CzE;;;OAGG;IACI,aAAa,CAClB,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,kBAAkB,GAC1B,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;CAmBtC"}
+{"version":3,"file":"AiJob.d.ts","sourceRoot":"","sources":["../../src/job/AiJob.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAEL,kBAAkB,EAClB,GAAG,EAGJ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,KAAK,SAAS,SAAS,GAAG,SAAS;IAC7D,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,KAAK,GAAG;QAAE,KAAK,EAAE,WAAW,CAAA;KAAE,CAAC;IAC1C,qFAAqF;IACrF,YAAY,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED;;;GAGG;AACH,qBAAa,KAAK,CAChB,KAAK,SAAS,UAAU,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,EAC3D,MAAM,SAAS,UAAU,GAAG,UAAU,CACtC,SAAQ,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACG,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC;IAkDzE;;;OAGG;IACI,aAAa,CAClB,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,kBAAkB,GAC1B,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;CAmBtC"}

package/dist/node.js

@@ -30,9 +30,9 @@ class AiProviderRegistry {
     this.runFnRegistry.get(taskType).set(modelProvider, runFn);
   }
   registerAsWorkerRunFn(modelProvider, taskType) {
-    const workerFn = async (input, model, update_progress, signal) => {
+    const workerFn = async (input, model, update_progress, signal, outputSchema) => {
       const workerManager = globalServiceRegistry.get(WORKER_MANAGER);
-      const result = await workerManager.callWorkerFunction(modelProvider, taskType, [input, model], {
+      const result = await workerManager.callWorkerFunction(modelProvider, taskType, [input, model, outputSchema], {
         signal,
         onProgress: update_progress
       });
@@ -47,9 +47,9 @@ class AiProviderRegistry {
     this.streamFnRegistry.get(taskType).set(modelProvider, streamFn);
   }
   registerAsWorkerStreamFn(modelProvider, taskType) {
-    const streamFn = async function* (input, model, signal) {
+    const streamFn = async function* (input, model, signal, outputSchema) {
       const workerManager = globalServiceRegistry.get(WORKER_MANAGER);
-      yield* workerManager.callWorkerStreamFunction(modelProvider, taskType, [input, model], { signal });
+      yield* workerManager.callWorkerStreamFunction(modelProvider, taskType, [input, model, outputSchema], { signal });
     };
     this.registerStreamFn(modelProvider, taskType, streamFn);
   }
@@ -121,7 +121,7 @@ class AiJob extends Job {
         if (context.signal?.aborted) {
           throw new AbortSignalJobError("Job aborted");
         }
-        return await fn(input.taskInput, model, context.updateProgress, context.signal);
+        return await fn(input.taskInput, model, context.updateProgress, context.signal, input.outputSchema);
       };
       const runFnPromise = runFn();
       return await Promise.race([runFnPromise, abortPromise]);
@@ -142,7 +142,7 @@ class AiJob extends Job {
       return;
     }
     const model = input.taskInput.model;
-    yield* streamFn(input.taskInput, model, context.signal);
+    yield* streamFn(input.taskInput, model, context.signal, input.outputSchema);
   }
 }
 // src/model/InMemoryModelRepository.ts
@@ -580,7 +580,8 @@ import { convertImageDataToUseableForm } from "@workglow/util";
 // src/task/base/AiTask.ts
 import {
   JobQueueTask,
-  TaskConfigurationError
+  TaskConfigurationError,
+  hasStructuredOutput
 } from "@workglow/task-graph";
 function schemaFormat(schema) {
   return typeof schema === "object" && schema !== null && "format" in schema ? schema.format : undefined;
@@ -599,11 +600,21 @@ class AiTask extends JobQueueTask {
       throw new TaskConfigurationError("AiTask: Model was not resolved to ModelConfig - this indicates a bug in the resolution system");
     }
     const runtype = this.constructor.runtype ?? this.constructor.type;
-    return {
+    const jobInput = {
       taskType: runtype,
       aiProvider: model.provider,
       taskInput: input
     };
+    const inputOutputSchema = input.outputSchema;
+    if (inputOutputSchema && typeof inputOutputSchema === "object") {
+      jobInput.outputSchema = inputOutputSchema;
+    } else {
+      const taskOutputSchema = this.outputSchema();
+      if (hasStructuredOutput(taskOutputSchema)) {
+        jobInput.outputSchema = taskOutputSchema;
+      }
+    }
+    return jobInput;
   }
   async createJob(input, queueName) {
     const jobInput = await this.getJobInput(input);
@@ -1017,6 +1028,11 @@ var inputSchema2 = {
       title: "Document ID",
       description: "The document ID"
     },
+    doc_title: {
+      type: "string",
+      title: "Document Title",
+      description: "Human-readable title for the source document"
+    },
     chunks: {
       type: "array",
       items: ChunkNodeSchema(),
@@ -1088,7 +1104,7 @@ class ChunkToVectorTask extends Task2 {
     return outputSchema2;
   }
   async execute(input, context) {
-    const { chunks, vectors } = input;
+    const { chunks, vectors, doc_title } = input;
     const chunkArray = chunks;
     if (!chunkArray || !vectors) {
       throw new Error("Both chunks and vector are required");
@@ -1110,6 +1126,7 @@ class ChunkToVectorTask extends Task2 {
         depth: chunk.depth,
         text: chunk.text,
         nodePath: chunk.nodePath,
+        ...doc_title ? { doc_title } : {},
         ...chunk.enrichment || {}
       });
     }
@@ -2011,6 +2028,8 @@ class StreamingAiTask extends AiTask {
     })) {
       if (event.type === "text-delta") {
         yield { ...event, port: event.port ?? defaultPort };
+      } else if (event.type === "object-delta") {
+        yield { ...event, port: event.port ?? defaultPort };
       } else {
         yield event;
       }
@@ -4513,11 +4532,82 @@ var structuralParser = (input, config) => {
 };
 Workflow29.prototype.structuralParser = CreateWorkflow29(StructuralParserTask);
 
+// src/task/StructuredGenerationTask.ts
+import { CreateWorkflow as CreateWorkflow30, Workflow as Workflow30 } from "@workglow/task-graph";
+var modelSchema20 = TypeModel("model:StructuredGenerationTask");
+var StructuredGenerationInputSchema = {
+  type: "object",
+  properties: {
+    model: modelSchema20,
+    prompt: {
+      type: "string",
+      title: "Prompt",
+      description: "The prompt to generate structured output from"
+    },
+    outputSchema: {
+      type: "object",
+      title: "Output Schema",
+      description: "JSON Schema describing the desired output structure",
+      additionalProperties: true
+    },
+    maxTokens: {
+      type: "number",
+      title: "Max Tokens",
+      description: "The maximum number of tokens to generate",
+      minimum: 1,
+      maximum: 4096,
+      "x-ui-group": "Configuration"
+    },
+    temperature: {
+      type: "number",
+      title: "Temperature",
+      description: "The temperature to use for sampling",
+      minimum: 0,
+      maximum: 2,
+      "x-ui-group": "Configuration"
+    }
+  },
+  required: ["model", "prompt", "outputSchema"],
+  additionalProperties: false
+};
+var StructuredGenerationOutputSchema = {
+  type: "object",
+  properties: {
+    object: {
+      type: "object",
+      title: "Structured Output",
+      description: "The generated structured object conforming to the provided schema",
+      "x-stream": "object",
+      "x-structured-output": true,
+      additionalProperties: true
+    }
+  },
+  required: ["object"],
+  additionalProperties: false
+};
+
+class StructuredGenerationTask extends StreamingAiTask {
+  static type = "StructuredGenerationTask";
+  static category = "AI Text Model";
+  static title = "Structured Generation";
+  static description = "Generates structured JSON output conforming to a provided schema using language models";
+  static inputSchema() {
+    return StructuredGenerationInputSchema;
+  }
+  static outputSchema() {
+    return StructuredGenerationOutputSchema;
+  }
+}
+var structuredGeneration = (input, config) => {
+  return new StructuredGenerationTask({}, config).run(input);
+};
+Workflow30.prototype.structuredGeneration = CreateWorkflow30(StructuredGenerationTask);
+
 // src/task/TextChunkerTask.ts
 import {
-  CreateWorkflow as CreateWorkflow30,
+  CreateWorkflow as CreateWorkflow31,
   Task as Task13,
-  Workflow as Workflow30
+  Workflow as Workflow31
 } from "@workglow/task-graph";
 var ChunkingStrategy = {
   FIXED: "fixed",
@@ -4767,11 +4857,11 @@ class TextChunkerTask extends Task13 {
 var textChunker = (input, config) => {
   return new TextChunkerTask({}, config).run(input);
 };
-Workflow30.prototype.textChunker = CreateWorkflow30(TextChunkerTask);
+Workflow31.prototype.textChunker = CreateWorkflow31(TextChunkerTask);
 
 // src/task/TextFillMaskTask.ts
-import { CreateWorkflow as CreateWorkflow31, Workflow as Workflow31 } from "@workglow/task-graph";
-var modelSchema20 = TypeModel("model:TextFillMaskTask");
+import { CreateWorkflow as CreateWorkflow32, Workflow as Workflow32 } from "@workglow/task-graph";
+var modelSchema21 = TypeModel("model:TextFillMaskTask");
 var TextFillMaskInputSchema = {
   type: "object",
   properties: {
@@ -4780,7 +4870,7 @@ var TextFillMaskInputSchema = {
       title: "Text",
       description: "The text with a mask token to fill"
     },
-    model: modelSchema20
+    model: modelSchema21
   },
   required: ["text", "model"],
   additionalProperties: false
@@ -4835,21 +4925,21 @@ class TextFillMaskTask extends AiTask {
 var textFillMask = (input, config) => {
   return new TextFillMaskTask({}, config).run(input);
 };
-Workflow31.prototype.textFillMask = CreateWorkflow31(TextFillMaskTask);
+Workflow32.prototype.textFillMask = CreateWorkflow32(TextFillMaskTask);
 
 // src/task/TextGenerationTask.ts
-import { CreateWorkflow as CreateWorkflow32, Workflow as Workflow32 } from "@workglow/task-graph";
+import { CreateWorkflow as CreateWorkflow33, Workflow as Workflow33 } from "@workglow/task-graph";
 var generatedTextSchema2 = {
   type: "string",
   title: "Text",
   description: "The generated text",
   "x-stream": "append"
 };
-var modelSchema21 = TypeModel("model:TextGenerationTask");
+var modelSchema22 = TypeModel("model:TextGenerationTask");
 var TextGenerationInputSchema = {
   type: "object",
   properties: {
-    model: modelSchema21,
+    model: modelSchema22,
     prompt: {
       type: "string",
       title: "Prompt",
@@ -4923,11 +5013,11 @@ class TextGenerationTask extends StreamingAiTask {
 var textGeneration = (input, config) => {
   return new TextGenerationTask({}, config).run(input);
 };
-Workflow32.prototype.textGeneration = CreateWorkflow32(TextGenerationTask);
+Workflow33.prototype.textGeneration = CreateWorkflow33(TextGenerationTask);
 
 // src/task/TextLanguageDetectionTask.ts
-import { CreateWorkflow as CreateWorkflow33, Workflow as Workflow33 } from "@workglow/task-graph";
-var modelSchema22 = TypeModel("model:TextLanguageDetectionTask");
+import { CreateWorkflow as CreateWorkflow34, Workflow as Workflow34 } from "@workglow/task-graph";
+var modelSchema23 = TypeModel("model:TextLanguageDetectionTask");
 var TextLanguageDetectionInputSchema = {
   type: "object",
   properties: {
@@ -4944,7 +5034,7 @@ var TextLanguageDetectionInputSchema = {
       title: "Max Languages",
       description: "The maximum number of languages to return"
     },
-    model: modelSchema22
+    model: modelSchema23
   },
   required: ["text", "model"],
   additionalProperties: false
@@ -4994,10 +5084,10 @@ class TextLanguageDetectionTask extends AiTask {
 var textLanguageDetection = (input, config) => {
   return new TextLanguageDetectionTask({}, config).run(input);
 };
-Workflow33.prototype.textLanguageDetection = CreateWorkflow33(TextLanguageDetectionTask);
+Workflow34.prototype.textLanguageDetection = CreateWorkflow34(TextLanguageDetectionTask);
 
 // src/task/TextQuestionAnswerTask.ts
-import { CreateWorkflow as CreateWorkflow34, Workflow as Workflow34 } from "@workglow/task-graph";
+import { CreateWorkflow as CreateWorkflow35, Workflow as Workflow35 } from "@workglow/task-graph";
 var contextSchema = {
   type: "string",
   title: "Context",
@@ -5014,13 +5104,13 @@ var textSchema = {
   description: "The generated text",
   "x-stream": "append"
 };
-var modelSchema23 = TypeModel("model:TextQuestionAnswerTask");
+var modelSchema24 = TypeModel("model:TextQuestionAnswerTask");
 var TextQuestionAnswerInputSchema = {
   type: "object",
   properties: {
     context: contextSchema,
     question: questionSchema,
-    model: modelSchema23
+    model: modelSchema24
   },
   required: ["context", "question", "model"],
   additionalProperties: false
@@ -5049,11 +5139,11 @@ class TextQuestionAnswerTask extends StreamingAiTask {
 var textQuestionAnswer = (input, config) => {
   return new TextQuestionAnswerTask({}, config).run(input);
 };
-Workflow34.prototype.textQuestionAnswer = CreateWorkflow34(TextQuestionAnswerTask);
+Workflow35.prototype.textQuestionAnswer = CreateWorkflow35(TextQuestionAnswerTask);
 
 // src/task/TextRewriterTask.ts
-import { CreateWorkflow as CreateWorkflow35, Workflow as Workflow35 } from "@workglow/task-graph";
-var modelSchema24 = TypeModel("model:TextRewriterTask");
+import { CreateWorkflow as CreateWorkflow36, Workflow as Workflow36 } from "@workglow/task-graph";
+var modelSchema25 = TypeModel("model:TextRewriterTask");
 var TextRewriterInputSchema = {
   type: "object",
   properties: {
@@ -5067,7 +5157,7 @@ var TextRewriterInputSchema = {
       title: "Prompt",
       description: "The prompt to direct the rewriting"
     },
-    model: modelSchema24
+    model: modelSchema25
   },
   required: ["text", "prompt", "model"],
   additionalProperties: false
@@ -5101,11 +5191,11 @@ class TextRewriterTask extends StreamingAiTask {
 var textRewriter = (input, config) => {
   return new TextRewriterTask({}, config).run(input);
 };
-Workflow35.prototype.textRewriter = CreateWorkflow35(TextRewriterTask);
+Workflow36.prototype.textRewriter = CreateWorkflow36(TextRewriterTask);
 
 // src/task/TextTranslationTask.ts
-import { CreateWorkflow as CreateWorkflow36, Workflow as Workflow36 } from "@workglow/task-graph";
-var modelSchema25 = TypeModel("model:TextTranslationTask");
+import { CreateWorkflow as CreateWorkflow37, Workflow as Workflow37 } from "@workglow/task-graph";
+var modelSchema26 = TypeModel("model:TextTranslationTask");
 var translationTextSchema = {
   type: "string",
   title: "Text",
@@ -5132,7 +5222,7 @@ var TextTranslationInputSchema = {
       minLength: 2,
       maxLength: 2
     }),
-    model: modelSchema25
+    model: modelSchema26
   },
   required: ["text", "source_lang", "target_lang", "model"],
   additionalProperties: false
@@ -5167,13 +5257,13 @@ class TextTranslationTask extends StreamingAiTask {
 var textTranslation = (input, config) => {
   return new TextTranslationTask({}, config).run(input);
 };
-Workflow36.prototype.textTranslation = CreateWorkflow36(TextTranslationTask);
+Workflow37.prototype.textTranslation = CreateWorkflow37(TextTranslationTask);
 
 // src/task/TopicSegmenterTask.ts
 import {
-  CreateWorkflow as CreateWorkflow37,
+  CreateWorkflow as CreateWorkflow38,
   Task as Task14,
-  Workflow as Workflow37
+  Workflow as Workflow38
 } from "@workglow/task-graph";
 var SegmentationMethod = {
   HEURISTIC: "heuristic",
@@ -5454,15 +5544,15 @@ class TopicSegmenterTask extends Task14 {
 var topicSegmenter = (input, config) => {
   return new TopicSegmenterTask({}, config).run(input);
 };
-Workflow37.prototype.topicSegmenter = CreateWorkflow37(TopicSegmenterTask);
+Workflow38.prototype.topicSegmenter = CreateWorkflow38(TopicSegmenterTask);
 
 // src/task/UnloadModelTask.ts
-import { CreateWorkflow as CreateWorkflow38, Workflow as Workflow38 } from "@workglow/task-graph";
-var modelSchema26 = TypeModel("model");
+import { CreateWorkflow as CreateWorkflow39, Workflow as Workflow39 } from "@workglow/task-graph";
+var modelSchema27 = TypeModel("model");
 var UnloadModelInputSchema = {
   type: "object",
   properties: {
-    model: modelSchema26
+    model: modelSchema27
   },
   required: ["model"],
   additionalProperties: false
@@ -5470,7 +5560,7 @@ var UnloadModelInputSchema = {
 var UnloadModelOutputSchema = {
   type: "object",
   properties: {
-    model: modelSchema26
+    model: modelSchema27
   },
   required: ["model"],
   additionalProperties: false
@@ -5492,10 +5582,10 @@ class UnloadModelTask extends AiTask {
 var unloadModel = (input, config) => {
   return new UnloadModelTask({}, config).run(input);
 };
-Workflow38.prototype.unloadModel = CreateWorkflow38(UnloadModelTask);
+Workflow39.prototype.unloadModel = CreateWorkflow39(UnloadModelTask);
 
 // src/task/VectorQuantizeTask.ts
-import { CreateWorkflow as CreateWorkflow39, Task as Task15, Workflow as Workflow39 } from "@workglow/task-graph";
+import { CreateWorkflow as CreateWorkflow40, Task as Task15, Workflow as Workflow40 } from "@workglow/task-graph";
 import {
   normalizeNumberArray,
   TensorType,
@@ -5675,10 +5765,10 @@ class VectorQuantizeTask extends Task15 {
 var vectorQuantize = (input, config) => {
   return new VectorQuantizeTask({}, config).run(input);
 };
-Workflow39.prototype.vectorQuantize = CreateWorkflow39(VectorQuantizeTask);
+Workflow40.prototype.vectorQuantize = CreateWorkflow40(VectorQuantizeTask);
 
 // src/task/VectorSimilarityTask.ts
-import { CreateWorkflow as CreateWorkflow40, GraphAsTask, Workflow as Workflow40 } from "@workglow/task-graph";
+import { CreateWorkflow as CreateWorkflow41, GraphAsTask, Workflow as Workflow41 } from "@workglow/task-graph";
 import {
   cosineSimilarity,
   hammingSimilarity,
@@ -5784,7 +5874,7 @@ class VectorSimilarityTask extends GraphAsTask {
 var similarity = (input, config) => {
   return new VectorSimilarityTask({}, config).run(input);
 };
-Workflow40.prototype.similarity = CreateWorkflow40(VectorSimilarityTask);
+Workflow41.prototype.similarity = CreateWorkflow41(VectorSimilarityTask);
 
 // src/task/index.ts
 var registerAiTasks = () => {
@@ -5814,6 +5904,7 @@ var registerAiTasks = () => {
     QueryExpanderTask,
     RerankerTask,
     StructuralParserTask,
+    StructuredGenerationTask,
     TextChunkerTask,
     TextClassificationTask,
     TextEmbeddingTask,
@@ -5849,6 +5940,7 @@ export {
   textEmbedding,
   textClassification,
   textChunker,
+  structuredGeneration,
   structuralParser,
   similarity,
   setGlobalModelRepository,
@@ -5923,6 +6015,9 @@ export {
   TextClassificationOutputSchema,
   TextClassificationInputSchema,
   TextChunkerTask,
+  StructuredGenerationTask,
+  StructuredGenerationOutputSchema,
+  StructuredGenerationInputSchema,
   StructuralParserTask,
   StreamingAiTask,
   SimilarityFn,
@@ -5990,4 +6085,4 @@ export {
   AiJob
 };
 
-//# debugId=ABDF225708417FBC64756E2164756E21
+//# debugId=69DD026BF72324CF64756E2164756E21