@huggingface/inference

类

• HfInference
• HfInferenceEndpoint
• InferenceOutputError

接口

• AudioClassificationOutputValue
• AudioToAudioOutputValue
• AutomaticSpeechRecognitionOutput
• BaseArgs
• DocumentQuestionAnsweringOutput
• ImageClassificationOutputValue
• ImageSegmentationOutputValue
• ImageToTextOutput
• ObjectDetectionOutputValue
• Options
• QuestionAnsweringOutput
• SummarizationOutput
• TableQuestionAnsweringOutput
• TextGenerationInput
• TextGenerationOutput
• TextGenerationStreamBestOfSequence
• TextGenerationStreamDetails
• TextGenerationStreamOutput
• TextGenerationStreamPrefillToken
• TextGenerationStreamToken
• TokenClassificationOutputValue
• TranslationOutputValue
• VisualQuestionAnsweringOutput
• ZeroShotClassificationOutputValue
• ZeroShotImageClassificationOutputValue

类型别名

AudioClassificationArgs

Ƭ AudioClassificationArgs: BaseArgs & { data: Blob | ArrayBuffer }

定义于

inference/src/tasks/audio/audioClassification.ts:5

---

AudioClassificationReturn

Ƭ AudioClassificationReturn: AudioClassificationOutputValue[]

定义于

inference/src/tasks/audio/audioClassification.ts:24

---

AudioToAudioArgs

类型 AudioToAudioArgs: BaseArgs & { data: Blob | ArrayBuffer }

定义于

inference/src/tasks/audio/audioToAudio.ts:5

---

AudioToAudioReturn

类型 AudioToAudioReturn: AudioToAudioOutputValue[]

定义于

inference/src/tasks/audio/audioToAudio.ts:29

---

自动语音识别参数

类型 自动语音识别参数： BaseArgs & { data: Blob | ArrayBuffer }

定义于

inference/src/tasks/audio/automaticSpeechRecognition.ts:5

---

文本问答参数

类型 文本问答参数： BaseArgs & { inputs: { image: Blob | ArrayBuffer ; question: string } }

在以下位置定义

inference/src/tasks/multimodal/documentQuestionAnswering.ts:8

---

FeatureExtractionArgs

类型 FeatureExtractionArgs: BaseArgs & { inputs: string | string[] }

在以下位置定义

inference/src/tasks/nlp/featureExtraction.ts:6

---

FeatureExtractionOutput

类型 FeatureExtractionOutput: (number | number[] | number[][])[]

返回的是多维数组浮点数（维度取决于你是否发送了字符串或字符串数组，以及是否为你应用了自动降维，通常是mean_pooling。这应该在模型的README中说明。）

定义于

inference/src/tasks/nlp/featureExtraction.ts:19

---

FillMaskArgs

^Ƭ FillMaskArgs: BaseArgs & { inputs: string }

定义于

inference/src/tasks/nlp/fillMask.ts:5

---

FillMaskOutput

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

定义于

inference/src/tasks/nlp/fillMask.ts:9

---

ImageClassificationArgs

类型 ImageClassificationArgs: BaseArgs & { data: Blob | ArrayBuffer }

定义于

inference/src/tasks/cv/imageClassification.ts:5

---

ImageClassificationOutput

类型 ImageClassificationOutput: ImageClassificationOutputValue[]

定义于

inference/src/tasks/cv/imageClassification.ts:23

---

ImageSegmentationArgs

Ƭ ImageSegmentationArgs: BaseArgs & { data: Blob | ArrayBuffer }

定义于

inference/src/tasks/cv/imageSegmentation.ts:5

---

ImageSegmentationOutput

Ƭ ImageSegmentationOutput: ImageSegmentationOutputValue[]

定义于

inferrence/src/tasks/cv/imageSegmentation.ts:27

---

ImageToImageArgs

