@huggingface/inference 3.13.2 → 3.14.0

package/dist/esm/tasks/custom/request.d.ts

@@ -0,0 +1,10 @@
+import type { InferenceTask, Options, RequestArgs } from "../../types.js";
+/**
+ * Primitive to make custom calls to the inference provider
+ * @deprecated Use specific task functions instead. This function will be removed in a future version.
+ */
+export declare function request<T>(args: RequestArgs, options?: Options & {
+    /** In most cases (unless we pass a endpointUrl) we know the task */
+    task?: InferenceTask;
+}): Promise<T>;
+//# sourceMappingURL=request.d.ts.map

package/dist/esm/tasks/custom/request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../../src/tasks/custom/request.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG1E;;;GAGG;AACH,wBAAsB,OAAO,CAAC,CAAC,EAC9B,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,OAAO,GAAG;IACnB,oEAAoE;IACpE,IAAI,CAAC,EAAE,aAAa,CAAC;CACrB,GACC,OAAO,CAAC,CAAC,CAAC,CAQZ"}

package/dist/esm/tasks/custom/request.js

@@ -0,0 +1,14 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { innerRequest } from "../../utils/request.js";
+/**
+ * Primitive to make custom calls to the inference provider
+ * @deprecated Use specific task functions instead. This function will be removed in a future version.
+ */
+export async function request(args, options) {
+    console.warn("The request method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead.");
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, options?.task);
+    const result = await innerRequest(args, providerHelper, options);
+    return result.data;
+}

package/dist/esm/tasks/custom/streamingRequest.d.ts

@@ -0,0 +1,10 @@
+import type { InferenceTask, Options, RequestArgs } from "../../types.js";
+/**
+ * Primitive to make custom inference calls that expect server-sent events, and returns the response through a generator
+ * @deprecated Use specific task functions instead. This function will be removed in a future version.
+ */
+export declare function streamingRequest<T>(args: RequestArgs, options?: Options & {
+    /** In most cases (unless we pass a endpointUrl) we know the task */
+    task?: InferenceTask;
+}): AsyncGenerator<T>;
+//# sourceMappingURL=streamingRequest.d.ts.map

package/dist/esm/tasks/custom/streamingRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamingRequest.d.ts","sourceRoot":"","sources":["../../../../src/tasks/custom/streamingRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG1E;;;GAGG;AACH,wBAAuB,gBAAgB,CAAC,CAAC,EACxC,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,OAAO,GAAG;IACnB,oEAAoE;IACpE,IAAI,CAAC,EAAE,aAAa,CAAC;CACrB,GACC,cAAc,CAAC,CAAC,CAAC,CAOnB"}

package/dist/esm/tasks/custom/streamingRequest.js

@@ -0,0 +1,13 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { innerStreamingRequest } from "../../utils/request.js";
+/**
+ * Primitive to make custom inference calls that expect server-sent events, and returns the response through a generator
+ * @deprecated Use specific task functions instead. This function will be removed in a future version.
+ */
+export async function* streamingRequest(args, options) {
+    console.warn("The streamingRequest method is deprecated and will be removed in a future version of huggingface.js. Use specific task functions instead.");
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, options?.task);
+    yield* innerStreamingRequest(args, providerHelper, options);
+}

package/dist/esm/tasks/cv/imageClassification.d.ts

@@ -0,0 +1,10 @@
+import type { ImageClassificationInput, ImageClassificationOutput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+import { type LegacyImageInput } from "./utils.js";
+export type ImageClassificationArgs = BaseArgs & (ImageClassificationInput | LegacyImageInput);
+/**
+ * This task reads some image input and outputs the likelihood of classes.
+ * Recommended model: google/vit-base-patch16-224
+ */
+export declare function imageClassification(args: ImageClassificationArgs, options?: Options): Promise<ImageClassificationOutput>;
+//# sourceMappingURL=imageClassification.d.ts.map

package/dist/esm/tasks/cv/imageClassification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"imageClassification.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/imageClassification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAG9F,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAkB,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,QAAQ,GAAG,CAAC,wBAAwB,GAAG,gBAAgB,CAAC,CAAC;AAE/F;;;GAGG;AACH,wBAAsB,mBAAmB,CACxC,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,yBAAyB,CAAC,CASpC"}

