@workglow/ai-provider 0.0.52

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 Steven Roussey
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,488 @@
+# @workglow/ai-provider
+
+AI provider implementations for Workglow AI task pipelines.
+
+## Overview
+
+The `@workglow/ai-provider` package provides concrete implementations of AI providers that can be used with Workglow's task execution system. It includes support for various AI services and local model execution frameworks.
+
+## Features
+
+- **HuggingFace Transformers**: Support for ONNX models via HuggingFace Transformers.js
+- **TensorFlow MediaPipe**: Integration with Google's MediaPipe for text processing tasks
+- [FUTURE] **OpenAI Integration**: Support for OpenAI API services
+- [FUTURE] **GGML Support**: Local model execution with GGML format models
+- **Multi-Platform**: Works in browser, Node.js, and Bun environments
+- **Worker Support**: Offload AI computation to web workers for better performance
+- **Type Safety**: Full TypeScript support with comprehensive type definitions
+
+## Installation
+
+```bash
+npm install @workglow/ai-provider
+# or
+bun add @workglow/ai-provider
+```
+
+## Peer Dependencies
+
+Depending on which providers you use, you may need to install additional peer dependencies:
+
+```bash
+# For HuggingFace Transformers support
+npm install @sroussey/transformers
+
+# For MediaPipe support
+npm install @mediapipe/tasks-text
+```
+
+## Quick Start
+
+### 1. Basic Setup
+
+```typescript
+import {
+  HF_TRANSFORMERS_ONNX,
+  TENSORFLOW_MEDIAPIPE,
+  register_HFT_InlineJobFns,
+  register_TFMP_InlineJobFns,
+} from "@workglow/ai-provider";
+import { getTaskQueueRegistry } from "@workglow/task-graph";
+import { AiJob } from "@workglow/ai";
+import { JobQueue, ConcurrencyLimiter } from "@workglow/job-queue";
+import { InMemoryQueueStorage } from "@workglow/storage";
+
+// Register AI providers
+await register_HFT_InlineJobFns();
+register_TFMP_InlineJobFns();
+
+// Set up job queues
+const queueRegistry = getTaskQueueRegistry();
+
+queueRegistry.registerQueue(
+  new JobQueue(HF_TRANSFORMERS_ONNX, AiJob, {
+    limiter: new ConcurrencyLimiter(1, 100),
+    storage: new InMemoryQueueStorage(HF_TRANSFORMERS_ONNX),
+  })
+);
+
+queueRegistry.registerQueue(
+  new JobQueue(TENSORFLOW_MEDIAPIPE, AiJob, {
+    limiter: new ConcurrencyLimiter(1, 100),
+    storage: new InMemoryQueueStorage(TENSORFLOW_MEDIAPIPE),
+  })
+);
+```
+
+### 2. Using AI Tasks in Workflows
+
+```typescript
+import {
+  TextGenerationTask,
+  TextEmbeddingTask,
+  TextTranslationTask,
+  TextSummaryTask,
+} from "@workglow/ai";
+import { Workflow } from "@workglow/task-graph";
+
+const workflow = new Workflow();
+
+// Add AI tasks to your workflow
+const result = await workflow
+  .add(
+    new TextGenerationTask({
+      model: "Xenova/gpt2",
+      prompt: "The future of AI is",
+    })
+  )
+  .add(
+    new TextEmbeddingTask({
+      model: "Xenova/all-MiniLM-L6-v2",
+      text: "Hello world",
+    })
+  )
+  .run();
+```
+
+## Available Providers
+
+### HuggingFace Transformers (`HF_TRANSFORMERS_ONNX`)
+
+Supports ONNX models from HuggingFace Hub with the following task types:
+
+#### Supported Tasks
+
+- **TextGenerationTask**: Generate text from prompts
+- **TextEmbeddingTask**: Generate vector embeddings for text
+- **TextTranslationTask**: Translate text between languages
+- **TextSummaryTask**: Summarize long text
+- **TextRewriterTask**: Rewrite text with a given prompt
+- **TextQuestionAnswerTask**: Answer questions based on context
+- **DownloadModelTask**: Pre-download and cache models
+
+#### Model Configuration
+
+Models support various quantization options:
+
+```typescript
+import { QUANTIZATION_DATA_TYPES } from "@workglow/ai-provider";
+
+// Quantization options
+// "auto" - Auto-detect based on environment
+// "fp32" - 32-bit floating point
+// "fp16" - 16-bit floating point
+// "q8" - 8-bit quantized
+// "int8" - 8-bit integer
+// "uint8" - 8-bit unsigned integer
+// "q4" - 4-bit quantized
+// "bnb4" - BitsAndBytes 4-bit
+// "q4f16" - fp16 model with int4 block weight quantization
+```
+
+#### Task Examples
+
+**Text Generation:**
+
+```typescript
+import { TextGenerationTask } from "@workglow/ai";
+
+const task = new TextGenerationTask({
+  model: "Xenova/gpt2",
+  prompt: "Once upon a time",
+  maxTokens: 50,
+  temperature: 0.7,
+  topP: 0.9,
+  frequencyPenalty: 0,
+  presencePenalty: 0,
+});
+
+const result = await task.execute();
+// result.text: string - Generated text
+```
+
+**Text Embedding:**
+
+```typescript
+import { TextEmbeddingTask } from "@workglow/ai";
+
+const task = new TextEmbeddingTask({
+  model: "Xenova/all-MiniLM-L6-v2",
+  text: "This is a sample text for embedding",
+});
+
+const result = await task.execute();
+// result.vector: TypedArray - Vector embedding
+```
+
+**Text Translation:**
+
+```typescript
+import { TextTranslationTask } from "@workglow/ai";
+
+const task = new TextTranslationTask({
+  model: "Xenova/t5-small",
+  text: "Hello world",
+  source_lang: "en",
+  target_lang: "fr",
+});
+
+const result = await task.execute();
+// result.text: string - Translated text
+// result.target_lang: string - Target language
+```
+
+**Text Summary:**
+
+```typescript
+import { TextSummaryTask } from "@workglow/ai";
+
+const task = new TextSummaryTask({
+  model: "Xenova/distilbart-cnn-6-6",
+  text: "Long text to summarize...",
+});
+
+const result = await task.execute();
+// result.text: string - Summary text
+```
+
+**Text Rewriter:**
+
+```typescript
+import { TextRewriterTask } from "@workglow/ai";
+
+const task = new TextRewriterTask({
+  model: "Xenova/gpt2",
+  text: "The weather is nice today",
+  prompt: "Rewrite this as a pirate would say it",
+});
+
+const result = await task.execute();
+// result.text: string - Rewritten text
+```
+
+**Question Answering:**
+
+```typescript
+import { TextQuestionAnswerTask } from "@workglow/ai";
+
+const task = new TextQuestionAnswerTask({
+  model: "Xenova/distilbert-base-uncased-distilled-squad",
+  context: "The capital of France is Paris. It is known for the Eiffel Tower.",
+  question: "What is the capital of France?",
+});
+
+const result = await task.execute();
+// result.text: string - Answer text
+```
+
+### TensorFlow MediaPipe (`TENSORFLOW_MEDIAPIPE`)
+
+Optimized for performance using Google's MediaPipe framework.
+
+#### Supported Tasks
+
+- **TextEmbeddingTask**: Generate vector embeddings for text
+- **DownloadModelTask**: Pre-download and cache models
+
+#### Example
+
+```typescript
+import { TextEmbeddingTask } from "@workglow/ai";
+
+const task = new TextEmbeddingTask({
+  model: "path/to/mediapipe/model.tflite",
+  text: "Text to embed",
+});
+
+const result = await task.execute();
+// result.vector: Float32Array - Vector embedding
+```
+
+## Advanced Usage
+
+### Worker Setup
+
+For better performance, especially in browser environments, run AI inference in web workers:
+
+#### Main Thread Setup
+
+```typescript
+import { register_HFT_ClientJobFns, register_TFMP_ClientJobFns } from "@workglow/ai-provider";
+
+// Register HuggingFace Transformers with worker
+register_HFT_ClientJobFns(
+  new Worker(new URL("./hft-worker.ts", import.meta.url), { type: "module" })
+);
+
+// Register MediaPipe with worker
+register_TFMP_ClientJobFns(
+  new Worker(new URL("./tfmp-worker.ts", import.meta.url), { type: "module" })
+);
+```
+
+#### Worker Setup Files
+
+**hft-worker.ts:**
+
+```typescript
+import { register_HFT_WorkerJobFns } from "@workglow/ai-provider";
+
+// Register HuggingFace Transformers worker functions
+register_HFT_WorkerJobFns();
+```
+
+**tfmp-worker.ts:**
+
+```typescript
+import { register_TFMP_WorkerJobFns } from "@workglow/ai-provider";
+
+// Register MediaPipe worker functions
+register_TFMP_WorkerJobFns();
+```
+
+### Model Management
+
+```typescript
+import { getGlobalModelRepository } from "@workglow/ai";
+import { DownloadModelTask } from "@workglow/ai";
+
+// Pre-download models
+const downloadTask = new DownloadModelTask({
+  model: "Xenova/all-MiniLM-L6-v2",
+});
+
+await downloadTask.execute();
+
+// Models are automatically cached for subsequent use
+```
+
+### Custom Job Queue Configuration
+
+```typescript
+import { JobQueue, ConcurrencyLimiter, DelayLimiter } from "@workglow/job-queue";
+import { InMemoryQueueStorage } from "@workglow/storage";
+
+// Configure queue with custom limits
+const customQueue = new JobQueue(HF_TRANSFORMERS_ONNX, AiJob, {
+  limiter: new ConcurrencyLimiter(2, 1000), // 2 concurrent jobs, 1000ms timeout
+  storage: new InMemoryQueueStorage(HF_TRANSFORMERS_ONNX),
+});
+```
+
+### Error Handling
+
+```typescript
+import { PermanentJobError, AbortSignalJobError } from "@workglow/job-queue";
+
+try {
+  const task = new TextGenerationTask({
+    model: "invalid-model",
+    prompt: "Test",
+  });
+
+  await task.execute();
+} catch (error) {
+  if (error instanceof PermanentJobError) {
+    console.error("Permanent error:", error.message);
+  } else if (error instanceof AbortSignalJobError) {
+    console.error("Task was aborted");
+  }
+}
+```
+
+### Progress Tracking
+
+```typescript
+const task = new TextGenerationTask({
+  model: "Xenova/gpt2",
+  prompt: "Generate text...",
+});
+
+// Listen for progress updates
+task.on("progress", (progress, message, details) => {
+  console.log(`Progress: ${progress}% - ${message}`, details);
+});
+
+await task.execute();
+```
+
+## Complete Working Example
+
+```typescript
+import { HF_TRANSFORMERS_ONNX, register_HFT_InlineJobFns } from "@workglow/ai-provider";
+import { TextGenerationTask, TextEmbeddingTask, AiJob } from "@workglow/ai";
+import { Workflow, getTaskQueueRegistry } from "@workglow/task-graph";
+import { JobQueue, ConcurrencyLimiter } from "@workglow/job-queue";
+import { InMemoryQueueStorage } from "@workglow/storage";
+
+async function main() {
+  // 1. Register the AI provider
+  await register_HFT_InlineJobFns();
+
+  // 2. Set up job queue
+  const queueRegistry = getTaskQueueRegistry();
+  queueRegistry.registerQueue(
+    new JobQueue(HF_TRANSFORMERS_ONNX, AiJob, {
+      limiter: new ConcurrencyLimiter(1, 100),
+      storage: new InMemoryQueueStorage(HF_TRANSFORMERS_ONNX),
+    })
+  );
+
+  // 3. Create and run workflow
+  const workflow = new Workflow();
+
+  const result = await workflow
+    .add(
+      new TextGenerationTask({
+        model: "Xenova/gpt2",
+        prompt: "The benefits of AI include",
+        maxTokens: 50,
+      })
+    )
+    .add(
+      new TextEmbeddingTask({
+        model: "Xenova/all-MiniLM-L6-v2",
+        text: "AI is transforming the world",
+      })
+    )
+    .run();
+
+  console.log("Generated text:", result.outputs[0].text);
+  console.log("Embedding dimensions:", result.outputs[1].vector.length);
+}
+
+main().catch(console.error);
+```
+
+## Task Input/Output Schemas
+
+### Common Types
+
+```typescript
+// Model reference (string)
+model: string
+
+// Text input/output
+text: string
+
+// Vector embedding (typed array)
+vector: Float32Array | Float64Array | Int32Array | etc.
+
+// Language codes (ISO 639-1)
+source_lang: string  // e.g., "en", "fr", "es"
+target_lang: string
+```
+
+### Task Schemas Summary
+
+| Task                       | Input                                                                                     | Output                  |
+| -------------------------- | ----------------------------------------------------------------------------------------- | ----------------------- |
+| **TextGenerationTask**     | `{ model, prompt, maxTokens?, temperature?, topP?, frequencyPenalty?, presencePenalty? }` | `{ text }`              |
+| **TextEmbeddingTask**      | `{ model, text }`                                                                         | `{ vector }`            |
+| **TextTranslationTask**    | `{ model, text, source_lang, target_lang }`                                               | `{ text, target_lang }` |
+| **TextSummaryTask**        | `{ model, text }`                                                                         | `{ text }`              |
+| **TextRewriterTask**       | `{ model, text, prompt }`                                                                 | `{ text }`              |
+| **TextQuestionAnswerTask** | `{ model, context, question }`                                                            | `{ text }`              |
+| **DownloadModelTask**      | `{ model }`                                                                               | `{ model }`             |
+
+## Popular Models
+
+### HuggingFace Transformers Models
+
+**Text Generation:**
+
+- `Xenova/gpt2` - GPT-2 text generation
+- `Xenova/distilgpt2` - Smaller GPT-2 variant
+
+**Text Embedding:**
+
+- `Xenova/all-MiniLM-L6-v2` - General purpose embeddings
+- `Xenova/all-mpnet-base-v2` - High quality embeddings
+
+**Translation:**
+
+- `Xenova/t5-small` - Multilingual translation
+- `Xenova/marian-mt-en-fr` - English to French
+
+**Summarization:**
+
+- `Xenova/distilbart-cnn-6-6` - News summarization
+- `Xenova/t5-small` - General summarization
+
+**Question Answering:**
+
+- `Xenova/distilbert-base-uncased-distilled-squad` - SQuAD trained
+
+## Dependencies
+
+This package depends on:
+
+- `@workglow/ai` - Core AI abstractions
+- `@workglow/job-queue` - Job queue system
+- `@workglow/storage` - Storage abstractions
+- `@workglow/task-graph` - Task graph system
+- `@workglow/util` - Utility functions
+
+## License
+
+Apache 2.0 - See [LICENSE](./LICENSE) for details.

package/dist/ggml/model/GgmlLocalModel.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export declare const LOCAL_LLAMACPP = "LOCAL_LLAMACPP";
+//# sourceMappingURL=GgmlLocalModel.d.ts.map

package/dist/ggml/model/GgmlLocalModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GgmlLocalModel.d.ts","sourceRoot":"","sources":["../../../src/ggml/model/GgmlLocalModel.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,eAAO,MAAM,cAAc,mBAAmB,CAAC"}

package/dist/ggml/server.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=server.d.ts.map