@huggingface/inference 2.6.7 → 2.7.0

package/dist/src/tasks/nlp/questionAnswering.d.ts

@@ -0,0 +1,30 @@
+import type { BaseArgs, Options } from "../../types";
+export type QuestionAnsweringArgs = BaseArgs & {
+    inputs: {
+        context: string;
+        question: string;
+    };
+};
+export interface QuestionAnsweringOutput {
+    /**
+     * A string that’s the answer within the text.
+     */
+    answer: string;
+    /**
+     * The index (string wise) of the stop of the answer within context.
+     */
+    end: number;
+    /**
+     * A float that represents how likely that the answer is correct
+     */
+    score: number;
+    /**
+     * The index (string wise) of the start of the answer within context.
+     */
+    start: number;
+}
+/**
+ * Want to have a nice know-it-all bot that can answer any question?. Recommended model: deepset/roberta-base-squad2
+ */
+export declare function questionAnswering(args: QuestionAnsweringArgs, options?: Options): Promise<QuestionAnsweringOutput>;
+//# sourceMappingURL=questionAnswering.d.ts.map

package/dist/src/tasks/nlp/questionAnswering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"questionAnswering.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/questionAnswering.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG;IAC9C,MAAM,EAAE;QACP,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;KACjB,CAAC;CACF,CAAC;AAEF,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CACtC,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CAgBlC"}

package/dist/src/tasks/nlp/sentenceSimilarity.d.ts

@@ -0,0 +1,19 @@
+import type { BaseArgs, Options } from "../../types";
+export type SentenceSimilarityArgs = BaseArgs & {
+    /**
+     * The inputs vary based on the model.
+     *
+     * For example when using sentence-transformers/paraphrase-xlm-r-multilingual-v1 the inputs will have a `source_sentence` string and
+     * a `sentences` array of strings
+     */
+    inputs: Record<string, unknown> | Record<string, unknown>[];
+};
+/**
+ * Returned values are a list of floats
+ */
+export type SentenceSimilarityOutput = number[];
+/**
+ * Calculate the semantic similarity between one text and a list of other sentences by comparing their embeddings.
+ */
+export declare function sentenceSimilarity(args: SentenceSimilarityArgs, options?: Options): Promise<SentenceSimilarityOutput>;
+//# sourceMappingURL=sentenceSimilarity.d.ts.map

package/dist/src/tasks/nlp/sentenceSimilarity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentenceSimilarity.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/sentenceSimilarity.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG;IAC/C;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CAC5D,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,EAAE,CAAC;AAEhD;;GAEG;AACH,wBAAsB,kBAAkB,CACvC,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,wBAAwB,CAAC,CAanC"}

package/dist/src/tasks/nlp/summarization.d.ts

@@ -0,0 +1,48 @@
+import type { BaseArgs, Options } from "../../types";
+export type SummarizationArgs = BaseArgs & {
+    /**
+     * A string to be summarized
+     */
+    inputs: string;
+    parameters?: {
+        /**
+         * (Default: None). Integer to define the maximum length in tokens of the output summary.
+         */
+        max_length?: number;
+        /**
+         * (Default: None). Float (0-120.0). The amount of time in seconds that the query should take maximum. Network can cause some overhead so it will be a soft limit.
+         */
+        max_time?: number;
+        /**
+         * (Default: None). Integer to define the minimum length in tokens of the output summary.
+         */
+        min_length?: number;
+        /**
+         * (Default: None). Float (0.0-100.0). The more a token is used within generation the more it is penalized to not be picked in successive generation passes.
+         */
+        repetition_penalty?: number;
+        /**
+         * (Default: 1.0). Float (0.0-100.0). The temperature of the sampling operation. 1 means regular sampling, 0 means always take the highest score, 100.0 is getting closer to uniform probability.
+         */
+        temperature?: number;
+        /**
+         * (Default: None). Integer to define the top tokens considered within the sample operation to create new text.
+         */
+        top_k?: number;
+        /**
+         * (Default: None). Float to define the tokens that are within the sample operation of text generation. Add tokens in the sample for more probable to least probable until the sum of the probabilities is greater than top_p.
+         */
+        top_p?: number;
+    };
+};
+export interface SummarizationOutput {
+    /**
+     * The string after translation
+     */
+    summary_text: string;
+}
+/**
+ * This task is well known to summarize longer text into shorter text. Be careful, some models have a maximum length of input. That means that the summary cannot handle full books for instance. Be careful when choosing your model.
+ */
+export declare function summarization(args: SummarizationArgs, options?: Options): Promise<SummarizationOutput>;
+//# sourceMappingURL=summarization.d.ts.map