package/dist/esm/tasks/cv/imageClassification.js

@@ -0,0 +1,18 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { innerRequest } from "../../utils/request.js";
+import { preparePayload } from "./utils.js";
+/**
+ * This task reads some image input and outputs the likelihood of classes.
+ * Recommended model: google/vit-base-patch16-224
+ */
+export async function imageClassification(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "image-classification");
+    const payload = preparePayload(args);
+    const { data: res } = await innerRequest(payload, providerHelper, {
+        ...options,
+        task: "image-classification",
+    });
+    return providerHelper.getResponse(res);
+}

package/dist/esm/tasks/cv/imageSegmentation.d.ts

@@ -0,0 +1,10 @@
+import type { ImageSegmentationInput, ImageSegmentationOutput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+import { type LegacyImageInput } from "./utils.js";
+export type ImageSegmentationArgs = BaseArgs & (ImageSegmentationInput | LegacyImageInput);
+/**
+ * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
+ * Recommended model: facebook/detr-resnet-50-panoptic
+ */
+export declare function imageSegmentation(args: ImageSegmentationArgs, options?: Options): Promise<ImageSegmentationOutput>;
+//# sourceMappingURL=imageSegmentation.d.ts.map

package/dist/esm/tasks/cv/imageSegmentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"imageSegmentation.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/imageSegmentation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAG1F,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAkB,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnE,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG,CAAC,sBAAsB,GAAG,gBAAgB,CAAC,CAAC;AAE3F;;;GAGG;AACH,wBAAsB,iBAAiB,CACtC,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CASlC"}

package/dist/esm/tasks/cv/imageSegmentation.js

@@ -0,0 +1,18 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { innerRequest } from "../../utils/request.js";
+import { preparePayload } from "./utils.js";
+/**
+ * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
+ * Recommended model: facebook/detr-resnet-50-panoptic
+ */
+export async function imageSegmentation(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "image-segmentation");
+    const payload = preparePayload(args);
+    const { data: res } = await innerRequest(payload, providerHelper, {
+        ...options,
+        task: "image-segmentation",
+    });
+    return providerHelper.getResponse(res);
+}

package/dist/esm/tasks/cv/imageToImage.d.ts

@@ -0,0 +1,9 @@
+import type { ImageToImageInput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+export type ImageToImageArgs = BaseArgs & ImageToImageInput;
+/**
+ * This task reads some text input and outputs an image.
+ * Recommended model: lllyasviel/sd-controlnet-depth
+ */
+export declare function imageToImage(args: ImageToImageArgs, options?: Options): Promise<Blob>;
+//# sourceMappingURL=imageToImage.d.ts.map

package/dist/esm/tasks/cv/imageToImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"imageToImage.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/imageToImage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAG5D,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGxD,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,iBAAiB,CAAC;AAE5D;;;GAGG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAS3F"}

package/dist/esm/tasks/cv/imageToImage.js

@@ -0,0 +1,17 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { innerRequest } from "../../utils/request.js";
+/**
+ * This task reads some text input and outputs an image.
+ * Recommended model: lllyasviel/sd-controlnet-depth
+ */
+export async function imageToImage(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "image-to-image");
+    const payload = await providerHelper.preparePayloadAsync(args);
+    const { data: res } = await innerRequest(payload, providerHelper, {
+        ...options,
+        task: "image-to-image",
+    });
+    return providerHelper.getResponse(res);
+}

package/dist/esm/tasks/cv/imageToText.d.ts

@@ -0,0 +1,9 @@
+import type { ImageToTextInput, ImageToTextOutput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+import type { LegacyImageInput } from "./utils.js";
+export type ImageToTextArgs = BaseArgs & (ImageToTextInput | LegacyImageInput);
+/**
+ * This task reads some image input and outputs the text caption.
+ */
+export declare function imageToText(args: ImageToTextArgs, options?: Options): Promise<ImageToTextOutput>;
+//# sourceMappingURL=imageToText.d.ts.map

package/dist/esm/tasks/cv/imageToText.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"imageToText.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/imageToText.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAG9E,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAGnD,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,CAAC;AAC/E;;GAEG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAUtG"}

package/dist/esm/tasks/cv/imageToText.js

