Huggingface.js documentation

@huggingface/inference

Huggingface.js

Join the Hugging Face community

and get access to the augmented documentation experience

Collaborate on models, datasets and Spaces

Faster examples with accelerated inference

Switch between documentation themes

to get started

@huggingface/inference

命名空间

代码片段

类

接口

类型别名

AudioClassificationArgs

Ƭ AudioClassificationArgs：BaseArgs & AudioClassificationInput | LegacyAudioInput

定义于

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

AudioToAudioArgs

Ƭ AudioToAudioArgs：BaseArgs & { inputs：Blob } | LegacyAudioInput

定义于

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

AuthMethod

Ƭ AuthMethod： "none" | "hf-token" | "credentials-include" | "provider-key"

定义于

inference/src/types.ts:165

AutomaticSpeechRecognitionArgs

Ƭ AutomaticSpeechRecognitionArgs：BaseArgs & AutomaticSpeechRecognitionInput | LegacyAudioInput

定义于

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

DocumentQuestionAnsweringArgs

Ƭ DocumentQuestionAnsweringArgs：BaseArgs & DocumentQuestionAnsweringInput & { inputs：DocumentQuestionAnsweringInputData & { image：Blob } }

定义于

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

FeatureExtractionArgs

Ƭ FeatureExtractionArgs：BaseArgs & FeatureExtractionInput & FeatureExtractionOAICompatInput

定义于

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

FeatureExtractionOutput

Ƭ FeatureExtractionOutput：(number | number[] | number[][])[]

返回值为一个多维浮点数数组（其维度取决于您传入的是字符串还是字符串列表，以及是否已为您应用了自动归约操作，例如 mean_pooling。这一点应在模型的 README 中加以说明）。

定义于

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

FillMaskArgs

Ƭ FillMaskArgs：BaseArgs & FillMaskInput

定义于

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

ImageClassificationArgs

Ƭ ImageClassificationArgs：BaseArgs & ImageClassificationInput | LegacyImageInput

定义于

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

ImageSegmentationArgs

Ƭ ImageSegmentationArgs：BaseArgs & ImageSegmentationInput

定义于

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

ImageTextToImageArgs

Ƭ ImageTextToImageArgs：BaseArgs & ImageTextToImageInput

定义于

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

ImageTextToVideoArgs

Ƭ ImageTextToVideoArgs：BaseArgs & ImageTextToVideoInput

定义于

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

ImageToImageArgs

Ƭ ImageToImageArgs：BaseArgs & ImageToImageInput

定义于

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

ImageToTextArgs

Ƭ ImageToTextArgs：BaseArgs & ImageToTextInput | LegacyImageInput

定义于

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

ImageToVideoArgs

Ƭ ImageToVideoArgs：BaseArgs & ImageToVideoInput

定义于

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

InferenceProvider

Ƭ InferenceProvider：typeof INFERENCE_PROVIDERS[number]

定义于

inference/src/types.ts:73

InferenceProviderOrPolicy

Ƭ InferenceProviderOrPolicy：typeof PROVIDERS_OR_POLICIES[number]

定义于

inference/src/types.ts:75

InferenceTask

Ƭ InferenceTask： Exclude<PipelineType, "other"> | "conversational"

定义于

inference/src/types.ts:45

ModelId

Ƭ ModelId: string

HF 模型 ID，例如“meta-llama/Llama-3.3-70B-Instruct”

定义于

inference/src/types.ts:6

ObjectDetectionArgs

Ƭ ObjectDetectionArgs：BaseArgs & ObjectDetectionInput | LegacyImageInput

定义于

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

OutputType

Ƭ OutputType： "url" | "dataUrl" | "blob" | "json"

定义于

inference/src/types.ts:179

QuestionAnsweringArgs

Ƭ QuestionAnsweringArgs：BaseArgs & QuestionAnsweringInput

定义于

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

RequestArgs

Ƭ RequestArgs: BaseArgs & { data: Blob | ArrayBuffer } | { inputs: unknown } | { prompt: string } | { text: string } | { audio_url: string } | ChatCompletionInput & { parameters?: Record<string, unknown> ; urlTransform?: (url: string) => string }

定义于

inference/src/types.ts:152

SentenceSimilarityArgs

Ƭ SentenceSimilarityArgs：BaseArgs & SentenceSimilarityInput

定义于

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

SummarizationArgs

Ƭ SummarizationArgs：BaseArgs & SummarizationInput

定义于

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

TableQuestionAnsweringArgs