类型 ImageToImageArgs: BaseArgs & { inputs: Blob | ArrayBuffer ; parameters?: { guess_mode?: boolean ; guidance_scale?: number ; height?: number ; negative_prompt?: string ; num_inference_steps?: number ; prompt?: string ; strength?: number ; width?: number } }

定义于

inferrence/src/tasks/cv/imageToImage.ts:6

---

ImageToImageOutput

类型 ImageToImageOutput: Blob

定义于

inference/src/tasks/cv/imageToImage.ts:55

---

ImageToTextArgs

Ƭ ImageToTextArgs: BaseArgs & { data: Blob | ArrayBuffer }

定义于

inference/src/tasks/cv/imageToText.ts:5

---

InferenceTask

Ƭ InferenceTask: Exclude < PipelineType, "other" >

定义于

inference/src/types.ts:41

---

ObjectDetectionArgs

类型 ObjectDetectionArgs: BaseArgs & { data: Blob | ArrayBuffer }

定义于

inference/src/tasks/cv/objectDetection.ts:5

---

ObjectDetectionOutput

类型 ObjectDetectionOutput: ObjectDetectionOutputValue[]

在这里定义

inference/src/tasks/cv/objectDetection.ts:33

---

QuestionAnsweringArgs

类型 QuestionAnsweringArgs: BaseArgs & { inputs: { context: string ; question: string } }

在这里定义

inference/src/tasks/nlp/questionAnswering.ts:5

---

RequestArgs

类型 RequestArgs: BaseArgs & { data: Blob | ArrayBuffer } | { inputs: unknown } | ChatCompletionInput & { accessToken?: string ; parameters?: Record\<string, unknown> }

定义于

inference/src/types.ts:68

---

SentenceSimilarityArgs

类型 SentenceSimilarityArgs: BaseArgs & { inputs: Record<string, unknown> | Record<string, unknown>[] }

定义于

inference/src/tasks/nlp/sentenceSimilarity.ts:6

---

SentenceSimilarityOutput

类型 SentenceSimilarityOutput: number[]

返回值是一个浮点数列表

定义在

inference/src/tasks/nlp/sentenceSimilarity.ts:19

---

SummarizationArgs

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

定义在

inference/src/tasks/nlp/summarization.ts:5

---

TableQuestionAnsweringArgs

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

定义在

inference/src/tasks/nlp/tableQuestionAnswering.ts:5

---

TabularClassificationArgs

Ƭ TabularClassificationArgs: BaseArgs & { inputs: { data: Record<string, string[]> } }

定义在

inference/src/tasks/tabular/tabularClassification.ts:5

---

TabularClassificationOutput

Ƭ TabularClassificationOutput: number[]

每行的预测标签列表

定义在

inference/src/tasks/tabular/tabularClassification.ts:17

---

TabularRegressionArgs

τ TabularRegressionArgs: BaseArgs & { inputs: { data: Record<string, string[]> } }

定义在

inference/src/tasks/tabular/tabularRegression.ts:5

---

TabularRegressionOutput

τ TabularRegressionOutput: number[]

每行的预测值列表

在以下位置定义

inference/src/tasks/tabular/tabularRegression.ts:17

---

TextClassificationArgs

信息类型 TextClassificationArgs: BaseArgs & { inputs: string }

在以下位置定义

inference/src/tasks/nlp/textClassification.ts:5

---

TextClassificationOutput

信息类型 TextClassificationOutput: { label: string ; score: number }[]

定义于

inference/src/tasks/nlp/textClassification.ts:12

---

TextGenerationStreamFinishReason

ǿ TextGenerationStreamFinishReason: length | eos_token | stop_sequence

定义于

inference/src/tasks/nlp/textGenerationStream.ts:46

---

TextToImageArgs

ǿ TextToImageArgs: BaseArgs & { inputs: string ; parameters?: { guidance_scale?: number ; height?: number ; negative_prompt?: string ; num_inference_steps?: number ; width?: number } }

定义在