@@ -0,0 +1,17 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { innerRequest } from "../../utils/request.js";
+import { preparePayload } from "./utils.js";
+/**
+ * This task reads some image input and outputs the text caption.
+ */
+export async function imageToText(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "image-to-text");
+    const payload = preparePayload(args);
+    const { data: res } = await innerRequest(payload, providerHelper, {
+        ...options,
+        task: "image-to-text",
+    });
+    return providerHelper.getResponse(res[0]);
+}

package/dist/esm/tasks/cv/objectDetection.d.ts

@@ -0,0 +1,10 @@
+import type { ObjectDetectionInput, ObjectDetectionOutput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+import { type LegacyImageInput } from "./utils.js";
+export type ObjectDetectionArgs = BaseArgs & (ObjectDetectionInput | LegacyImageInput);
+/**
+ * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
+ * Recommended model: facebook/detr-resnet-50
+ */
+export declare function objectDetection(args: ObjectDetectionArgs, options?: Options): Promise<ObjectDetectionOutput>;
+//# sourceMappingURL=objectDetection.d.ts.map

package/dist/esm/tasks/cv/objectDetection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"objectDetection.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/objectDetection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAGtF,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAkB,KAAK,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnE,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,CAAC;AAEvF;;;GAGG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,qBAAqB,CAAC,CASlH"}

package/dist/esm/tasks/cv/objectDetection.js

@@ -0,0 +1,18 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { innerRequest } from "../../utils/request.js";
+import { preparePayload } from "./utils.js";
+/**
+ * This task reads some image input and outputs the likelihood of classes & bounding boxes of detected objects.
+ * Recommended model: facebook/detr-resnet-50
+ */
+export async function objectDetection(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "object-detection");
+    const payload = preparePayload(args);
+    const { data: res } = await innerRequest(payload, providerHelper, {
+        ...options,
+        task: "object-detection",
+    });
+    return providerHelper.getResponse(res);
+}

package/dist/esm/tasks/cv/textToImage.d.ts

@@ -0,0 +1,18 @@
+import type { TextToImageInput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+export type TextToImageArgs = BaseArgs & TextToImageInput;
+interface TextToImageOptions extends Options {
+    outputType?: "url" | "blob";
+}
+/**
+ * This task reads some text input and outputs an image.
+ * Recommended model: stabilityai/stable-diffusion-2
+ */
+export declare function textToImage(args: TextToImageArgs, options?: TextToImageOptions & {
+    outputType: "url";
+}): Promise<string>;
+export declare function textToImage(args: TextToImageArgs, options?: TextToImageOptions & {
+    outputType?: undefined | "blob";
+}): Promise<Blob>;
+export {};
+//# sourceMappingURL=textToImage.d.ts.map

package/dist/esm/tasks/cv/textToImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textToImage.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/textToImage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAI3D,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGxD,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,gBAAgB,CAAC;AAE1D,UAAU,kBAAmB,SAAQ,OAAO;IAC3C,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAChC,IAAI,EAAE,eAAe,EACrB,OAAO,CAAC,EAAE,kBAAkB,GAAG;IAAE,UAAU,EAAE,KAAK,CAAA;CAAE,GAClD,OAAO,CAAC,MAAM,CAAC,CAAC;AACnB,wBAAsB,WAAW,CAChC,IAAI,EAAE,eAAe,EACrB,OAAO,CAAC,EAAE,kBAAkB,GAAG;IAAE,UAAU,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GAChE,OAAO,CAAC,IAAI,CAAC,CAAC"}

package/dist/esm/tasks/cv/textToImage.js

@@ -0,0 +1,14 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { makeRequestOptions } from "../../lib/makeRequestOptions.js";
+import { innerRequest } from "../../utils/request.js";
+export async function textToImage(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "text-to-image");
+    const { data: res } = await innerRequest(args, providerHelper, {
+        ...options,
+        task: "text-to-image",
+    });
+    const { url, info } = await makeRequestOptions(args, providerHelper, { ...options, task: "text-to-image" });
+    return providerHelper.getResponse(res, url, info.headers, options?.outputType);
+}

package/dist/esm/tasks/cv/textToVideo.d.ts

