Hugging Face 的 LOGO

Huggingface.js 文档

类：InferenceClientEndpoint

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

类：InferenceClientEndpoint

仅为向后兼容性保留，即将移除。

已弃用

替换为 InferenceClient

层级结构

构造函数

构造函数

• new InferenceClientEndpoint(accessToken?, defaultOptions?): InferenceClientEndpoint

参数

名称 类型 默认值
accessToken 字符串 ""
defaultOptions Options & { endpointUrl?: string } {}

返回

InferenceClientEndpoint

继承自

InferenceClient.constructor

定义于

inference/src/InferenceClient.ts:15

方法

音频分类

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

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

参数

名称 类型
args AudioClassificationArgs
options? Options

返回

Promise\<AudioClassificationOutput>

继承自

InferenceClient.audioClassification

定义于

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

音频到音频

▸ audioToAudio(args, options?): Promise\<AudioToAudioOutput[]>

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

参数

名称 类型
args AudioToAudioArgs
options? Options

返回

Promise\<AudioToAudioOutput[]>

继承自

InferenceClient.audioToAudio

定义于

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

自动语音识别

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

此任务读取音频输入并输出音频文件中的口语单词。推荐模型（英语）：facebook/wav2vec2-large-960h-lv60-self

参数

名称 类型
args AutomaticSpeechRecognitionArgs
options? Options

返回

Promise\<AutomaticSpeechRecognitionOutput>

继承自

InferenceClient.automaticSpeechRecognition

定义于

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

聊天补全

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

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

参数

名称 类型
args BaseArgs & ChatCompletionInput
options? Options

返回

Promise\<ChatCompletionOutput>

继承自

InferenceClient.chatCompletion

定义于

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

聊天流式补全

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

用于从提示继续文本。与 textGeneration 相同，但返回一个可一次读取一个 token 的生成器

参数

名称 类型
args BaseArgs & ChatCompletionInput
options? Options

返回

AsyncGenerator\<ChatCompletionStreamOutput>

继承自

InferenceClient.chatCompletionStream

定义于

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

文档问答

▸ documentQuestionAnswering(args, options?): Promise\<DocumentQuestionAnsweringOutput[number]>

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

参数

名称 类型
args DocumentQuestionAnsweringArgs
options? Options

返回

Promise\<DocumentQuestionAnsweringOutput[number]>

继承自

InferenceClient.documentQuestionAnswering

定义于

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

端点

▸ endpoint(endpointUrl): InferenceClient

返回绑定到指定端点的 InferenceClient 新实例。

主要用于向后兼容性。

参数

名称 类型
endpointUrl 字符串

返回

InferenceClient

继承自

InferenceClient.endpoint

定义于

inference/src/InferenceClient.ts:46

特征提取

▸ featureExtraction(args, options?): Promise\<FeatureExtractionOutput>

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

参数

名称 类型
args FeatureExtractionArgs
options? Options

返回

Promise\<FeatureExtractionOutput>

继承自

InferenceClient.featureExtraction

定义于

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

fillMask

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

尝试用缺失的单词（准确地说是标记）填充空白。这是 BERT 模型的基本任务。

Parameters

名称 类型
args FillMaskArgs
options? Options

Returns

Promise\<FillMaskOutput>

Inherited from

InferenceClient.fillMask

Defined in

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

imageClassification

▸ imageClassification(args, options?): Promise\<ImageClassificationOutput>

此任务读取图像输入并输出类别的可能性。推荐模型：google/vit-base-patch16-224

Parameters

名称 类型
args ImageClassificationArgs
options? Options

Returns

Promise\<ImageClassificationOutput>

Inherited from

InferenceClient.imageClassification

Defined in

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

imageSegmentation

▸ imageSegmentation(args, options?): Promise\<ImageSegmentationOutput>

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

Parameters

名称 类型
args ImageSegmentationArgs
options? Options

Returns

Promise\<ImageSegmentationOutput>

Inherited from

InferenceClient.imageSegmentation

Defined in

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

imageToImage