inference/src/tasks/cv/textToImage.ts:5

---

TextToImageOutput

Ƭ TextToImageOutput: Blob

定义在

inference/src/tasks/cv/textToImage.ts:35

---

TextToSpeechArgs

Ƭ TextToSpeechArgs: BaseArgs & { inputs: string }

定义于

inference/src/tasks/audio/textToSpeech.ts:5

---

TextToSpeechOutput

Ƭ TextToSpeechOutput: Blob

定义于

inference/src/tasks/audio/textToSpeech.ts:12

---

TokenClassificationArgs

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

定义于

inference/src/tasks/nlp/tokenClassification.ts:6

---

TokenClassificationOutput

类型 TokenClassificationOutput: TokenClassificationOutputValue[]

定义于

inference/src/tasks/nlp/tokenClassification.ts:52

---

TranslationArgs

类型 TranslationArgs: BaseArgs & { inputs: string | string[] }

定义于

inference/src/tasks/nlp/translation.ts:5

---

TranslationOutput

类型 TranslationOutput: TranslationOutputValue | TranslationOutputValue[]

定义于

inference/src/tasks/nlp/translation.ts:19

---

VisualQuestionAnsweringArgs

类型 VisualQuestionAnsweringArgs: BaseArgs & { inputs: { image: Blob | ArrayBuffer ; question: string } }

定义在

inference/src/tasks/multimodal/visualQuestionAnswering.ts:6

---

ZeroShotClassificationArgs

类型 ZeroShotClassificationArgs: BaseArgs & { inputs: string | string[] ; parameters: { candidate_labels: string[] ; multi_label?: boolean } }

定义在

inference/src/tasks/nlp/zeroShotClassification.ts:6

---

ZeroShotClassificationOutput

类型 ZeroShotClassificationOutput: ZeroShotClassificationOutputValue[]

定义于

inference/src/tasks/nlp/zeroShotClassification.ts:29

---

ZeroShotImageClassificationArgs

类型 ZeroShotImageClassificationArgs: BaseArgs & { inputs: { image: Blob | ArrayBuffer } ; parameters: { candidate_labels: string[] } }

定义于

inference/src/tasks/cv/zeroShotImageClassification.ts:7

---

ZeroShotImageClassificationOutput

类型 ZeroShotImageClassificationOutput: ZeroShotImageClassificationOutputValue[]

定义于

inference/src/tasks/cv/zeroShotImageClassification.ts:27

函数

audioClassification

▸ audioClassification(args, options?): Promise<AudioClassificationReturn>

该任务读取一些音频输入并输出类别的可能性。推荐模型：superb/hubert-large-superb-er

参数

名称	类型
args	AudioClassificationArgs
options?	Options

返回值

Promise<音频分类返回>

定义于

inference/src/tasks/audio/audioClassification.ts:30

---

audioToAudio

▸ audioToAudio(args, options?): Promise<音频到音频返回>

该任务读取一些音频输入并输出一个或多个音频文件。示例模型：speechbrain/sepformer-wham 进行音频源分离。

参数

名称	类型
args	AudioToAudioArgs
options?	Options

返回值

Promise<AudioToAudioReturn>

定义于

inference/src/tasks/audio/audioToAudio.ts:35

---

自动语音识别

▸ automaticSpeechRecognition(args, options?): Promise<AutomaticSpeechRecognitionOutput>

该任务读取一些音频输入并输出音频文件中的说话内容。推荐模型（英语）：facebook/wav2vec2-large-960h-lv60-self

参数

名称	类型
args	自动语音识别参数
options?	Options

返回

Promise<AutomaticSpeechRecognitionOutput>

定义于

inference/src/tasks/audio/automaticSpeechRecognition.ts:23

---

chatCompletion

▸ chatCompletion(args, options?): Promise<ChatCompletionOutput>

使用聊天完成端点来生成对提示语的响应，使用OpenAI消息完成API（无流）

