@workglow/ai 0.0.71 → 0.0.73

package/dist/task/ImageClassificationTask.d.ts

@@ -0,0 +1,410 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { CreateWorkflow, JobQueueTaskConfig } from "@workglow/task-graph";
+import { DataPortSchema, FromSchema } from "@workglow/util";
+import { DeReplicateFromSchema } from "./base/AiTaskSchemas";
+import { AiVisionTask } from "./base/AiVisionTask";
+export declare const ImageClassificationInputSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly image: {
+            readonly "x-replicate": true;
+            readonly format?: string | undefined;
+            readonly oneOf: readonly [{
+                readonly oneOf: readonly [{
+                    readonly type: "string";
+                    readonly title: "Image Data";
+                    readonly description: "Image as data-uri";
+                }, {
+                    readonly type: "object";
+                    readonly additionalProperties: false;
+                    readonly properties: {
+                        readonly data: {
+                            readonly oneOf: readonly [{
+                                readonly type: "object";
+                                readonly format: "image:ImageBitmap";
+                                readonly title: "ImageBitmap";
+                            }, {
+                                readonly type: "object";
+                                readonly format: "image:OffscreenCanvas";
+                                readonly title: "OffscreenCanvas";
+                            }, {
+                                readonly type: "object";
+                                readonly format: "image:VideoFrame";
+                                readonly title: "VideoFrame";
+                            }, {
+                                readonly type: "object";
+                                readonly properties: {
+                                    readonly data: {
+                                        readonly type: "array";
+                                        readonly items: {
+                                            readonly type: "number";
+                                            readonly format: "Uint8Clamped";
+                                        };
+                                        readonly format: "Uint8ClampedArray";
+                                        readonly title: "Data";
+                                        readonly description: "Data of the image";
+                                    };
+                                    readonly width: {
+                                        readonly type: "number";
+                                        readonly title: "Width";
+                                        readonly description: "Width of the image";
+                                    };
+                                    readonly height: {
+                                        readonly type: "number";
+                                        readonly title: "Height";
+                                        readonly description: "Height of the image";
+                                    };
+                                    readonly channels: {
+                                        readonly type: "number";
+                                        readonly title: "Channels";
+                                        readonly description: "Channels of the image";
+                                    };
+                                    readonly rawChannels: {
+                                        readonly type: "number";
+                                        readonly title: "Raw Channels";
+                                        readonly description: "Raw channels of the image";
+                                    };
+                                };
+                                readonly additionalProperties: false;
+                                readonly required: readonly ["data", "width", "height", "channels"];
+                                readonly format: "image:ImageBinary";
+                                readonly title: "ImageBinary";
+                            }];
+                        };
+                        readonly width: {
+                            readonly type: "number";
+                            readonly title: "Width";
+                            readonly description: "Width of the image";
+                        };
+                        readonly height: {
+                            readonly type: "number";
+                            readonly title: "Height";
+                            readonly description: "Height of the image";
+                        };
+                        readonly channels: {
+                            readonly type: "number";
+                            readonly title: "Channels";
+                            readonly description: "Channels of the image";
+                            readonly minimum: 1;
+                            readonly maximum: 4;
+                        };
+                    };
+                    readonly required: readonly ["data", "width", "height", "channels"];
+                }];
+                readonly title: "Image";
+                readonly description: "Image as URL or base64-encoded data";
+            }, {
+                readonly type: "array";
+                readonly items: {
+                    readonly oneOf: readonly [{
+                        readonly type: "string";
+                        readonly title: "Image Data";
+                        readonly description: "Image as data-uri";
+                    }, {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly data: {
+                                readonly oneOf: readonly [{
+                                    readonly type: "object";
+                                    readonly format: "image:ImageBitmap";
+                                    readonly title: "ImageBitmap";
+                                }, {
+                                    readonly type: "object";
+                                    readonly format: "image:OffscreenCanvas";
+                                    readonly title: "OffscreenCanvas";
+                                }, {
+                                    readonly type: "object";
+                                    readonly format: "image:VideoFrame";
+                                    readonly title: "VideoFrame";
+                                }, {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly data: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "number";
+                                                readonly format: "Uint8Clamped";
+                                            };
+                                            readonly format: "Uint8ClampedArray";
+                                            readonly title: "Data";
+                                            readonly description: "Data of the image";
+                                        };
+                                        readonly width: {
+                                            readonly type: "number";
+                                            readonly title: "Width";
+                                            readonly description: "Width of the image";
+                                        };
+                                        readonly height: {
+                                            readonly type: "number";
+                                            readonly title: "Height";
+                                            readonly description: "Height of the image";
+                                        };
+                                        readonly channels: {
+                                            readonly type: "number";
+                                            readonly title: "Channels";
+                                            readonly description: "Channels of the image";
+                                        };
+                                        readonly rawChannels: {
+                                            readonly type: "number";
+                                            readonly title: "Raw Channels";
+                                            readonly description: "Raw channels of the image";
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                    readonly required: readonly ["data", "width", "height", "channels"];
+                                    readonly format: "image:ImageBinary";
+                                    readonly title: "ImageBinary";
+                                }];
+                            };
+                            readonly width: {
+                                readonly type: "number";
+                                readonly title: "Width";
+                                readonly description: "Width of the image";
+                            };
+                            readonly height: {
+                                readonly type: "number";
+                                readonly title: "Height";
+                                readonly description: "Height of the image";
+                            };
+                            readonly channels: {
+                                readonly type: "number";
+                                readonly title: "Channels";
+                                readonly description: "Channels of the image";
+                                readonly minimum: 1;
+                                readonly maximum: 4;
+                            };
+                        };
+                        readonly required: readonly ["data", "width", "height", "channels"];
+                    }];
+                    readonly title: "Image";
+                    readonly description: "Image as URL or base64-encoded data";
+                };
+            }];
+            readonly title: string | undefined;
+            readonly description: string | undefined;
+        };
+        readonly model: {
+            readonly "x-replicate": true;
+            readonly format?: string | undefined;
+            readonly oneOf: readonly [{
+                readonly oneOf: readonly [{
+                    readonly title: "Model";
+                    readonly description: `The model ${string}`;
+                } & {
+                    readonly format: import(".").TypeModelSemantic;
+                    readonly type: "string";
+                }, {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly model_id: {
+                            readonly type: "string";
+                        };
+                        readonly tasks: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly title: {
+                            readonly type: "string";
+                        };
+                        readonly description: {
+                            readonly type: "string";
+                        };
+                        readonly provider: {
+                            readonly type: "string";
+                        };
+                        readonly providerConfig: {
+                            readonly type: "object";
+                            readonly default: {};
+                        };
+                        readonly metadata: {
+                            readonly type: "object";
+                            readonly default: {};
+                        };
+                    };
+                    readonly required: readonly ["model_id", "tasks", "provider", "title", "description", "providerConfig", "metadata"];
+                    readonly format: "model";
+                    readonly additionalProperties: false;
+                } & {
+                    readonly format: import(".").TypeModelSemantic;
+                }];
+            } & {
+                readonly format: import(".").TypeModelSemantic;
+            }, {
+                readonly type: "array";
+                readonly items: {
+                    readonly oneOf: readonly [{
+                        readonly title: "Model";
+                        readonly description: `The model ${string}`;
+                    } & {
+                        readonly format: import(".").TypeModelSemantic;
+                        readonly type: "string";
+                    }, {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly model_id: {
+                                readonly type: "string";
+                            };
+                            readonly tasks: {
+                                readonly type: "array";
+                                readonly items: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly title: {
+                                readonly type: "string";
+                            };
+                            readonly description: {
+                                readonly type: "string";
+                            };
+                            readonly provider: {
+                                readonly type: "string";
+                            };
+                            readonly providerConfig: {
+                                readonly type: "object";
+                                readonly default: {};
+                            };
+                            readonly metadata: {
+                                readonly type: "object";
+                                readonly default: {};
+                            };
+                        };
+                        readonly required: readonly ["model_id", "tasks", "provider", "title", "description", "providerConfig", "metadata"];
+                        readonly format: "model";
+                        readonly additionalProperties: false;
+                    } & {
+                        readonly format: import(".").TypeModelSemantic;
+                    }];
+                } & {
+                    readonly format: import(".").TypeModelSemantic;
+                };
+            }];
+            readonly title: string | undefined;
+            readonly description: string | undefined;
+        };
+        readonly categories: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+            readonly title: "Categories";
+            readonly description: "List of candidate categories (optional, if provided uses zero-shot classification)";
+            readonly "x-ui-group": "Configuration";
+        };
+        readonly maxCategories: {
+            readonly type: "number";
+            readonly minimum: 1;
+            readonly maximum: 1000;
+            readonly default: 5;
+            readonly title: "Max Categories";
+            readonly description: "The maximum number of categories to return";
+            readonly "x-ui-group": "Configuration";
+        };
+    };
+    readonly required: readonly ["image", "model"];
+    readonly additionalProperties: false;
+};
+export declare const ImageClassificationOutputSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly categories: {
+            readonly oneOf: readonly [{
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly label: {
+                            readonly type: "string";
+                            readonly title: "Label";
+                            readonly description: "Category label";
+                        };
+                        readonly score: {
+                            readonly type: "number";
+                            readonly title: "Confidence Score";
+                            readonly description: "Confidence score between 0 and 1";
+                            readonly minimum: 0;
+                            readonly maximum: 1;
+                        };
+                    };
+                    readonly required: readonly ["label", "score"];
+                    readonly additionalProperties: false;
+                    readonly title: "Category";
+                    readonly description: "Classification category with label and score";
+                };
+            }, {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly label: {
+                                readonly type: "string";
+                                readonly title: "Label";
+                                readonly description: "Category label";
+                            };
+                            readonly score: {
+                                readonly type: "number";
+                                readonly title: "Confidence Score";
+                                readonly description: "Confidence score between 0 and 1";
+                                readonly minimum: 0;
+                                readonly maximum: 1;
+                            };
+                        };
+                        readonly required: readonly ["label", "score"];
+                        readonly additionalProperties: false;
+                        readonly title: "Category";
+                        readonly description: "Classification category with label and score";
+                    };
+                };
+            }];
+            readonly title: "Categories";
+            readonly description: "The classification categories with their scores";
+        };
+    };
+    readonly required: readonly ["categories"];
+    readonly additionalProperties: false;
+};
+export type ImageClassificationTaskInput = FromSchema<typeof ImageClassificationInputSchema>;
+export type ImageClassificationTaskOutput = FromSchema<typeof ImageClassificationOutputSchema>;
+export type ImageClassificationTaskExecuteInput = DeReplicateFromSchema<typeof ImageClassificationInputSchema>;
+export type ImageClassificationTaskExecuteOutput = DeReplicateFromSchema<typeof ImageClassificationOutputSchema>;
+/**
+ * Classifies images into categories using vision models.
+ * Automatically selects between regular and zero-shot classification based on whether categories are provided.
+ */
+export declare class ImageClassificationTask extends AiVisionTask<ImageClassificationTaskInput, ImageClassificationTaskOutput, JobQueueTaskConfig> {
+    static type: string;
+    static category: string;
+    static title: string;
+    static description: string;
+    static inputSchema(): DataPortSchema;
+    static outputSchema(): DataPortSchema;
+}
+/**
+ * Convenience function to run image classification tasks.
+ * Creates and executes an ImageClassificationTask with the provided input.
+ * @param input The input parameters for image classification (image, model, and optional categories)
+ * @returns Promise resolving to the classification categories with scores
+ */
+export declare const ImageClassification: (input: ImageClassificationTaskInput, config?: JobQueueTaskConfig) => Promise<{
+    categories: {
+        score: number;
+        label: string;
+    }[] | {
+        score: number;
+        label: string;
+    }[][];
+}>;
+declare module "@workglow/task-graph" {
+    interface Workflow {
+        ImageClassification: CreateWorkflow<ImageClassificationTaskInput, ImageClassificationTaskOutput, JobQueueTaskConfig>;
+    }
+}
+//# sourceMappingURL=ImageClassificationTask.d.ts.map