package/dist/src/tasks/nlp/summarization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"summarization.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/summarization.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG;IAC1C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE;QACZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACF,CAAC;AAEF,MAAM,WAAW,mBAAmB;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAU5G"}

package/dist/src/tasks/nlp/tableQuestionAnswering.d.ts

@@ -0,0 +1,36 @@
+import type { BaseArgs, Options } from "../../types";
+export type TableQuestionAnsweringArgs = BaseArgs & {
+    inputs: {
+        /**
+         * The query in plain text that you want to ask the table
+         */
+        query: string;
+        /**
+         * A table of data represented as a dict of list where entries are headers and the lists are all the values, all lists must have the same size.
+         */
+        table: Record<string, string[]>;
+    };
+};
+export interface TableQuestionAnsweringOutput {
+    /**
+     * The aggregator used to get the answer
+     */
+    aggregator: string;
+    /**
+     * The plaintext answer
+     */
+    answer: string;
+    /**
+     * A list of coordinates of the cells contents
+     */
+    cells: string[];
+    /**
+     * a list of coordinates of the cells referenced in the answer
+     */
+    coordinates: number[][];
+}
+/**
+ * Don’t know SQL? Don’t want to dive into a large spreadsheet? Ask questions in plain english! Recommended model: google/tapas-base-finetuned-wtq.
+ */
+export declare function tableQuestionAnswering(args: TableQuestionAnsweringArgs, options?: Options): Promise<TableQuestionAnsweringOutput>;
+//# sourceMappingURL=tableQuestionAnswering.d.ts.map

package/dist/src/tasks/nlp/tableQuestionAnswering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableQuestionAnswering.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/tableQuestionAnswering.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,0BAA0B,GAAG,QAAQ,GAAG;IACnD,MAAM,EAAE;QACP;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KAChC,CAAC;CACF,CAAC;AAEF,MAAM,WAAW,4BAA4B;IAC5C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,wBAAsB,sBAAsB,CAC3C,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,4BAA4B,CAAC,CAkBvC"}

package/dist/src/tasks/nlp/textClassification.d.ts

@@ -0,0 +1,22 @@
+import type { BaseArgs, Options } from "../../types";
+export type TextClassificationArgs = BaseArgs & {
+    /**
+     * A string to be classified
+     */
+    inputs: string;
+};
+export type TextClassificationOutput = {
+    /**
+     * The label for the class (model specific)
+     */
+    label: string;
+    /**
+     * A floats that represents how likely is that the text belongs to this class.
+     */
+    score: number;
+}[];
+/**
+ * Usually used for sentiment-analysis this will output the likelihood of classes of an input. Recommended model: distilbert-base-uncased-finetuned-sst-2-english
+ */
+export declare function textClassification(args: TextClassificationArgs, options?: Options): Promise<TextClassificationOutput>;
+//# sourceMappingURL=textClassification.d.ts.map

package/dist/src/tasks/nlp/textClassification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textClassification.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/textClassification.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,sBAAsB,GAAG,QAAQ,GAAG;IAC/C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACd,EAAE,CAAC;AAEJ;;GAEG;AACH,wBAAsB,kBAAkB,CACvC,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,wBAAwB,CAAC,CAanC"}

package/dist/src/tasks/nlp/textGeneration.d.ts