Ƭ TableQuestionAnsweringArgs：BaseArgs & TableQuestionAnsweringInput

定义于

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

TabularClassificationArgs

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

定义于

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

TabularClassificationOutput

Ƭ TabularClassificationOutput：number[]

每行预测标签的列表

定义于

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

TabularRegressionArgs

Ƭ TabularRegressionArgs：BaseArgs & { inputs：{ data：Record<string, string[]> } }

定义于

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

TabularRegressionOutput

Ƭ TabularRegressionOutput：number[]

每行预测值的列表

定义于

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

TextClassificationArgs

Ƭ TextClassificationArgs：BaseArgs & TextClassificationInput

定义于

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

TextGenerationStreamFinishReason

Ƭ TextGenerationStreamFinishReason："length" | "eos_token" | "stop_sequence"

定义于

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

TextRankingArgs

Ƭ TextRankingArgs：BaseArgs & TextRankingInput

定义于

inference/src/tasks/nlp/textRanking.ts:7

TextToAudioArgs

Ƭ TextToAudioArgs：BaseArgs & TextToAudioInput

定义于

inference/src/tasks/audio/textToAudio.ts:8

TextToImageArgs

Ƭ TextToImageArgs：BaseArgs & TextToImageInput

定义于

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

TextToVideoArgs

Ƭ TextToVideoArgs：BaseArgs & TextToVideoInput

定义于

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

TextToVideoOutput

Ƭ TextToVideoOutput：Blob

定义于

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

TokenClassificationArgs

Ƭ TokenClassificationArgs：BaseArgs & TokenClassificationInput

定义于

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

TranslationArgs

Ƭ TranslationArgs：BaseArgs & TranslationInput

定义于

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

VisualQuestionAnsweringArgs

Ƭ VisualQuestionAnsweringArgs: BaseArgs & VisualQuestionAnsweringInput & { inputs: VisualQuestionAnsweringInputData & { image: Blob } }

定义于

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

ZeroShotClassificationArgs

Ƭ ZeroShotClassificationArgs：BaseArgs & ZeroShotClassificationInput

定义于

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

ZeroShotImageClassificationArgs

Ƭ ZeroShotImageClassificationArgs：BaseArgs & ZeroShotImageClassificationInput | LegacyZeroShotImageClassificationInput

定义于

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

变量

推理 _ 提供商

• Const INFERENCE_PROVIDERS：只读 ["baseten", "cerebras", "cohere", "deepinfra", "fal-ai", "featherless-ai", "fireworks-ai", "groq", "hf-inference", "humain-ai", "novita", "nscale", "openai", "openrouter", "ovhcloud", "publicai", "replicate", "scaleway", "together", "wavespeed", "zai-org"]

定义于

inference/src/types.ts:47

PROVIDERS

• Const PROVIDERS： Record<InferenceProvider, Partial<Record<InferenceTask, TaskProviderHelper>>>

定义于

inference/src/lib/getProviderHelper.ts:61

PROVIDERS _ HUB _ ORGS

• Const PROVIDERS_HUB_ORGS： Record<InferenceProvider, string>

HF Hub 上的组织命名空间，即 hf.co/…

在可能的情况下，InferenceProvider 应该 == org 命名空间

定义于

inference/src/types.ts:82

PROVIDERS _ OR _ POLICIES

• Const PROVIDERS_OR_POLICIES：只读 ["baseten", "cerebras", "cohere", "deepinfra", "fal-ai", "featherless-ai", "fireworks-ai", "groq", "hf-inference", "humain-ai", "novita", "nscale", "openai", "openrouter", "ovhcloud", "publicai", "replicate", "scaleway", "together", "wavespeed", "zai-org", "auto"]

定义于

inference/src/types.ts:71

函数

audioClassification

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

此任务读取一些音频输入并输出各类别的似然值。推荐模型：superb/hubert-large-superb-er

参数

名称	类型
`args`	`AudioClassificationArgs`
`options?`	`Options`

Promise<AudioClassificationOutput>

定义于

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

audioToAudio

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

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

参数

名称	类型
`args`	`AudioToAudioArgs`
`options?`	`Options`

Promise<AudioToAudioOutput[]>

定义于

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

automaticSpeechRecognition

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

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

参数

名称	类型
`args`	`AutomaticSpeechRecognitionArgs`
`options?`	`Options`

Promise<AutomaticSpeechRecognitionOutput>

定义于

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

chatCompletion

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