参数

名称	类型
args	BaseArgs & ChatCompletionInput
options?	Options

返回值

Promise<ChatCompletionOutput>

定义于

inference/src/tasks/nlp/chatCompletion.ts:10

---

chatCompletionStream

▸ chatCompletionStream(args, options?): AsyncGenerator<ChatCompletionStreamOutput>

用于从提示中继续文本。与 textGeneration 相同，但返回一个可以逐个读取标记的生成器

参数

名称	类型
args	BaseArgs & ChatCompletionInput
options?	Options

返回值

AsyncGenerator<ChatCompletionStreamOutput>

定义于

inference/src/tasks/nlp/chatCompletionStream.ts:8

---

documentQuestionAnswering

▸ documentQuestionAnswering(args, options?): Promise<DocumentQuestionAnsweringOutput>

在文档图像上回答问题。推荐模型: impira/layoutlm-document-qa。

参数

名称	类型
args	DocumentQuestionAnsweringArgs
options?	Options

返回

Promise\<DocumentQuestionAnsweringOutput>

定义于

inference/src/tasks/multimodal/documentQuestionAnswering.ts:42

---

特征提取

▸ 特征提取(args, options?): Promise\<FeatureExtractionOutput>

该任务读取一些文本，并输出原始浮点值，这些值通常作为语义数据库/语义搜索的一部分被消费。

参数

名称	类型
args	FeatureExtractionArgs
options?	Options

返回值

Promise<FeatureExtractionOutput>

定义于

inference/src/tasks/nlp/featureExtraction.ts:24

---

fillMask

▸ fillMask(args, options?): Promise<FillMaskOutput>

尝试用缺失的单词（精确地说是一个标记）填充空缺，这是BERT模型的基线任务。

参数

名称	类型
args	FillMaskArgs
options?	Options

返回值

Promise<FillMaskOutput>

定义在

inference/src/tasks/nlp/fillMask.ts:31

---

图像分类

▸ 图像分类(args, options?): Promise<ImageClassificationOutput>

此任务读取某些图像输入并输出类别的概率。推荐模型：google/vit-base-patch16-224

参数

名称	类型
args	ImageClassificationArgs
options?	Options

返回

Promise\<ImageClassificationOutput>

定义在

inference/src/tasks/cv/imageClassification.ts:29

---

图像分割

▸ 图像分割(args, options?): Promise\<ImageSegmentationOutput>

该任务读取一些图像输入并输出检测到的对象的类别概率和边界框。推荐模型：facebook/detr-resnet-50-panoptic

参数

名称	类型
args	ImageSegmentationArgs
options?	Options

返回

Promise<；《ImageSegmentationOutput>

定义于

inference/src/tasks/cv/imageSegmentation.ts:33

---

imageToImage

▸ imageToImage(args, options?): Promise<；《ImageToImageOutput>

此任务读取文本输入并输出图片。推荐模型：lllyasviel/sd-controlnet-depth

参数

名称	类型
args	ImageToImageArgs
options?	Options

返回

Promise<ImageToImageOutput>

定义于

inference/src/tasks/cv/imageToImage.ts:61

---

imageToText

▸ imageToText(args, options?): Promise<ImageToTextOutput>

此任务读取某些图像输入并输出文本字幕。

参数

名称	类型
args	ImageToTextArgs
options?	Options

返回值

Promise<ImageToTextOutput>

定义于

inference/src/tasks/cv/imageToText.ts:22

---

objectDetection

▸ objectDetection(args, options?): Promise<ObjectDetectionOutput>

此任务读取图像输入并输出检测到对象的类别和边界框的可能性。推荐模型：facebook/detr-resnet-50

参数

名称	类型
args	ObjectDetectionArgs
options?	Options

返回值

Promise<ObjectDetectionOutput>

定义于

inference/src/tasks/cv/objectDetection.ts:39

---

问答