@@ -0,0 +1,8 @@
+import type { TextGenerationInput, TextGenerationOutput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types";
+export type { TextGenerationInput, TextGenerationOutput };
+/**
+ * Use to continue text from a prompt. This is a very generic task. Recommended model: gpt2 (it’s a simple model, but fun to play with).
+ */
+export declare function textGeneration(args: BaseArgs & TextGenerationInput, options?: Options): Promise<TextGenerationOutput>;
+//# sourceMappingURL=textGeneration.d.ts.map

package/dist/src/tasks/nlp/textGeneration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textGeneration.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/textGeneration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAEpF,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,YAAY,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,CAAC;AAE1D;;GAEG;AACH,wBAAsB,cAAc,CACnC,IAAI,EAAE,QAAQ,GAAG,mBAAmB,EACpC,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,oBAAoB,CAAC,CAU/B"}

package/dist/src/tasks/nlp/textGenerationStream.d.ts

@@ -0,0 +1,81 @@
+import type { TextGenerationInput } from "@huggingface/tasks";
+import type { BaseArgs, Options } from "../../types";
+export interface TextGenerationStreamToken {
+    /** Token ID from the model tokenizer */
+    id: number;
+    /** Token text */
+    text: string;
+    /** Logprob */
+    logprob: number;
+    /**
+     * Is the token a special token
+     * Can be used to ignore tokens when concatenating
+     */
+    special: boolean;
+}
+export interface TextGenerationStreamPrefillToken {
+    /** Token ID from the model tokenizer */
+    id: number;
+    /** Token text */
+    text: string;
+    /**
+     * Logprob
+     * Optional since the logprob of the first token cannot be computed
+     */
+    logprob?: number;
+}
+export interface TextGenerationStreamBestOfSequence {
+    /** Generated text */
+    generated_text: string;
+    /** Generation finish reason */
+    finish_reason: TextGenerationStreamFinishReason;
+    /** Number of generated tokens */
+    generated_tokens: number;
+    /** Sampling seed if sampling was activated */
+    seed?: number;
+    /** Prompt tokens */
+    prefill: TextGenerationStreamPrefillToken[];
+    /** Generated tokens */
+    tokens: TextGenerationStreamToken[];
+}
+export type TextGenerationStreamFinishReason = 
+/** number of generated tokens == `max_new_tokens` */
+"length"
+/** the model generated its end of sequence token */
+ | "eos_token"
+/** the model generated a text included in `stop_sequences` */
+ | "stop_sequence";
+export interface TextGenerationStreamDetails {
+    /** Generation finish reason */
+    finish_reason: TextGenerationStreamFinishReason;
+    /** Number of generated tokens */
+    generated_tokens: number;
+    /** Sampling seed if sampling was activated */
+    seed?: number;
+    /** Prompt tokens */
+    prefill: TextGenerationStreamPrefillToken[];
+    /** */
+    tokens: TextGenerationStreamToken[];
+    /** Additional sequences when using the `best_of` parameter */
+    best_of_sequences?: TextGenerationStreamBestOfSequence[];
+}
+export interface TextGenerationStreamOutput {
+    index?: number;
+    /** Generated token, one at a time */
+    token: TextGenerationStreamToken;
+    /**
+     * Complete generated text
+     * Only available when the generation is finished
+     */
+    generated_text: string | null;
+    /**
+     * Generation details
+     * Only available when the generation is finished
+     */
+    details: TextGenerationStreamDetails | null;
+}
+/**
+ * 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 textGenerationStream(args: BaseArgs & TextGenerationInput, options?: Options): AsyncGenerator<TextGenerationStreamOutput>;
+//# sourceMappingURL=textGenerationStream.d.ts.map

package/dist/src/tasks/nlp/textGenerationStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textGenerationStream.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/textGenerationStream.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,WAAW,yBAAyB;IACzC,wCAAwC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc;IACd,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,gCAAgC;IAChD,wCAAwC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kCAAkC;IAClD,qBAAqB;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,+BAA+B;IAC/B,aAAa,EAAE,gCAAgC,CAAC;IAChD,iCAAiC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB;IACpB,OAAO,EAAE,gCAAgC,EAAE,CAAC;IAC5C,uBAAuB;IACvB,MAAM,EAAE,yBAAyB,EAAE,CAAC;CACpC;AAED,MAAM,MAAM,gCAAgC;AAC3C,qDAAqD;AACnD,QAAQ;AACV,oDAAoD;GAClD,WAAW;AACb,8DAA8D;GAC5D,eAAe,CAAC;AAEnB,MAAM,WAAW,2BAA2B;IAC3C,+BAA+B;IAC/B,aAAa,EAAE,gCAAgC,CAAC;IAChD,iCAAiC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oBAAoB;IACpB,OAAO,EAAE,gCAAgC,EAAE,CAAC;IAC5C,MAAM;IACN,MAAM,EAAE,yBAAyB,EAAE,CAAC;IACpC,8DAA8D;IAC9D,iBAAiB,CAAC,EAAE,kCAAkC,EAAE,CAAC;CACzD;AAED,MAAM,WAAW,0BAA0B;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,KAAK,EAAE,yBAAyB,CAAC;IACjC;;;OAGG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;OAGG;IACH,OAAO,EAAE,2BAA2B,GAAG,IAAI,CAAC;CAC5C;AAED;;GAEG;AACH,wBAAuB,oBAAoB,CAC1C,IAAI,EAAE,QAAQ,GAAG,mBAAmB,EACpC,OAAO,CAAC,EAAE,OAAO,GACf,cAAc,CAAC,0BAA0B,CAAC,CAK5C"}

package/dist/src/tasks/nlp/tokenClassification.d.ts

@@ -0,0 +1,51 @@
+import type { BaseArgs, Options } from "../../types";
+export type TokenClassificationArgs = BaseArgs & {
+    /**
+     * A string to be classified
+     */
+    inputs: string;
+    parameters?: {
+        /**
+         * (Default: simple). There are several aggregation strategies:
+         *
+         * none: Every token gets classified without further aggregation.
+         *
+         * simple: Entities are grouped according to the default schema (B-, I- tags get merged when the tag is similar).
+         *
+         * first: Same as the simple strategy except words cannot end up with different tags. Words will use the tag of the first token when there is ambiguity.
+         *
+         * average: Same as the simple strategy except words cannot end up with different tags. Scores are averaged across tokens and then the maximum label is applied.
+         *
+         * max: Same as the simple strategy except words cannot end up with different tags. Word entity will be the token with the maximum score.
+         */
+        aggregation_strategy?: "none" | "simple" | "first" | "average" | "max";
+    };
+};
+export interface TokenClassificationOutputValue {
+    /**
+     * The offset stringwise where the answer is located. Useful to disambiguate if word occurs multiple times.
+     */
+    end: number;
+    /**
+     * The type for the entity being recognized (model specific).
+     */
+    entity_group: string;
+    /**
+     * How likely the entity was recognized.
+     */
+    score: number;
+    /**
+     * The offset stringwise where the answer is located. Useful to disambiguate if word occurs multiple times.
+     */
+    start: number;
+    /**
+     * The string that was captured
+     */
+    word: string;
+}
+export type TokenClassificationOutput = TokenClassificationOutputValue[];
+/**
+ * Usually used for sentence parsing, either grammatical, or Named Entity Recognition (NER) to understand keywords contained within text. Recommended model: dbmdz/bert-large-cased-finetuned-conll03-english
+ */
+export declare function tokenClassification(args: TokenClassificationArgs, options?: Options): Promise<TokenClassificationOutput>;
+//# sourceMappingURL=tokenClassification.d.ts.map