使用聊天补全端点，通过 OpenAI 消息补全 API（无流式）生成对提示的响应

参数

名称	类型
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Promise<ChatCompletionOutput>

定义于

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

chatCompletionStream

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

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

参数

名称	类型
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

AsyncGenerator<ChatCompletionStreamOutput>

定义于

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

documentQuestionAnswering

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

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

参数

名称	类型
`args`	`DocumentQuestionAnsweringArgs`
`options?`	`Options`

Promise<DocumentQuestionAnsweringOutput[number]>

定义于

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

featureExtraction

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

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

参数

名称	类型
`args`	`FeatureExtractionArgs`
`options?`	`Options`

Promise<FeatureExtractionOutput>

定义于

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

fillMask

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

尝试用缺失的单词（准确地说是 token）来填补一个空缺。这是 BERT 模型的基础任务。

参数

名称	类型
`args`	`FillMaskArgs`
`options?`	`Options`

Promise<FillMaskOutput>

定义于

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

getProviderHelper

▸ getProviderHelper(provider, task): TextToImageTaskHelper & TaskProviderHelper

按名称和任务获取提供商辅助实例

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"text-to-image"`

TextToImageTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:201

▸ getProviderHelper(provider, task): ConversationalTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"conversational"`

ConversationalTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:205

▸ getProviderHelper(provider, task): TextGenerationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"text-generation"`

TextGenerationTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:209

▸ getProviderHelper(provider, task): TextToSpeechTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"text-to-speech"`

TextToSpeechTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:213

▸ getProviderHelper(provider, task): TextToAudioTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"text-to-audio"`

TextToAudioTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:217

▸ getProviderHelper(provider, task): AutomaticSpeechRecognitionTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"automatic-speech-recognition"`

AutomaticSpeechRecognitionTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:221

▸ getProviderHelper(provider, task): TextToVideoTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"text-to-video"`

TextToVideoTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:225

▸ getProviderHelper(provider, task): TextClassificationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"text-classification"`

TextClassificationTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:229

▸ getProviderHelper(provider, task): QuestionAnsweringTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"question-answering"`

QuestionAnsweringTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:233

▸ getProviderHelper(provider, task): AudioClassificationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"audio-classification"`

AudioClassificationTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:237

▸ getProviderHelper(provider, task): AudioToAudioTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"audio-to-audio"`

AudioToAudioTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:241

▸ getProviderHelper(provider, task): FillMaskTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"fill-mask"`

FillMaskTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:245

▸ getProviderHelper(provider, task): FeatureExtractionTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"feature-extraction"`

FeatureExtractionTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:249

▸ getProviderHelper(provider, task): ImageClassificationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"image-classification"`

ImageClassificationTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:253

▸ getProviderHelper(provider, task): ImageSegmentationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"image-segmentation"`

ImageSegmentationTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:257

▸ getProviderHelper(provider, task): DocumentQuestionAnsweringTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"document-question-answering"`

DocumentQuestionAnsweringTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:261

▸ getProviderHelper(provider, task): ImageToTextTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"image-to-text"`

ImageToTextTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:265

▸ getProviderHelper(provider, task): ObjectDetectionTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"object-detection"`

ObjectDetectionTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:269

▸ getProviderHelper(provider, task): ZeroShotImageClassificationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"zero-shot-image-classification"`

ZeroShotImageClassificationTaskHelper & TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:273

▸ getProviderHelper(provider, task): ZeroShotClassificationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"zero-shot-classification"`

ZeroShotClassificationTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:277

▸ getProviderHelper(provider, task): ImageToImageTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"image-to-image"`

ImageToImageTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:281

▸ getProviderHelper(provider, task): ImageToVideoTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"image-to-video"`

ImageToVideoTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:285

▸ getProviderHelper(provider, task): ImageTextToImageTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"image-text-to-image"`

ImageTextToImageTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:289

▸ getProviderHelper(provider, task): ImageTextToVideoTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"image-text-to-video"`

ImageTextToVideoTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:293

▸ getProviderHelper(provider, task): TextRankingTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"text-ranking"`

TextRankingTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:297

▸ getProviderHelper(provider, task): SentenceSimilarityTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"sentence-similarity"`

SentenceSimilarityTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:301

▸ getProviderHelper(provider, task): TableQuestionAnsweringTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"table-question-answering"`

TableQuestionAnsweringTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:305

▸ getProviderHelper(provider, task): TabularClassificationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"tabular-classification"`

TabularClassificationTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:309