@@ -0,0 +1,6 @@
+import type { TextToVideoInput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+export type TextToVideoArgs = BaseArgs & TextToVideoInput;
+export type TextToVideoOutput = Blob;
+export declare function textToVideo(args: TextToVideoArgs, options?: Options): Promise<TextToVideoOutput>;
+//# sourceMappingURL=textToVideo.d.ts.map

package/dist/esm/tasks/cv/textToVideo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textToVideo.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/textToVideo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAO3D,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGxD,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,gBAAgB,CAAC;AAE1D,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAErC,wBAAsB,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAatG"}

package/dist/esm/tasks/cv/textToVideo.js

@@ -0,0 +1,14 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { makeRequestOptions } from "../../lib/makeRequestOptions.js";
+import { innerRequest } from "../../utils/request.js";
+export async function textToVideo(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "text-to-video");
+    const { data: response } = await innerRequest(args, providerHelper, {
+        ...options,
+        task: "text-to-video",
+    });
+    const { url, info } = await makeRequestOptions(args, providerHelper, { ...options, task: "text-to-video" });
+    return providerHelper.getResponse(response, url, info.headers);
+}

package/dist/esm/tasks/cv/utils.d.ts

@@ -0,0 +1,11 @@
+import type { BaseArgs, RequestArgs } from "../../types.js";
+/**
+ * @deprecated
+ */
+export interface LegacyImageInput {
+    data: Blob | ArrayBuffer;
+}
+export declare function preparePayload(args: BaseArgs & ({
+    inputs: Blob;
+} | LegacyImageInput)): RequestArgs;
+//# sourceMappingURL=utils.d.ts.map

package/dist/esm/tasks/cv/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG5D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,IAAI,GAAG,WAAW,CAAC;CACzB;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,CAAC;IAAE,MAAM,EAAE,IAAI,CAAA;CAAE,GAAG,gBAAgB,CAAC,GAAG,WAAW,CAElG"}

package/dist/esm/tasks/cv/utils.js

@@ -0,0 +1,4 @@
+import { omit } from "../../utils/omit.js";
+export function preparePayload(args) {
+    return "data" in args ? args : { ...omit(args, "inputs"), data: args.inputs };
+}

package/dist/esm/tasks/cv/zeroShotImageClassification.d.ts

@@ -0,0 +1,18 @@
+import type { ZeroShotImageClassificationInput, ZeroShotImageClassificationOutput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+/**
+ * @deprecated
+ */
+interface LegacyZeroShotImageClassificationInput {
+    inputs: {
+        image: Blob | ArrayBuffer;
+    };
+}
+export type ZeroShotImageClassificationArgs = BaseArgs & (ZeroShotImageClassificationInput | LegacyZeroShotImageClassificationInput);
+/**
+ * Classify an image to specified classes.
+ * Recommended model: openai/clip-vit-large-patch14-336
+ */
+export declare function zeroShotImageClassification(args: ZeroShotImageClassificationArgs, options?: Options): Promise<ZeroShotImageClassificationOutput>;
+export {};
+//# sourceMappingURL=zeroShotImageClassification.d.ts.map

package/dist/esm/tasks/cv/zeroShotImageClassification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zeroShotImageClassification.d.ts","sourceRoot":"","sources":["../../../../src/tasks/cv/zeroShotImageClassification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gCAAgC,EAAE,iCAAiC,EAAE,MAAM,oBAAoB,CAAC;AAG9G,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAe,MAAM,gBAAgB,CAAC;AAIrE;;GAEG;AACH,UAAU,sCAAsC;IAC/C,MAAM,EAAE;QAAE,KAAK,EAAE,IAAI,GAAG,WAAW,CAAA;KAAE,CAAC;CACtC;AAED,MAAM,MAAM,+BAA+B,GAAG,QAAQ,GACrD,CAAC,gCAAgC,GAAG,sCAAsC,CAAC,CAAC;AAwB7E;;;GAGG;AACH,wBAAsB,2BAA2B,CAChD,IAAI,EAAE,+BAA+B,EACrC,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,iCAAiC,CAAC,CAS5C"}

package/dist/esm/tasks/cv/zeroShotImageClassification.js

@@ -0,0 +1,36 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { base64FromBytes } from "../../utils/base64FromBytes.js";
+import { innerRequest } from "../../utils/request.js";
+async function preparePayload(args) {
+    if (args.inputs instanceof Blob) {
+        return {
+            ...args,
+            inputs: {
+                image: base64FromBytes(new Uint8Array(await args.inputs.arrayBuffer())),
+            },
+        };
+    }
+    else {
+        return {
+            ...args,
+            inputs: {
+                image: base64FromBytes(new Uint8Array(args.inputs.image instanceof ArrayBuffer ? args.inputs.image : await args.inputs.image.arrayBuffer())),
+            },
+        };
+    }
+}
+/**
+ * Classify an image to specified classes.
+ * Recommended model: openai/clip-vit-large-patch14-336
+ */
+export async function zeroShotImageClassification(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "zero-shot-image-classification");
+    const payload = await preparePayload(args);
+    const { data: res } = await innerRequest(payload, providerHelper, {
+        ...options,
+        task: "zero-shot-image-classification",
+    });
+    return providerHelper.getResponse(res);
+}