package/dist/src/tasks/nlp/tokenClassification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenClassification.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/tokenClassification.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAIrD,MAAM,MAAM,uBAAuB,GAAG,QAAQ,GAAG;IAChD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE;QACZ;;;;;;;;;;;;WAYG;QACH,oBAAoB,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,KAAK,CAAC;KACvE,CAAC;CACF,CAAC;AAEF,MAAM,WAAW,8BAA8B;IAC9C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,yBAAyB,GAAG,8BAA8B,EAAE,CAAC;AAEzE;;GAEG;AACH,wBAAsB,mBAAmB,CACxC,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,yBAAyB,CAAC,CAuBpC"}

package/dist/src/tasks/nlp/translation.d.ts

@@ -0,0 +1,19 @@
+import type { BaseArgs, Options } from "../../types";
+export type TranslationArgs = BaseArgs & {
+    /**
+     * A string to be translated
+     */
+    inputs: string | string[];
+};
+export interface TranslationOutputValue {
+    /**
+     * The string after translation
+     */
+    translation_text: string;
+}
+export type TranslationOutput = TranslationOutputValue | TranslationOutputValue[];
+/**
+ * This task is well known to translate text from one language to another. Recommended model: Helsinki-NLP/opus-mt-ru-en.
+ */
+export declare function translation(args: TranslationArgs, options?: Options): Promise<TranslationOutput>;
+//# sourceMappingURL=translation.d.ts.map