▸ 问答(args, options?): Promise<QuestionAnsweringOutput>

想要有一个能够回答任何问题的好朋友机器人吗？推荐模型：deepset/roberta-base-squad2

参数

名称	类型
args	QuestionAnsweringArgs
options?	Options

返回值

Promise<QuestionAnsweringOutput>

定义于

inference/src/tasks/nlp/questionAnswering.ts:34

---

请求

▸ request<T>(args, options?): Promise<T>

用于向推理端点进行自定义调用的基本类型

类型参数

名称
T

参数

名称	类型
args	RequestArgs
options?	Options & { chatCompletion?: boolean ; task?: string ; taskHint?: InferenceTask }

返回值

Promise<T>

定义于

inference/src/tasks/custom/request.ts:7

---

句子相似度

▸ 句子相似度(args, options?): Promise<句子相似度输出>

通过比较文本和其它句子的embedding来计算它们之间的语义相似度。

参数

名称	类型
args	SentenceSimilarityArgs
options?	Options

返回值

Promise<SentenceSimilarityOutput>

定义于

inference/src/tasks/nlp/sentenceSimilarity.ts:24

---

streamingRequest

▸ streamingRequest< T >(args, options?): AsyncGenerator< T >

用于执行自定义推理调用，并期望服务器发送事件，通过生成器返回响应的原始调用

类型参数

名称
T

参数

名称	类型
args	RequestArgs
options?	Options & { chatCompletion?: boolean ; task?: string ; taskHint?: InferenceTask }

返回值

AsyncGenerator<T>

定义于

inference/src/tasks/custom/streamingRequest.ts:9

---

摘要

▸ 摘要(args, options?): Promise<SummarizationOutput>

这个任务已知可以将较长的文本总结为较短的文本。请注意，一些模型有输入的最大长度限制。这意味着摘要可能无法处理全书等。选择模型时请小心。

参数

名称	类型
args	SummarizationArgs
options?	Options

返回值

Promise<SummarizationOutput>

定义于

inference/src/tasks/nlp/summarization.ts:52

---

tableQuestionAnswering

▸ tableQuestionAnswering(args, options?): PromiseTableQuestionAnsweringOutput

不懂SQL？不想深入研究大型工作表？用普通英语提问！推荐模型：google/tapas-base-finetuned-wtq。

参数

名称	类型
args	TableQuestionAnsweringArgs
options?	Options

返回值

PromiseTableQuestionAnsweringOutput

定义于

inference/src/tasks/nlp/tableQuestionAnswering.ts:40

---

tabularClassification

▸ tabularClassification(args, options?): Promise<TabularClassificationOutput>

预测表格形式给定特徵的目标标签。通常，您希望使用训练数据对分类模型进行训练，并使用相同格式的新的数据进行调用。示例模型：vvmnnnkv/wine-quality

参数

名称	类型
args	TabularClassificationArgs
options?	Options

返回值

Promise<TabularClassificationOutput>

定义于

inference/src/tasks/tabular/tabularClassification.ts:24

---

tabularRegression

▸ tabularRegression(args, options?): Promise＜TabularRegressionOutput＞

对给定的一组特征表格值进行目标值预测。通常，您将在训练数据上训练回归模型，并结合相同格式的新的数据进行使用。例如模型：scikit-learn/Fish-Weight

参数

名称	类型
args	TabularRegressionArgs
options?	Options

返回值

Promise＜TabularRegressionOutput＞

定义于

inference/src/tasks/tabular/tabularRegression.ts:24

---

文本分类

▸ 文本分类(args, options?): Promise<TextClassificationOutput>

通常用于情感分析，将输出输入的分类可能性。推荐模型：distilbert-base-uncased-finetuned-sst-2-english

参数

名称	类型
args	TextClassificationArgs
options?	Options

返回

Promise<TextClassificationOutput>

定义于

inference/src/tasks/nlp/textClassification.ts:26

---

textGeneration