▸ getProviderHelper(provider, task): TabularRegressionTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"tabular-regression"`

TabularRegressionTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:313

▸ getProviderHelper(provider, task): TokenClassificationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"token-classification"`

TokenClassificationTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:317

▸ getProviderHelper(provider, task): TranslationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"translation"`

TranslationTaskHelper & TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:321

▸ getProviderHelper(provider, task): SummarizationTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"summarization"`

SummarizationTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:325

▸ getProviderHelper(provider, task): VisualQuestionAnsweringTaskHelper & TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`"visual-question-answering"`

VisualQuestionAnsweringTaskHelper 和 TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:329

▸ getProviderHelper(provider, task): TaskProviderHelper

参数

名称	类型
`provider`	`"baseten"` \| `"cerebras"` \| `"cohere"` \| `"deepinfra"` \| `"fal-ai"` \| `"featherless-ai"` \| `"fireworks-ai"` \| `"groq"` \| `"hf-inference"` \| `"humain-ai"` \| `"novita"` \| `"nscale"` \| `"openai"` \| `"openrouter"` \| `"ovhcloud"` \| `"publicai"` \| `"replicate"` \| `"scaleway"` \| `"together"` \| `"wavespeed"` \| `"zai-org"` \| `"auto"`
`task`	`undefined` \| `InferenceTask`

TaskProviderHelper

定义于

inference/src/lib/getProviderHelper.ts:333

imageClassification

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

此任务读取一些图像输入并输出各类别的似然值。推荐模型：google/vit-base-patch16-224

参数

名称	类型
`args`	`ImageClassificationArgs`
`options?`	`Options`

Promise<ImageClassificationOutput>

定义于

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

imageSegmentation

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

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

参数

名称	类型
`args`	`ImageSegmentationArgs`
`options?`	`Options`

Promise<ImageSegmentationOutput>

定义于

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

imageTextToImage

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

该任务接收图像和文本输入，并输出新生成的图像。推荐模型：black-forest-labs/FLUX.2-dev

参数

名称	类型
`args`	`ImageTextToImageArgs`
`options?`	`Options`

Promise<Blob>

定义于

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

imageTextToVideo

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

该任务接收图像和文本输入，并输出生成的视频。推荐模型：Lightricks/LTX-Video

参数

名称	类型
`args`	`ImageTextToVideoArgs`
`options?`	`Options`

Promise<Blob>

定义于

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

imageToImage

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

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

参数

名称	类型
`args`	`ImageToImageArgs`
`options?`	`Options`

Promise<Blob>

定义于

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

imageToText

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

此任务读取一些图像输入并输出文本说明。

参数

名称	类型
`args`	`ImageToTextArgs`
`options?`	`Options`

Promise<ImageToTextOutput>

定义于

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

imageToVideo

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

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

参数

名称	类型
`args`	`ImageToVideoArgs`
`options?`	`Options`

Promise<Blob>

定义于

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

makeRequestOptions

▸ makeRequestOptions(args, providerHelper, options?): Promise<{ info: RequestInit ; url: string }>

用于准备请求参数的辅助函数。此异步版本处理模型 ID 解析步骤。

参数

名称	类型
`args`	`RequestArgs` & { `data?`: `Blob` \| `ArrayBuffer` ; `stream?`: `boolean` }
`providerHelper`	`TaskProviderHelper`
`options?`	`Options` & { `task?`: `InferenceTask` }

Promise<{ info: RequestInit ; url: string }>

定义于

inference/src/lib/makeRequestOptions.ts:19

makeRequestOptionsFromResolvedModel

▸ makeRequestOptionsFromResolvedModel(resolvedModel, providerHelper, args, mapping, options?): Object

用于准备请求参数的辅助函数。 - 仅供内部使用此同步版本会跳过模型 ID 解析步骤

参数

名称	类型
`resolvedModel`	`string`
`providerHelper`	`TaskProviderHelper`
`args`	`RequestArgs` & { `data?`: `Blob` \| `ArrayBuffer` ; `stream?`: `boolean` }
`mapping`	`undefined` \| `InferenceProviderMappingEntry`
`options?`	`Options` & { `outputType?`: `OutputType` ; `task?`: `InferenceTask` }

Object

名称	类型
`info`	`RequestInit`
`url`	`string`

定义于

inference/src/lib/makeRequestOptions.ts:105

objectDetection

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

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

参数

名称	类型
`args`	`ObjectDetectionArgs`
`options?`	`Options`

Promise<ObjectDetectionOutput>

定义于

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