package/dist/src/tasks/nlp/translation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"translation.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/translation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG;IACxC;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,WAAW,sBAAsB;IACtC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,iBAAiB,GAAG,sBAAsB,GAAG,sBAAsB,EAAE,CAAC;AAElF;;GAEG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAUtG"}

package/dist/src/tasks/nlp/zeroShotClassification.d.ts

@@ -0,0 +1,28 @@
+import type { BaseArgs, Options } from "../../types";
+export type ZeroShotClassificationArgs = BaseArgs & {
+    /**
+     * a string or list of strings
+     */
+    inputs: string | string[];
+    parameters: {
+        /**
+         * a list of strings that are potential classes for inputs. (max 10 candidate_labels, for more, simply run multiple requests, results are going to be misleading if using too many candidate_labels anyway. If you want to keep the exact same, you can simply run multi_label=True and do the scaling on your end.
+         */
+        candidate_labels: string[];
+        /**
+         * (Default: false) Boolean that is set to True if classes can overlap
+         */
+        multi_label?: boolean;
+    };
+};
+export interface ZeroShotClassificationOutputValue {
+    labels: string[];
+    scores: number[];
+    sequence: string;
+}
+export type ZeroShotClassificationOutput = ZeroShotClassificationOutputValue[];
+/**
+ * This task is super useful to try out classification with zero code, you simply pass a sentence/paragraph and the possible labels for that sentence, and you get a result. Recommended model: facebook/bart-large-mnli.
+ */
+export declare function zeroShotClassification(args: ZeroShotClassificationArgs, options?: Options): Promise<ZeroShotClassificationOutput>;
+//# sourceMappingURL=zeroShotClassification.d.ts.map

package/dist/src/tasks/nlp/zeroShotClassification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zeroShotClassification.d.ts","sourceRoot":"","sources":["../../../../src/tasks/nlp/zeroShotClassification.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAIrD,MAAM,MAAM,0BAA0B,GAAG,QAAQ,GAAG;IACnD;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,UAAU,EAAE;QACX;;WAEG;QACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC3B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;CACF,CAAC;AAEF,MAAM,WAAW,iCAAiC;IACjD,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,4BAA4B,GAAG,iCAAiC,EAAE,CAAC;AAE/E;;GAEG;AACH,wBAAsB,sBAAsB,CAC3C,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,4BAA4B,CAAC,CAqBvC"}

package/dist/src/tasks/tabular/tabularClassification.d.ts

@@ -0,0 +1,20 @@
+import type { BaseArgs, Options } from "../../types";
+export type TabularClassificationArgs = BaseArgs & {
+    inputs: {
+        /**
+         * A table of data represented as a dict of list where entries are headers and the lists are all the values, all lists must have the same size.
+         */
+        data: Record<string, string[]>;
+    };
+};
+/**
+ * A list of predicted labels for each row
+ */
+export type TabularClassificationOutput = number[];
+/**
+ * Predicts target label for a given set of features in tabular form.
+ * Typically, you will want to train a classification model on your training data and use it with your new data of the same format.
+ * Example model: vvmnnnkv/wine-quality
+ */
+export declare function tabularClassification(args: TabularClassificationArgs, options?: Options): Promise<TabularClassificationOutput>;
+//# sourceMappingURL=tabularClassification.d.ts.map

package/dist/src/tasks/tabular/tabularClassification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tabularClassification.d.ts","sourceRoot":"","sources":["../../../../src/tasks/tabular/tabularClassification.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG;IAClD,MAAM,EAAE;QACP;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KAC/B,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,MAAM,EAAE,CAAC;AAEnD;;;;GAIG;AACH,wBAAsB,qBAAqB,CAC1C,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,2BAA2B,CAAC,CAUtC"}

package/dist/src/tasks/tabular/tabularRegression.d.ts