package/dist/esm/tasks/index.d.ts

@@ -0,0 +1,33 @@
+export * from "./custom/request.js";
+export * from "./custom/streamingRequest.js";
+export * from "./audio/audioClassification.js";
+export * from "./audio/audioToAudio.js";
+export * from "./audio/automaticSpeechRecognition.js";
+export * from "./audio/textToSpeech.js";
+export * from "./cv/imageClassification.js";
+export * from "./cv/imageSegmentation.js";
+export * from "./cv/imageToImage.js";
+export * from "./cv/imageToText.js";
+export * from "./cv/objectDetection.js";
+export * from "./cv/textToImage.js";
+export * from "./cv/textToVideo.js";
+export * from "./cv/zeroShotImageClassification.js";
+export * from "./nlp/chatCompletion.js";
+export * from "./nlp/chatCompletionStream.js";
+export * from "./nlp/featureExtraction.js";
+export * from "./nlp/fillMask.js";
+export * from "./nlp/questionAnswering.js";
+export * from "./nlp/sentenceSimilarity.js";
+export * from "./nlp/summarization.js";
+export * from "./nlp/tableQuestionAnswering.js";
+export * from "./nlp/textClassification.js";
+export * from "./nlp/textGeneration.js";
+export * from "./nlp/textGenerationStream.js";
+export * from "./nlp/tokenClassification.js";
+export * from "./nlp/translation.js";
+export * from "./nlp/zeroShotClassification.js";
+export * from "./multimodal/documentQuestionAnswering.js";
+export * from "./multimodal/visualQuestionAnswering.js";
+export * from "./tabular/tabularClassification.js";
+export * from "./tabular/tabularRegression.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/tasks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tasks/index.ts"],"names":[],"mappings":"AACA,cAAc,qBAAqB,CAAC;AACpC,cAAc,8BAA8B,CAAC;AAG7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC;AACxC,cAAc,uCAAuC,CAAC;AACtD,cAAc,yBAAyB,CAAC;AAGxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,qCAAqC,CAAC;AAGpD,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sBAAsB,CAAC;AACrC,cAAc,iCAAiC,CAAC;AAGhD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yCAAyC,CAAC;AAGxD,cAAc,oCAAoC,CAAC;AACnD,cAAc,gCAAgC,CAAC"}

package/dist/esm/tasks/index.js

@@ -0,0 +1,38 @@
+// Custom tasks with arbitrary inputs and outputs
+export * from "./custom/request.js";
+export * from "./custom/streamingRequest.js";
+// Audio tasks
+export * from "./audio/audioClassification.js";
+export * from "./audio/audioToAudio.js";
+export * from "./audio/automaticSpeechRecognition.js";
+export * from "./audio/textToSpeech.js";
+// Computer Vision tasks
+export * from "./cv/imageClassification.js";
+export * from "./cv/imageSegmentation.js";
+export * from "./cv/imageToImage.js";
+export * from "./cv/imageToText.js";
+export * from "./cv/objectDetection.js";
+export * from "./cv/textToImage.js";
+export * from "./cv/textToVideo.js";
+export * from "./cv/zeroShotImageClassification.js";
+// Natural Language Processing tasks
+export * from "./nlp/chatCompletion.js";
+export * from "./nlp/chatCompletionStream.js";
+export * from "./nlp/featureExtraction.js";
+export * from "./nlp/fillMask.js";
+export * from "./nlp/questionAnswering.js";
+export * from "./nlp/sentenceSimilarity.js";
+export * from "./nlp/summarization.js";
+export * from "./nlp/tableQuestionAnswering.js";
+export * from "./nlp/textClassification.js";
+export * from "./nlp/textGeneration.js";
+export * from "./nlp/textGenerationStream.js";
+export * from "./nlp/tokenClassification.js";
+export * from "./nlp/translation.js";
+export * from "./nlp/zeroShotClassification.js";
+// Multimodal tasks
+export * from "./multimodal/documentQuestionAnswering.js";
+export * from "./multimodal/visualQuestionAnswering.js";
+// Tabular tasks
+export * from "./tabular/tabularClassification.js";
+export * from "./tabular/tabularRegression.js";

