@workglow/ai 0.2.31 → 0.2.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -21
- package/dist/browser.js +841 -278
- package/dist/browser.js.map +10 -7
- package/dist/bun.js +841 -278
- package/dist/bun.js.map +10 -7
- package/dist/node.js +841 -278
- package/dist/node.js.map +10 -7
- package/dist/provider-utils/BaseCloudProvider.d.ts +46 -0
- package/dist/provider-utils/BaseCloudProvider.d.ts.map +1 -0
- package/dist/provider-utils/CloudProviderClient.d.ts +34 -0
- package/dist/provider-utils/CloudProviderClient.d.ts.map +1 -0
- package/dist/provider-utils/HfModelSearch.d.ts +33 -0
- package/dist/provider-utils/HfModelSearch.d.ts.map +1 -0
- package/dist/provider-utils/OpenAIShapedChat.d.ts +71 -0
- package/dist/provider-utils/OpenAIShapedChat.d.ts.map +1 -0
- package/dist/provider-utils/PipelineTaskMapping.d.ts +12 -0
- package/dist/provider-utils/PipelineTaskMapping.d.ts.map +1 -0
- package/dist/provider-utils/ToolCallParsers.d.ts +252 -0
- package/dist/provider-utils/ToolCallParsers.d.ts.map +1 -0
- package/dist/provider-utils/imageOutputHelpers.d.ts +60 -0
- package/dist/provider-utils/imageOutputHelpers.d.ts.map +1 -0
- package/dist/provider-utils/modelSearchQuery.d.ts +23 -0
- package/dist/provider-utils/modelSearchQuery.d.ts.map +1 -0
- package/dist/provider-utils/registerProvider.d.ts +43 -0
- package/dist/provider-utils/registerProvider.d.ts.map +1 -0
- package/dist/provider-utils.d.ts +23 -0
- package/dist/provider-utils.d.ts.map +1 -0
- package/dist/provider-utils.js +1238 -0
- package/dist/provider-utils.js.map +19 -0
- package/dist/task/AiChatTask.d.ts +8 -1
- package/dist/task/AiChatTask.d.ts.map +1 -1
- package/dist/task/AiChatWithKbTask.d.ts +710 -0
- package/dist/task/AiChatWithKbTask.d.ts.map +1 -0
- package/dist/task/HierarchicalChunkerTask.d.ts.map +1 -1
- package/dist/task/KbSearchTask.d.ts +79 -0
- package/dist/task/KbSearchTask.d.ts.map +1 -0
- package/dist/task/VectorSimilarityTask.d.ts +1 -1
- package/dist/task/VectorSimilarityTask.d.ts.map +1 -1
- package/dist/task/base/responseFormat.d.ts +23 -0
- package/dist/task/base/responseFormat.d.ts.map +1 -0
- package/dist/task/index.d.ts +6 -1
- package/dist/task/index.d.ts.map +1 -1
- package/package.json +21 -15
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ bun add @workglow/ai
|
|
|
22
22
|
|
|
23
23
|
## Quick Start
|
|
24
24
|
|
|
25
|
-
Here's a complete example of setting up and using the AI package with the Hugging Face Transformers ONNX provider from `@workglow/ai
|
|
25
|
+
Here's a complete example of setting up and using the AI package with the Hugging Face Transformers ONNX provider from `@workglow/ai`:
|
|
26
26
|
|
|
27
27
|
```typescript
|
|
28
28
|
import {
|
|
@@ -41,8 +41,8 @@ import {
|
|
|
41
41
|
JobQueueClient,
|
|
42
42
|
JobQueueServer,
|
|
43
43
|
} from "@workglow/job-queue";
|
|
44
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
45
|
-
import { registerHuggingFaceTransformersInline } from "@workglow/
|
|
44
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
45
|
+
import { registerHuggingFaceTransformersInline } from "@workglow/huggingface-transformers/ai-runtime";
|
|
46
46
|
|
|
47
47
|
// 1. Set up a model repository
|
|
48
48
|
const modelRepo = new InMemoryModelRepository();
|
|
@@ -111,7 +111,7 @@ Generates text based on prompts using language models.
|
|
|
111
111
|
|
|
112
112
|
```typescript
|
|
113
113
|
import { TextGenerationTask } from "@workglow/ai";
|
|
114
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
114
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
115
115
|
|
|
116
116
|
const gpt2ModelConfig = {
|
|
117
117
|
provider: HF_TRANSFORMERS_ONNX,
|
|
@@ -137,7 +137,7 @@ Generates vector embeddings for text using embedding models.
|
|
|
137
137
|
|
|
138
138
|
```typescript
|
|
139
139
|
import { TextEmbeddingTask } from "@workglow/ai";
|
|
140
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
140
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
141
141
|
|
|
142
142
|
const embeddingModelConfig = {
|
|
143
143
|
provider: HF_TRANSFORMERS_ONNX,
|
|
@@ -182,7 +182,7 @@ Generates summaries of longer text content.
|
|
|
182
182
|
|
|
183
183
|
```typescript
|
|
184
184
|
import { TextSummaryTask } from "@workglow/ai";
|
|
185
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
185
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
186
186
|
|
|
187
187
|
const summarizationModelConfig = {
|
|
188
188
|
provider: HF_TRANSFORMERS_ONNX,
|
|
@@ -209,7 +209,7 @@ Rewrites text in different styles or tones.
|
|
|
209
209
|
|
|
210
210
|
```typescript
|
|
211
211
|
import { TextRewriterTask } from "@workglow/ai";
|
|
212
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
212
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
213
213
|
|
|
214
214
|
const laMiniModelConfig = {
|
|
215
215
|
provider: HF_TRANSFORMERS_ONNX,
|
|
@@ -236,7 +236,7 @@ Answers questions based on provided context.
|
|
|
236
236
|
|
|
237
237
|
```typescript
|
|
238
238
|
import { TextQuestionAnswerTask } from "@workglow/ai";
|
|
239
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
239
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
240
240
|
|
|
241
241
|
const squadModelConfig = {
|
|
242
242
|
provider: HF_TRANSFORMERS_ONNX,
|
|
@@ -276,7 +276,7 @@ Computes similarity between texts or embeddings.
|
|
|
276
276
|
|
|
277
277
|
```typescript
|
|
278
278
|
import { VectorSimilarityTask } from "@workglow/ai";
|
|
279
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
279
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
280
280
|
|
|
281
281
|
const gteSmallConfig = {
|
|
282
282
|
provider: HF_TRANSFORMERS_ONNX,
|
|
@@ -306,7 +306,7 @@ Downloads and prepares AI models for use.
|
|
|
306
306
|
|
|
307
307
|
```typescript
|
|
308
308
|
import { DownloadModelTask } from "@workglow/ai";
|
|
309
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
309
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
310
310
|
|
|
311
311
|
const task = new DownloadModelTask({
|
|
312
312
|
model: {
|
|
@@ -380,7 +380,7 @@ setGlobalModelRepository(modelRepo);
|
|
|
380
380
|
|
|
381
381
|
```typescript
|
|
382
382
|
import { getGlobalModelRepository } from "@workglow/ai";
|
|
383
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
383
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
384
384
|
|
|
385
385
|
const modelRepo = getGlobalModelRepository();
|
|
386
386
|
|
|
@@ -417,7 +417,7 @@ AI providers handle the actual execution of AI tasks. You need to register provi
|
|
|
417
417
|
### Basic Provider Registration
|
|
418
418
|
|
|
419
419
|
```typescript
|
|
420
|
-
import { registerHuggingFaceTransformersInline } from "@workglow/
|
|
420
|
+
import { registerHuggingFaceTransformersInline } from "@workglow/huggingface-transformers/ai-runtime";
|
|
421
421
|
|
|
422
422
|
// Inline: run functions registered on the current thread (tasks wired inside the provider)
|
|
423
423
|
await registerHuggingFaceTransformersInline();
|
|
@@ -428,12 +428,12 @@ await registerHuggingFaceTransformersInline();
|
|
|
428
428
|
For compute-intensive tasks that should run in workers:
|
|
429
429
|
|
|
430
430
|
```typescript
|
|
431
|
-
import { registerHuggingFaceTransformers } from "@workglow/
|
|
431
|
+
import { registerHuggingFaceTransformers } from "@workglow/huggingface-transformers/ai";
|
|
432
432
|
|
|
433
433
|
await registerHuggingFaceTransformers({
|
|
434
434
|
worker: () => new Worker(new URL("./worker_hft.ts", import.meta.url), { type: "module" }),
|
|
435
435
|
});
|
|
436
|
-
// Worker file must call registerHuggingFaceTransformersWorker() from @workglow/
|
|
436
|
+
// Worker file must call registerHuggingFaceTransformersWorker() from @workglow/huggingface-transformers/ai-runtime
|
|
437
437
|
```
|
|
438
438
|
|
|
439
439
|
### Job Queue Setup
|
|
@@ -449,7 +449,7 @@ import {
|
|
|
449
449
|
JobQueueServer,
|
|
450
450
|
} from "@workglow/job-queue";
|
|
451
451
|
import { AiJob, AiJobInput } from "@workglow/ai";
|
|
452
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
452
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
453
453
|
|
|
454
454
|
const queueName = HF_TRANSFORMERS_ONNX;
|
|
455
455
|
const storage = new InMemoryQueueStorage<AiJobInput<TaskInput>, TaskOutput>(queueName);
|
|
@@ -476,7 +476,7 @@ AI tasks integrate seamlessly with Workglow workflows:
|
|
|
476
476
|
|
|
477
477
|
```typescript
|
|
478
478
|
import { Workflow } from "@workglow/task-graph";
|
|
479
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
479
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
480
480
|
|
|
481
481
|
const gpt2ModelConfig = {
|
|
482
482
|
provider: HF_TRANSFORMERS_ONNX,
|
|
@@ -555,7 +555,7 @@ The AI package provides a comprehensive set of tasks for building RAG pipelines.
|
|
|
555
555
|
```typescript
|
|
556
556
|
import { Workflow } from "@workglow/task-graph";
|
|
557
557
|
import { createKnowledgeBase } from "@workglow/knowledge-base";
|
|
558
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
558
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
559
559
|
|
|
560
560
|
// 1. Set up a model repository
|
|
561
561
|
const modelRepo = new InMemoryModelRepository();
|
|
@@ -713,7 +713,7 @@ AI tasks accept model inputs as either string identifiers or direct `ModelConfig
|
|
|
713
713
|
|
|
714
714
|
```typescript
|
|
715
715
|
import { TextGenerationTask } from "@workglow/ai";
|
|
716
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
716
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
717
717
|
|
|
718
718
|
const gpt2ModelConfig = {
|
|
719
719
|
provider: HF_TRANSFORMERS_ONNX,
|
|
@@ -752,7 +752,7 @@ Tasks automatically validate that specified models exist and are compatible:
|
|
|
752
752
|
|
|
753
753
|
```typescript
|
|
754
754
|
import { TextGenerationTask } from "@workglow/ai";
|
|
755
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
755
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
756
756
|
|
|
757
757
|
const gpt2ModelConfig = {
|
|
758
758
|
provider: HF_TRANSFORMERS_ONNX,
|
|
@@ -778,7 +778,7 @@ Monitor AI task progress:
|
|
|
778
778
|
|
|
779
779
|
```typescript
|
|
780
780
|
import { TextGenerationTask } from "@workglow/ai";
|
|
781
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
781
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
782
782
|
|
|
783
783
|
const gpt2ModelConfig = {
|
|
784
784
|
provider: HF_TRANSFORMERS_ONNX,
|
|
@@ -807,7 +807,7 @@ All AI tasks support cancellation via AbortSignal:
|
|
|
807
807
|
|
|
808
808
|
```typescript
|
|
809
809
|
import { TextGenerationTask } from "@workglow/ai";
|
|
810
|
-
import { HF_TRANSFORMERS_ONNX } from "@workglow/
|
|
810
|
+
import { HF_TRANSFORMERS_ONNX } from "@workglow/huggingface-transformers/ai";
|
|
811
811
|
|
|
812
812
|
const gpt2ModelConfig = {
|
|
813
813
|
provider: HF_TRANSFORMERS_ONNX,
|