@@ -0,0 +1,20 @@
+import type { BaseArgs, Options } from "../../types";
+export type TabularRegressionArgs = BaseArgs & {
+    inputs: {
+        /**
+         * A table of data represented as a dict of list where entries are headers and the lists are all the values, all lists must have the same size.
+         */
+        data: Record<string, string[]>;
+    };
+};
+/**
+ * a list of predicted values for each row
+ */
+export type TabularRegressionOutput = number[];
+/**
+ * Predicts target value for a given set of features in tabular form.
+ * Typically, you will want to train a regression model on your training data and use it with your new data of the same format.
+ * Example model: scikit-learn/Fish-Weight
+ */
+export declare function tabularRegression(args: TabularRegressionArgs, options?: Options): Promise<TabularRegressionOutput>;
+//# sourceMappingURL=tabularRegression.d.ts.map

package/dist/src/tasks/tabular/tabularRegression.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tabularRegression.d.ts","sourceRoot":"","sources":["../../../../src/tasks/tabular/tabularRegression.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGrD,MAAM,MAAM,qBAAqB,GAAG,QAAQ,GAAG;IAC9C,MAAM,EAAE;QACP;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;KAC/B,CAAC;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,EAAE,CAAC;AAE/C;;;;GAIG;AACH,wBAAsB,iBAAiB,CACtC,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CAUlC"}

package/dist/src/types.d.ts

@@ -0,0 +1,69 @@
+import type { PipelineType } from "@huggingface/tasks";
+import type { ChatCompletionInput } from "@huggingface/tasks";
+export interface Options {
+    /**
+     * (Default: true) Boolean. If a request 503s and wait_for_model is set to false, the request will be retried with the same parameters but with wait_for_model set to true.
+     */
+    retry_on_error?: boolean;
+    /**
+     * (Default: true). Boolean. There is a cache layer on Inference API (serverless) to speedup requests we have already seen. Most models can use those results as is as models are deterministic (meaning the results will be the same anyway). However if you use a non deterministic model, you can set this parameter to prevent the caching mechanism from being used resulting in a real new query.
+     */
+    use_cache?: boolean;
+    /**
+     * (Default: false). Boolean. Do not load the model if it's not already available.
+     */
+    dont_load_model?: boolean;
+    /**
+     * (Default: false). Boolean to use GPU instead of CPU for inference (requires Startup plan at least).
+     */
+    use_gpu?: boolean;
+    /**
+     * (Default: false) Boolean. If the model is not ready, wait for it instead of receiving 503. It limits the number of requests required to get your inference done. It is advised to only set this flag to true after receiving a 503 error as it will limit hanging in your application to known places.
+     */
+    wait_for_model?: boolean;
+    /**
+     * Custom fetch function to use instead of the default one, for example to use a proxy or edit headers.
+     */
+    fetch?: typeof fetch;
+    /**
+     * Abort Controller signal to use for request interruption.
+     */
+    signal?: AbortSignal;
+    /**
+     * (Default: "same-origin"). String | Boolean. Credentials to use for the request. If this is a string, it will be passed straight on. If it's a boolean, true will be "include" and false will not send credentials at all.
+     */
+    includeCredentials?: string | boolean;
+}
+export type InferenceTask = Exclude<PipelineType, "other">;
+export interface BaseArgs {
+    /**
+     * The access token to use. Without it, you'll get rate-limited quickly.
+     *
+     * Can be created for free in hf.co/settings/token
+     */
+    accessToken?: string;
+    /**
+     * The model to use.
+     *
+     * If not specified, will call huggingface.co/api/tasks to get the default model for the task.
+     *
+     * /!\ Legacy behavior allows this to be an URL, but this is deprecated and will be removed in the future.
+     * Use the `endpointUrl` parameter instead.
+     */
+    model?: string;
+    /**
+     * The URL of the endpoint to use. If not specified, will call huggingface.co/api/tasks to get the default endpoint for the task.
+     *
+     * If specified, will use this URL instead of the default one.
+     */
+    endpointUrl?: string;
+}
+export type RequestArgs = BaseArgs & ({
+    data: Blob | ArrayBuffer;
+} | {
+    inputs: unknown;
+} | ChatCompletionInput) & {
+    parameters?: Record<string, unknown>;
+    accessToken?: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE9D,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtC;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AAE3D,MAAM,WAAW,QAAQ;IACxB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,WAAW,GAAG,QAAQ,GACjC,CAAC;IAAE,IAAI,EAAE,IAAI,GAAG,WAAW,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,GAAG,mBAAmB,CAAC,GAAG;IAC5E,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/src/utils/base64FromBytes.d.ts

@@ -0,0 +1,2 @@
+export declare function base64FromBytes(arr: Uint8Array): string;
+//# sourceMappingURL=base64FromBytes.d.ts.map

package/dist/src/utils/base64FromBytes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base64FromBytes.d.ts","sourceRoot":"","sources":["../../../src/utils/base64FromBytes.ts"],"names":[],"mappings":"AAAA,wBAAgB,eAAe,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAUvD"}

package/dist/src/utils/distributive-omit.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This allows omitting keys from objects inside unions, without merging the individual components of the union.
+ */
+type Omit_<T, K> = Omit<T, Extract<keyof T, K>>;
+export type DistributiveOmit<T, K> = T extends unknown ? keyof Omit_<T, K> extends never ? never : {
+    [P in keyof Omit_<T, K>]: Omit_<T, K>[P];
+} : never;
+export {};
+//# sourceMappingURL=distributive-omit.d.ts.map

package/dist/src/utils/distributive-omit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"distributive-omit.d.ts","sourceRoot":"","sources":["../../../src/utils/distributive-omit.ts"],"names":[],"mappings":"AAEA;;GAEG;AAEH,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEhD,MAAM,MAAM,gBAAgB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,OAAO,GACnD,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,KAAK,GAC9B,KAAK,GACL;KAAG,CAAC,IAAI,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAC7C,KAAK,CAAC"}