package/dist/esm/tasks/multimodal/documentQuestionAnswering.d.ts

@@ -0,0 +1,12 @@
+import type { DocumentQuestionAnsweringInput, DocumentQuestionAnsweringInputData, DocumentQuestionAnsweringOutput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+export type DocumentQuestionAnsweringArgs = BaseArgs & DocumentQuestionAnsweringInput & {
+    inputs: DocumentQuestionAnsweringInputData & {
+        image: Blob;
+    };
+};
+/**
+ * Answers a question on a document image. Recommended model: impira/layoutlm-document-qa.
+ */
+export declare function documentQuestionAnswering(args: DocumentQuestionAnsweringArgs, options?: Options): Promise<DocumentQuestionAnsweringOutput[number]>;
+//# sourceMappingURL=documentQuestionAnswering.d.ts.map

package/dist/esm/tasks/multimodal/documentQuestionAnswering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentQuestionAnswering.d.ts","sourceRoot":"","sources":["../../../../src/tasks/multimodal/documentQuestionAnswering.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,8BAA8B,EAC9B,kCAAkC,EAClC,+BAA+B,EAC/B,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAe,MAAM,gBAAgB,CAAC;AAKrE,MAAM,MAAM,6BAA6B,GAAG,QAAQ,GACnD,8BAA8B,GAAG;IAAE,MAAM,EAAE,kCAAkC,GAAG;QAAE,KAAK,EAAE,IAAI,CAAA;KAAE,CAAA;CAAE,CAAC;AAEnG;;GAEG;AACH,wBAAsB,yBAAyB,CAC9C,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC,CAoBlD"}

package/dist/esm/tasks/multimodal/documentQuestionAnswering.js

@@ -0,0 +1,24 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { base64FromBytes } from "../../utils/base64FromBytes.js";
+import { innerRequest } from "../../utils/request.js";
+/**
+ * Answers a question on a document image. Recommended model: impira/layoutlm-document-qa.
+ */
+export async function documentQuestionAnswering(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "document-question-answering");
+    const reqArgs = {
+        ...args,
+        inputs: {
+            question: args.inputs.question,
+            // convert Blob or ArrayBuffer to base64
+            image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer())),
+        },
+    };
+    const { data: res } = await innerRequest(reqArgs, providerHelper, {
+        ...options,
+        task: "document-question-answering",
+    });
+    return providerHelper.getResponse(res);
+}

package/dist/esm/tasks/multimodal/visualQuestionAnswering.d.ts

