@huggingface/inference

Classes

Interfaces

Type Aliases

AudioClassificationArgs

Ƭ AudioClassificationArgs: Args & { data: any }

Defined in

HfInference.ts:468


AudioClassificationReturn

Ƭ AudioClassificationReturn: AudioClassificationReturnValue[]

Defined in

HfInference.ts:487


AutomaticSpeechRecognitionArgs

Ƭ AutomaticSpeechRecognitionArgs: Args & { data: any }

Defined in

HfInference.ts:454


ConversationalArgs

Ƭ ConversationalArgs: Args & { inputs: { generated_responses?: string[] ; past_user_inputs?: string[] ; text: string } ; parameters?: { max_length?: number ; max_time?: number ; min_length?: number ; repetition_penalty?: number ; temperature?: number ; top_k?: number ; top_p?: number } }

Defined in

HfInference.ts:307


FeatureExtractionArgs

Ƭ FeatureExtractionArgs: Args & { inputs: Record<string, any> | Record<string, any>[] }

Defined in

HfInference.ts:363


FeatureExtractionReturn

Ƭ FeatureExtractionReturn: (number | number[])[]

Returned values are a list of floats, or a list of list of floats (depending on if you sent a string or a list of string, and if the automatic reduction, usually mean_pooling for instance was applied for you or not. This should be explained on the model’s README.

Defined in

HfInference.ts:378


FillMaskArgs

Ƭ FillMaskArgs: Args & { inputs: string }

Defined in

HfInference.ts:25


FillMaskReturn

Ƭ FillMaskReturn: { score: number ; sequence: string ; token: number ; token_str: string }[]

Defined in

HfInference.ts:29


ImageClassificationArgs

Ƭ ImageClassificationArgs: Args & { data: any }

Defined in

HfInference.ts:380


ImageClassificationReturn

Ƭ ImageClassificationReturn: ImageClassificationReturnValue[]

Defined in

HfInference.ts:398


ImageSegmentationArgs

Ƭ ImageSegmentationArgs: Args & { data: any }

Defined in

HfInference.ts:430


ImageSegmentationReturn

Ƭ ImageSegmentationReturn: ImageSegmentationReturnValue[]

Defined in

HfInference.ts:452


ObjectDetectionArgs

Ƭ ObjectDetectionArgs: Args & { data: any }

Defined in

HfInference.ts:400


ObjectDetectionReturn

Ƭ ObjectDetectionReturn: ObjectDetectionReturnValue[]

Defined in

HfInference.ts:428


QuestionAnswerArgs

Ƭ QuestionAnswerArgs: Args & { inputs: { context: string ; question: string } }

Defined in

HfInference.ts:92


SummarizationArgs

Ƭ SummarizationArgs: Args & { inputs: string ; parameters?: { max_length?: number ; max_time?: number ; min_length?: number ; repetition_penalty?: number ; temperature?: number ; top_k?: number ; top_p?: number } }

Defined in

HfInference.ts:48


TableQuestionAnswerArgs

Ƭ TableQuestionAnswerArgs: Args & { inputs: { query: string ; table: Record<string, string[]> } }

Defined in

HfInference.ts:118


TextClassificationArgs

Ƭ TextClassificationArgs: Args & { inputs: string }

Defined in

HfInference.ts:150


TextClassificationReturn

Ƭ TextClassificationReturn: { label: string ; score: number }[]

Defined in

HfInference.ts:157


TextGenerationArgs

Ƭ TextGenerationArgs: Args & { inputs: string ; parameters?: { do_sample?: boolean ; max_new_tokens?: number ; max_time?: number ; num_return_sequences?: number ; repetition_penalty?: number ; return_full_text?: boolean ; temperature?: number ; top_k?: number ; top_p?: number } }

Defined in

HfInference.ts:168


TextToImageArgs

Ƭ TextToImageArgs: Args & { inputs: string ; negative_prompt?: string }

Defined in

HfInference.ts:489


TextToImageReturn

Ƭ TextToImageReturn: ArrayBuffer

Defined in

HfInference.ts:501


TokenClassificationArgs

Ƭ TokenClassificationArgs: Args & { inputs: string ; parameters?: { aggregation_strategy?: "none" | "simple" | "first" | "average" | "max" } }

Defined in

HfInference.ts:220


TokenClassificationReturn

Ƭ TokenClassificationReturn: TokenClassificationReturnValue[]

Defined in

HfInference.ts:266


TranslationArgs

Ƭ TranslationArgs: Args & { inputs: string }

Defined in

HfInference.ts:268


ZeroShotClassificationArgs

Ƭ ZeroShotClassificationArgs: Args & { inputs: string | string[] ; parameters: { candidate_labels: string[] ; multi_label?: boolean } }

Defined in

HfInference.ts:282


ZeroShotClassificationReturn

Ƭ ZeroShotClassificationReturn: ZeroShotClassificationReturnValue[]

Defined in

HfInference.ts:305