Huggingface.js 文件
類：HfInference
並獲得增強的文件體驗
開始使用
類：HfInference
僅用於向後相容，即將移除。
已棄用
請替換為 InferenceClient
層級結構
-
↳
HfInference
建構函式
建構函式
• new HfInference(accessToken?, defaultOptions?): HfInference
引數
| 名稱 | 型別 | 預設值 |
|---|---|---|
訪問令牌 | 字串 | "" |
預設選項 | Options & { endpointUrl?: string } | {} |
返回值
繼承自
定義於
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[]>
繼承自
定義於
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 | 字串 |
返回值
繼承自
定義於
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(args, options?): Promise\<FillMaskOutput>
嘗試用缺失的單詞（準確地說是標記）填充空白。這是 BERT 模型的基本任務。
引數
| 名稱 | 型別 |
|---|---|
args | FillMaskArgs |
options? | Options |
返回值
Promise\<FillMaskOutput>
繼承自
定義於
inference/src/tasks/nlp/fillMask.ts:12
影像分類
▸ imageClassification(args, options?): Promise\<ImageClassificationOutput>
此任務讀取影像輸入並輸出類別的可能性。推薦模型：google/vit-base-patch16-224
引數
| 名稱 | 型別 |
|---|---|
args | ImageClassificationArgs |
options? | Options |
返回值
Promise\<ImageClassificationOutput>
繼承自
InferenceClient.imageClassification
定義於
inference/src/tasks/cv/imageClassification.ts:14
imageSegmentation
▸ imageSegmentation(args, options?): Promise\<ImageSegmentationOutput>
此任務讀取影像輸入並輸出檢測到物件的類別可能性和邊界框。推薦模型：facebook/detr-resnet-50-panoptic
引數
| 名稱 | 型別 |
|---|---|
args | ImageSegmentationArgs |
options? | Options |
返回值
Promise\<ImageSegmentationOutput>
繼承自
InferenceClient.imageSegmentation
定義於
inference/src/tasks/cv/imageSegmentation.ts:14
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:13
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
objectDetection
▸ objectDetection(args, options?): Promise\<ObjectDetectionOutput>
此任務讀取影像輸入並輸出檢測到物件的類別可能性和邊界框。推薦模型：facebook/detr-resnet-50
引數
| 名稱 | 型別 |
|---|---|
args | ObjectDetectionArgs |
options? | Options |
返回值
Promise\<ObjectDetectionOutput>
繼承自
InferenceClient.objectDetection
定義於
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]>
繼承自
InferenceClient.questionAnswering
定義於
inference/src/tasks/nlp/questionAnswering.ts:13
request
▸ request\<T>(args, options?): Promise\<T>
用於向推理提供者進行自定義呼叫的原語
型別引數
| 名稱 |
|---|
T |
引數
| 名稱 | 型別 |
|---|---|
args | RequestArgs |
options? | Options & { task?: InferenceTask } |
返回值
Promise\<T>
已棄用
請改用特定的任務函式。此函式將在未來版本中移除。
繼承自
定義於
inference/src/tasks/custom/request.ts:11
sentenceSimilarity
▸ sentenceSimilarity(args, options?): Promise\<SentenceSimilarityOutput>
透過比較嵌入來計算一段文字與另一組句子之間的語義相似度。
引數
| 名稱 | 型別 |
|---|---|
args | SentenceSimilarityArgs |
options? | Options |
返回值
Promise\<SentenceSimilarityOutput>
繼承自
InferenceClient.sentenceSimilarity
定義於
inference/src/tasks/nlp/sentenceSimilarity.ts:12
streamingRequest
▸ streamingRequest\<T>(args, options?): AsyncGenerator\<T>
用於進行自定義推理呼叫的原語，該呼叫期望伺服器傳送事件，並透過生成器返回響應
型別引數
| 名稱 |
|---|
T |
引數
| 名稱 | 型別 |
|---|---|
args | RequestArgs |
options? | Options & { task?: InferenceTask } |
返回值
AsyncGenerator\<T>
已棄用
請改用特定的任務函式。此函式將在未來版本中移除。
繼承自
InferenceClient.streamingRequest
定義於
inference/src/tasks/custom/streamingRequest.ts:11
summarization
▸ summarization(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]>
繼承自
InferenceClient.tableQuestionAnswering
定義於
inference/src/tasks/nlp/tableQuestionAnswering.ts:12
tabularClassification
▸ tabularClassification(args, options?): Promise\<TabularClassificationOutput>
根據給定的表格形式特徵集預測目標標籤。通常，您會希望在訓練資料上訓練一個分類模型，並將其與相同格式的新資料一起使用。示例模型：vvmnnnkv/wine-quality
引數
| 名稱 | 型別 |
|---|---|
args | TabularClassificationArgs |
options? | Options |
返回值
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>
繼承自
定義於
inference/src/tasks/cv/textToImage.ts:18
▸ textToImage(args, options?): Promise\<Blob>
引數
| 名稱 | 型別 |
|---|---|
args | TextToImageArgs |
options? | TextToImageOptions & { outputType?: "blob" } |
返回
Promise\<Blob>
繼承自
定義於
inference/src/tasks/cv/textToImage.ts:22
▸ textToImage(args, options?): Promise\<Record\<string, unknown>>
引數
| 名稱 | 型別 |
|---|---|
args | TextToImageArgs |
options? | TextToImageOptions & { outputType?: "json" } |
返回
Promise\<Record\<string, unknown>>
繼承自
定義於
inference/src/tasks/cv/textToImage.ts:26
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>
繼承自
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>
繼承自
定義於
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 上更新