package/dist/src/utils/isBackend.d.ts

@@ -0,0 +1,2 @@
+export declare const isBackend: boolean;
+//# sourceMappingURL=isBackend.d.ts.map

package/dist/src/utils/isBackend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isBackend.d.ts","sourceRoot":"","sources":["../../../src/utils/isBackend.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,SAAS,SAA6B,CAAC"}

package/dist/src/utils/isFrontend.d.ts

@@ -0,0 +1,2 @@
+export declare const isFrontend: boolean;
+//# sourceMappingURL=isFrontend.d.ts.map

package/dist/src/utils/isFrontend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isFrontend.d.ts","sourceRoot":"","sources":["../../../src/utils/isFrontend.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,UAAU,SAAa,CAAC"}

package/dist/src/utils/omit.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Return copy of object, omitting blocklisted array of props
+ */
+export declare function omit<T extends object, K extends keyof T>(o: T, props: K[] | K): Pick<T, Exclude<keyof T, K>>;
+//# sourceMappingURL=omit.d.ts.map

package/dist/src/utils/omit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"omit.d.ts","sourceRoot":"","sources":["../../../src/utils/omit.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAI5G"}

package/dist/src/utils/pick.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Return copy of object, only keeping allowlisted properties.
+ */
+export declare function pick<T, K extends keyof T>(o: T, props: K[] | ReadonlyArray<K>): Pick<T, K>;
+//# sourceMappingURL=pick.d.ts.map

package/dist/src/utils/pick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pick.d.ts","sourceRoot":"","sources":["../../../src/utils/pick.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAS1F"}

package/dist/src/utils/toArray.d.ts

@@ -0,0 +1,2 @@
+export declare function toArray<T>(obj: T): T extends unknown[] ? T : T[];
+//# sourceMappingURL=toArray.d.ts.map

package/dist/src/utils/toArray.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toArray.d.ts","sourceRoot":"","sources":["../../../src/utils/toArray.ts"],"names":[],"mappings":"AAAA,wBAAgB,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,SAAS,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAKhE"}

package/dist/src/utils/typedInclude.d.ts

@@ -0,0 +1,2 @@
+export declare function typedInclude<V, T extends V>(arr: readonly T[], v: V): v is T;
+//# sourceMappingURL=typedInclude.d.ts.map

package/dist/src/utils/typedInclude.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedInclude.d.ts","sourceRoot":"","sources":["../../../src/utils/typedInclude.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAE5E"}