package/dist/task/ImageClassificationTask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImageClassificationTask.d.ts","sourceRoot":"","sources":["../../src/task/ImageClassificationTask.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAA0B,MAAM,sBAAsB,CAAC;AAClG,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EACL,qBAAqB,EAKtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAInD,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BR,CAAC;AAEpC,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAcT,CAAC;AAEpC,MAAM,MAAM,4BAA4B,GAAG,UAAU,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAC7F,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAC/F,MAAM,MAAM,mCAAmC,GAAG,qBAAqB,CACrE,OAAO,8BAA8B,CACtC,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG,qBAAqB,CACtE,OAAO,+BAA+B,CACvC,CAAC;AAEF;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,YAAY,CACvD,4BAA4B,EAC5B,6BAA6B,EAC7B,kBAAkB,CACnB;IACC,OAAc,IAAI,SAA6B;IAC/C,OAAc,QAAQ,SAAqB;IAC3C,OAAc,KAAK,SAA0B;IAC7C,OAAc,WAAW,SACkG;WAC7G,WAAW,IAAI,cAAc;WAG7B,YAAY,IAAI,cAAc;CAG7C;AAID;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAC9B,OAAO,4BAA4B,EACnC,SAAS,kBAAkB;;;;;;;;EAG5B,CAAC;AAEF,OAAO,QAAQ,sBAAsB,CAAC;IACpC,UAAU,QAAQ;QAChB,mBAAmB,EAAE,cAAc,CACjC,4BAA4B,EAC5B,6BAA6B,EAC7B,kBAAkB,CACnB,CAAC;KACH;CACF"}