▸ textGeneration(args, options?): Promise<TextGenerationOutput>

用于从提示继续文本。这是一个非常通用的任务。推荐模型：gpt2（它是一个简单的模型，但很有趣）。

参数

名称	类型
args	BaseArgs & TextGenerationInput
options?	Options

返回值

Promise<TextGenerationOutput>

定义于

inference/src/tasks/nlp/textGeneration.ts:12

---

textGenerationStream

▸ textGenerationStream(args, options?): AsyncGenerator<TextGenerationStreamOutput>

用于从提示中继续文本。与 textGeneration 相同，但返回一个可以逐个读取标记的生成器

参数

名称	类型
args	BaseArgs & TextGenerationInput
options?	Options

返回值

AsyncGenerator<TextGenerationStreamOutput>

定义于

inference/src/tasks/nlp/textGenerationStream.ts:88

---

textToImage

▸ textToImage(args, options?): Promise<TextToImageOutput>

此任务读取一些文本输入并输出图像。推荐模型：stabilityai/stable-diffusion-2

参数

名称	类型
args	TextToImageArgs
options?	Options

返回值

Promise<TextToImageOutput>

定义于

inference/src/tasks/cv/textToImage.ts:41

---

textToSpeech

▸ textToSpeech(args, options?): Promise<TextToSpeechOutput>

此任务将特定的文本转换为语音。推荐模型：espnet/kan-bayashi_ljspeech_vits

参数

名称	类型
args	TextToSpeechArgs
options?	Options

返回值

Promise<TextToSpeechOutput>

定义于

inference/src/tasks/audio/textToSpeech.ts:18

---

tokenClassification

▸ tokenClassification(args, options?): Promise<TokenClassificationOutput>

通常用于句子解析，可以是语法解析或命名实体识别（NER），以理解文本中的关键字。推荐模型：dbmdz/bert-large-cased-finetuned-conll03-english

参数

名称	类型
args	TokenClassificationArgs
options?	Options

返回值

Promise<TokenClassificationOutput>

定义于

inference/src/tasks/nlp/tokenClassification.ts:57

---

翻译

▸ 翻译(args, options?): Promise<TranslationOutput>

这是一个非常著名的任务，用于将文本从一种语言翻译成另一种语言。推荐模型：Helsinki-NLP/opus-mt-ru-en。

参数

名称	类型
args	TranslationArgs
options?	Options

返回值

Promise<TranslationOutput>

定义于

inference/src/tasks/nlp/translation.ts:24

---

视觉问答

▸ visualQuestionAnswering(args, options?): Promise<VisualQuestionAnsweringOutput>

对图像上的问题进行回答。推荐模型：dandelin/vilt-b32-finetuned-vqa。

参数

名称	类型
args	VisualQuestionAnsweringArgs
options?	Options

返回值

Promise<VisualQuestionAnsweringOutput>

定义在

inference/src/tasks/multimodal/visualQuestionAnswering.ts:32

---

zeroShotClassification

▸ zeroShotClassification(args, options?): Promise<ZeroShotClassificationOutput>

此任务非常适合零代码尝试分类，您只需传入一句/段话及其可能的标签，即可获得结果。推荐模型：facebook/bart-large-mnli。

参数

名称	类型
args	ZeroShotClassificationArgs
options?	Options

返回

Promise<ZeroShotClassificationOutput>

定义在

inference/src/tasks/nlp/zeroShotClassification.ts:34

---

zeroShotImageClassification

▸ zeroShotImageClassification(args, options?): Promise< ZeroShotImageClassificationOutput >

将图像分类到指定的类别。推荐模型：openai/clip-vit-large-patch14-336

参数

名称	类型
args	ZeroShotImageClassificationArgs
options?	Options

返回值

Promise< ZeroShotImageClassificationOutput >

所在位置

inference/src/tasks/cv/zeroShotImageClassification.ts:33

< > 更新 在 GitHub 上