questionAnswering

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

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

参数

名称	类型
`args`	`QuestionAnsweringArgs`
`options?`	`Options`

Promise<QuestionAnsweringOutput[number]>

定义于

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

request

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

用于向推理提供商发起自定义调用的原语

类型参数

名称
`T`

参数

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

Promise<T>

Deprecated

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

定义于

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

sentenceSimilarity

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

通过比较它们的嵌入，计算一段文本与一组其他句子之间的语义相似度。

参数

名称	类型
`args`	`SentenceSimilarityArgs`
`options?`	`Options`

Promise<SentenceSimilarityOutput>

定义于

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

setLogger

▸ setLogger(logger): void

参数

名称	类型
`logger`	`Logger`

void

定义于

inference/src/lib/logger.ts:5

streamingRequest

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

…

类型参数

名称
`T`

参数

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

AsyncGenerator<T>

Deprecated

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

定义于

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

摘要

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

该任务旨在将较长的文本概括为较短的文本。请注意，某些模型对输入长度有上限，这意味着摘要功能无法处理整本书等超长文本。选择模型时请务必留意这一点。

参数

名称	类型
`args`	`SummarizationArgs`
`options?`	`Options`

Promise<SummarizationOutput>

定义于

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

tableQuestionAnswering

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

不懂 SQL？不想深入处理大型电子表格？直接用自然语言提问即可！推荐模型：google/tapas-base-finetuned-wtq。

参数

名称	类型
`args`	`TableQuestionAnsweringArgs`
`options?`	`Options`

Promise<TableQuestionAnsweringOutput[number]>

定义于

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

tabularClassification

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

预测给定表格形式特征集的目标标签。通常，您需要在训练数据上训练一个分类模型，并使用该模型处理具有相同格式的新数据。示例模型：vvmnnnkv/wine-quality

参数

名称	类型
`args`	`TabularClassificationArgs`
`options?`	`Options`

Promise<TabularClassificationOutput>

定义于

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

tabularRegression

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

预测给定表格形式特征集的目标值。通常，您需要在训练数据上训练一个回归模型，并使用该模型处理具有相同格式的新数据。示例模型：scikit-learn/Fish-Weight

参数

名称	类型
`args`	`TabularRegressionArgs`
`options?`	`Options`

Promise<TabularRegressionOutput>

定义于

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>

定义于

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

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 相同，但返回一个生成器，可以逐个 token 读取。

参数

名称	类型
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

AsyncGenerator<TextGenerationStreamOutput>

定义于

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

textRanking

▸ textRanking(args, options?): Promise<TextRankingOutput>

使用重排序模型根据查询对文档的相关性进行排序。

参数

名称	类型
`args`	`TextRankingArgs`
`options?`	`Options`

Promise<TextRankingOutput>

定义于

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

textToAudio

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

此任务根据输入的文本提示生成音频（例如音乐或音效）。示例模型：stabilityai/stable-audio-open-1.0

参数

名称	类型
`args`	`TextToAudioArgs`
`options?`	`Options`

Promise<Blob>

定义于

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

textToImage

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

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

参数

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

Promise<string>

定义于

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

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

参数

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

Promise<string>

定义于

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

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

参数

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

Promise<Blob>

定义于

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

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

参数

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

Promise<Record<string, unknown>>

定义于

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

textToSpeech

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

此任务用于合成一段语音，该语音将朗读给定的文本。推荐模型：espnet/kan-bayashi_ljspeech_vits

参数

名称	类型
`args`	`TextToSpeechArgs`
`options?`	`Options`

Promise<Blob>

定义于

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

textToVideo

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

参数

名称	类型
`args`	`TextToVideoArgs`
`options?`	`Options`

Promise<TextToVideoOutput>

定义于

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>

定义于

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

translation

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

该任务旨在将文本从一种语言翻译为另一种语言。推荐模型：Helsinki-NLP/opus-mt-ru-en。

参数

名称	类型
`args`	`TranslationArgs`
`options?`	`Options`

Promise<TranslationOutput>

定义于

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]>

定义于

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

zeroShotClassification

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

该任务对于零代码尝试分类非常有用，您只需传入一个句子/段落及其可能的标签，即可获得结果。推荐模型：facebook/bart-large-mnli。

参数

名称	类型
`args`	`ZeroShotClassificationArgs`
`options?`	`Options`

Promise<ZeroShotClassificationOutput>

定义于

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>

定义于

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

Update on GitHub

←使用 Inference Client HfInference→