@@ -0,0 +1,12 @@
+import type { VisualQuestionAnsweringInput, VisualQuestionAnsweringInputData, VisualQuestionAnsweringOutput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+export type VisualQuestionAnsweringArgs = BaseArgs & VisualQuestionAnsweringInput & {
+    inputs: VisualQuestionAnsweringInputData & {
+        image: Blob;
+    };
+};
+/**
+ * Answers a question on an image. Recommended model: dandelin/vilt-b32-finetuned-vqa.
+ */
+export declare function visualQuestionAnswering(args: VisualQuestionAnsweringArgs, options?: Options): Promise<VisualQuestionAnsweringOutput[number]>;
+//# sourceMappingURL=visualQuestionAnswering.d.ts.map

package/dist/esm/tasks/multimodal/visualQuestionAnswering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visualQuestionAnswering.d.ts","sourceRoot":"","sources":["../../../../src/tasks/multimodal/visualQuestionAnswering.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,4BAA4B,EAC5B,gCAAgC,EAChC,6BAA6B,EAC7B,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAe,MAAM,gBAAgB,CAAC;AAKrE,MAAM,MAAM,2BAA2B,GAAG,QAAQ,GACjD,4BAA4B,GAAG;IAAE,MAAM,EAAE,gCAAgC,GAAG;QAAE,KAAK,EAAE,IAAI,CAAA;KAAE,CAAA;CAAE,CAAC;AAE/F;;GAEG;AACH,wBAAsB,uBAAuB,CAC5C,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,6BAA6B,CAAC,MAAM,CAAC,CAAC,CAiBhD"}

package/dist/esm/tasks/multimodal/visualQuestionAnswering.js

@@ -0,0 +1,24 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { base64FromBytes } from "../../utils/base64FromBytes.js";
+import { innerRequest } from "../../utils/request.js";
+/**
+ * Answers a question on an image. Recommended model: dandelin/vilt-b32-finetuned-vqa.
+ */
+export async function visualQuestionAnswering(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "visual-question-answering");
+    const reqArgs = {
+        ...args,
+        inputs: {
+            question: args.inputs.question,
+            // convert Blob or ArrayBuffer to base64
+            image: base64FromBytes(new Uint8Array(await args.inputs.image.arrayBuffer())),
+        },
+    };
+    const { data: res } = await innerRequest(reqArgs, providerHelper, {
+        ...options,
+        task: "visual-question-answering",
+    });
+    return providerHelper.getResponse(res);
+}

package/dist/esm/tasks/nlp/chatCompletion.d.ts

@@ -0,0 +1,7 @@
+import type { ChatCompletionInput, ChatCompletionOutput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+/**
+ * Use the chat completion endpoint to generate a response to a prompt, using OpenAI message completion API no stream
+ */
+export declare function chatCompletion(args: BaseArgs & ChatCompletionInput, options?: Options): Promise<ChatCompletionOutput>;
+//# sourceMappingURL=chatCompletion.d.ts.map

package/dist/esm/tasks/nlp/chatCompletion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chatCompletion.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/chatCompletion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAGpF,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGxD;;GAEG;AACH,wBAAsB,cAAc,CACnC,IAAI,EAAE,QAAQ,GAAG,mBAAmB,EACpC,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,oBAAoB,CAAC,CAQ/B"}

package/dist/esm/tasks/nlp/chatCompletion.js

@@ -0,0 +1,15 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { innerRequest } from "../../utils/request.js";
+/**
+ * Use the chat completion endpoint to generate a response to a prompt, using OpenAI message completion API no stream
+ */
+export async function chatCompletion(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "conversational");
+    const { data: response } = await innerRequest(args, providerHelper, {
+        ...options,
+        task: "conversational",
+    });
+    return providerHelper.getResponse(response);
+}

package/dist/esm/tasks/nlp/chatCompletionStream.d.ts

@@ -0,0 +1,7 @@
+import type { ChatCompletionInput, ChatCompletionStreamOutput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types.js";
+/**
+ * Use to continue text from a prompt. Same as `textGeneration` but returns generator that can be read one token at a time
+ */
+export declare function chatCompletionStream(args: BaseArgs & ChatCompletionInput, options?: Options): AsyncGenerator<ChatCompletionStreamOutput>;
+//# sourceMappingURL=chatCompletionStream.d.ts.map

package/dist/esm/tasks/nlp/chatCompletionStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chatCompletionStream.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/chatCompletionStream.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAG1F,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGxD;;GAEG;AACH,wBAAuB,oBAAoB,CAC1C,IAAI,EAAE,QAAQ,GAAG,mBAAmB,EACpC,OAAO,CAAC,EAAE,OAAO,GACf,cAAc,CAAC,0BAA0B,CAAC,CAO5C"}

package/dist/esm/tasks/nlp/chatCompletionStream.js

@@ -0,0 +1,14 @@
+import { resolveProvider } from "../../lib/getInferenceProviderMapping.js";
+import { getProviderHelper } from "../../lib/getProviderHelper.js";
+import { innerStreamingRequest } from "../../utils/request.js";
+/**
+ * Use to continue text from a prompt. Same as `textGeneration` but returns generator that can be read one token at a time
+ */
+export async function* chatCompletionStream(args, options) {
+    const provider = await resolveProvider(args.provider, args.model, args.endpointUrl);
+    const providerHelper = getProviderHelper(provider, "conversational");
+    yield* innerStreamingRequest(args, providerHelper, {
+        ...options,
+        task: "conversational",
+    });
+}