▸ imageToImage(args, options?): Promise\<Blob>

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

Parameters

名称 类型
args ImageToImageArgs
options? Options

Returns

Promise\<Blob>

Inherited from

InferenceClient.imageToImage

Defined in

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

imageToText

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

此任务读取图像输入并输出文本描述。

Parameters

名称 类型
args ImageToTextArgs
options? Options

Returns

Promise\<ImageToTextOutput>

Inherited from

InferenceClient.imageToText

Defined in

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

imageToVideo

▸ imageToVideo(args, options?): Promise\<Blob>

此任务读取文本输入并输出图像。推荐模型：Wan-AI/Wan2.1-I2V-14B-720P

Parameters

名称 类型
args ImageToVideoArgs
options? Options

Returns

Promise\<Blob>

Inherited from

InferenceClient.imageToVideo

Defined in

inference/src/tasks/cv/imageToVideo.ts:14

objectDetection

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

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

Parameters

名称 类型
args ObjectDetectionArgs
options? Options

Returns

Promise\<ObjectDetectionOutput>

Inherited from

InferenceClient.objectDetection

Defined in

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

questionAnswering

▸ questionAnswering(args, options?): Promise\<QuestionAnsweringOutput[number]>

想要一个无所不知的机器人，可以回答任何问题？推荐模型：deepset/roberta-base-squad2

Parameters

名称 类型
args QuestionAnsweringArgs
options? Options

Returns

Promise\<QuestionAnsweringOutput[number]>

Inherited from

InferenceClient.questionAnswering

Defined in

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

request

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

用于向推理提供者进行自定义调用的原语

Type parameters

名称
T

Parameters

名称 类型
args RequestArgs
options? Options & { task?: InferenceTask }

Returns

Promise\<T>

已弃用

请改用特定的任务函数。此函数将在未来版本中移除。

Inherited from

InferenceClient.request

Defined in

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

sentenceSimilarity

▸ sentenceSimilarity(args, options?): Promise\<SentenceSimilarityOutput>

通过比较嵌入来计算一段文本与另一组句子之间的语义相似度。

Parameters

名称 类型
args SentenceSimilarityArgs
options? Options

Returns

Promise\<SentenceSimilarityOutput>

Inherited from

InferenceClient.sentenceSimilarity

Defined in

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

streamingRequest

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

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

Type parameters

名称
T

Parameters

名称 类型
args RequestArgs
options? Options & { task?: InferenceTask }

Returns

AsyncGenerator\<T>

已弃用

请改用特定的任务函数。此函数将在未来版本中移除。

Inherited from

InferenceClient.streamingRequest

Defined in

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

summarization

▸ summarization(args, options?): Promise\<SummarizationOutput>

此任务以将较长文本总结为较短文本而闻名。请注意，某些模型的输入长度有最大限制。这意味着摘要无法处理完整的书籍等。选择模型时请谨慎。

Parameters

名称 类型
args SummarizationArgs
options? Options

Returns

Promise\<SummarizationOutput>

Inherited from

InferenceClient.summarization

Defined in

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

tableQuestionAnswering

▸ tableQuestionAnswering(args, options?): Promise\<TableQuestionAnsweringOutput[number]>

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

Parameters

名称 类型
args TableQuestionAnsweringArgs
options? Options

Returns

Promise\<TableQuestionAnsweringOutput[number]>

Inherited from

InferenceClient.tableQuestionAnswering

Defined in

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

tabularClassification

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

根据给定的表格形式特征集预测目标标签。通常，您会希望在训练数据上训练一个分类模型，并将其与相同格式的新数据一起使用。示例模型：vvmnnnkv/wine-quality

Parameters

名称 类型
args TabularClassificationArgs
options? Options

Returns

Promise\<TabularClassificationOutput>

继承自

InferenceClient.tabularClassification

定义于

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

tabularRegression

▸ tabularRegression(args, options?): Promise\<TabularRegressionOutput>

为给定表格形式的特征集预测目标值。通常，您会希望在训练数据上训练回归模型，并将其与格式相同的新数据一起使用。示例模型：scikit-learn/Fish-Weight

参数

名称 类型
args TabularRegressionArgs
options? Options

返回

Promise\<TabularRegressionOutput>

继承自

InferenceClient.tabularRegression

定义于

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

textClassification

▸ textClassification(args, options?): Promise\<TextClassificationOutput>

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

参数

名称 类型
args TextClassificationArgs
options? Options

返回

Promise\<TextClassificationOutput>

继承自

InferenceClient.textClassification

定义于

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

textGeneration

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

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

参数

名称 类型
args BaseArgs & TextGenerationInput
options? Options

返回

Promise\<TextGenerationOutput>

继承自

InferenceClient.textGeneration

定义于

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

textGenerationStream

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

用于从提示继续文本。与 textGeneration 相同，但返回一个可一次读取一个 token 的生成器

参数

名称 类型
args BaseArgs & TextGenerationInput
options? Options

返回

AsyncGenerator\<TextGenerationStreamOutput>

继承自

InferenceClient.textGenerationStream

定义于

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

textToImage

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

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

参数

名称 类型
args TextToImageArgs
options? TextToImageOptions & { outputType: "url" }

返回

Promise\<string>

继承自

InferenceClient.textToImage

定义于

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

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

参数

名称 类型
args TextToImageArgs
options? TextToImageOptions & { outputType?: "blob" }

返回

Promise\<Blob>

继承自

InferenceClient.textToImage

定义于

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

▸ textToImage(args, options?): Promise\<Record\<string, unknown>>

参数

名称 类型
args TextToImageArgs
options? TextToImageOptions & { outputType?: "json" }

返回

Promise\<Record\<string, unknown>>

继承自

InferenceClient.textToImage

定义于

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

textToSpeech

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

此任务合成语音音频，发出给定文本。推荐模型：espnet/kan-bayashi_ljspeech_vits

参数

名称 类型
args TextToSpeechArgs
options? Options

返回

Promise\<Blob>

继承自

InferenceClient.textToSpeech

定义于

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

textToVideo

▸ textToVideo(args, options?): Promise\<TextToVideoOutput>

参数

名称 类型
args TextToVideoArgs
options? Options

返回

Promise\<TextToVideoOutput>

继承自

InferenceClient.textToVideo

定义于

inference/src/tasks/cv/textToVideo.ts:15

tokenClassification

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

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

参数

名称 类型
args TokenClassificationArgs
options? Options

返回

Promise\<TokenClassificationOutput>

继承自

InferenceClient.tokenClassification

定义于

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

translation

▸ translation(args, options?): Promise\<TranslationOutput>

此任务众所周知可将文本从一种语言翻译成另一种语言。推荐模型：Helsinki-NLP/opus-mt-ru-en。

参数

名称 类型
args TranslationArgs
options? Options

返回

Promise\<TranslationOutput>

继承自

InferenceClient.translation

定义于

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

visualQuestionAnswering

▸ visualQuestionAnswering(args, options?): Promise\<VisualQuestionAnsweringOutput[number]>

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

参数

名称 类型
args VisualQuestionAnsweringArgs
options? Options

返回

Promise\<VisualQuestionAnsweringOutput[number]>

继承自

InferenceClient.visualQuestionAnswering

定义于

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

zeroShotClassification

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

此任务在零代码的情况下进行分类非常有用，您只需传递一个句子/段落和该句子的可能标签，即可获得结果。推荐模型：facebook/bart-large-mnli。

参数

名称 类型
args ZeroShotClassificationArgs
options? Options

返回

Promise\<ZeroShotClassificationOutput>

继承自

InferenceClient.zeroShotClassification

定义于

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

zeroShotImageClassification

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

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

参数

名称 类型
args ZeroShotImageClassificationArgs
options? Options

返回

Promise\<ZeroShotImageClassificationOutput>

继承自

InferenceClient.zeroShotImageClassification

定义于

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

< > 在 GitHub 上更新

←InferenceClient InferenceClientError→