Huggingface.js documentation

Lớp: InferenceClient

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

Lớp: InferenceClient

Hệ thống phân cấp

Task

↳ InferenceClient

↳↳ InferenceClientEndpoint

↳↳ HfInference

Hàm khởi tạo

constructor

• mới InferenceClient(accessToken?, defaultOptions?): InferenceClient

Tham số

Tên	Loại	Giá trị mặc định
`accessToken`	`string`	`""`
`defaultOptions`	`Options` & { `endpointUrl?`: `string` }	`{}`

Trả về

InferenceClient

Được định nghĩa trong

inference/src/InferenceClient.ts:15

Thuộc tính

accessToken

• Private Readonly accessToken: string

Được định nghĩa trong

inference/src/InferenceClient.ts:12

defaultOptions

• Private Readonly defaultOptions: Options

Được định nghĩa trong

inference/src/InferenceClient.ts:13

Phương thức

audioClassification

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

Nhiệm vụ này đọc một số đầu vào âm thanh và đưa ra xác suất của các lớp. Mô hình được khuyến nghị: superb/hubert-large-superb-er

Tham số

Tên	Loại
`args`	`AudioClassificationArgs`
`options?`	`Options`

Trả về

Promise<AudioClassificationOutput>

Được định nghĩa trong

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

audioToAudio

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

Nhiệm vụ này đọc một số đầu vào âm thanh và xuất ra một hoặc nhiều tệp âm thanh. Mô hình ví dụ: speechbrain/sepformer-wham thực hiện tách nguồn âm thanh.

Tham số

Tên	Loại
`args`	`AudioToAudioArgs`
`options?`	`Options`

Trả về

Promise<AudioToAudioOutput[]>

Được định nghĩa trong

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

automaticSpeechRecognition

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

Nhiệm vụ này đọc một số đầu vào âm thanh và xuất ra các từ được nói trong các tệp âm thanh. Mô hình được khuyến nghị (tiếng Anh): facebook/wav2vec2-large-960h-lv60-self

Tham số

Tên	Loại
`args`	`AutomaticSpeechRecognitionArgs`
`options?`	`Options`

Trả về

Promise<AutomaticSpeechRecognitionOutput>

Được định nghĩa trong

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

chatCompletion

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

Sử dụng điểm cuối hoàn thành trò chuyện để tạo phản hồi cho một lời nhắc, bằng cách sử dụng API hoàn thành tin nhắn OpenAI không có luồng

Tham số

Tên	Loại
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Trả về

Promise<ChatCompletionOutput>

Được định nghĩa trong

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

chatCompletionStream

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

Dùng để tiếp tục văn bản từ một prompt. Giống như textGeneration nhưng trả về generator có thể đọc từng token một

Tham số

Tên	Loại
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Trả về

AsyncGenerator<ChatCompletionStreamOutput>

Được định nghĩa trong

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

documentQuestionAnswering

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

Trả lời câu hỏi trên ảnh tài liệu. Mô hình được khuyến nghị: impira/layoutlm-document-qa.

Tham số

Tên	Loại
`args`	`DocumentQuestionAnsweringArgs`
`options?`	`Options`

Trả về

Promise<DocumentQuestionAnsweringOutput[number]>

Được định nghĩa trong

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

endpoint

▸ endpoint(endpointUrl): InferenceClient

Trả về một instance mới của InferenceClient được liên kết với một endpoint được chỉ định.

Chủ yếu là để đảm bảo tính tương thích ngược.

Tham số

Tên	Loại
`endpointUrl`	`string`

Trả về

InferenceClient

Được định nghĩa trong

inference/src/InferenceClient.ts:46

featureExtraction

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

Nhiệm vụ này đọc một số văn bản và xuất ra các giá trị float thô, thường được sử dụng như một phần của cơ sở dữ liệu ngữ nghĩa/tìm kiếm ngữ nghĩa.

Tham số

Tên	Loại
`args`	`FeatureExtractionArgs`
`options?`	`Options`

Trả về

Promise<FeatureExtractionOutput>

Được định nghĩa trong

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

fillMask

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

Thử điền vào một khoảng trống bằng một từ bị thiếu (chính xác hơn là một token). Đây là tác vụ cơ bản cho các mô hình BERT.

Tham số

Tên	Loại
`args`	`FillMaskArgs`
`options?`	`Options`

Trả về

Promise<FillMaskOutput>

Được định nghĩa trong

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

imageClassification

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

Nhiệm vụ này đọc một số đầu vào hình ảnh và đưa ra xác suất của các lớp. Mô hình được khuyến nghị: google/vit-base-patch16-224

Tham số

Tên	Loại
`args`	`ImageClassificationArgs`
`options?`	`Options`

Trả về

Promise<ImageClassificationOutput>

Được định nghĩa trong

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

imageSegmentation

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

Nhiệm vụ này đọc một số đầu vào hình ảnh và đưa ra xác suất của các lớp & các hộp bao quanh các đối tượng được phát hiện. Mô hình được khuyến nghị: facebook/detr-resnet-50-panoptic

Tham số

Tên	Loại
`args`	`ImageSegmentationArgs`
`options?`	`Options`

Trả về

Promise<ImageSegmentationOutput>

Được định nghĩa trong

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

imageTextToImage

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

Nhiệm vụ này nhận đầu vào là hình ảnh và văn bản, sau đó tạo ra một hình ảnh mới. Mô hình được khuyến nghị: black-forest-labs/FLUX.2-dev

Tham số

Tên	Loại
`args`	`ImageTextToImageArgs`
`options?`	`Options`

Trả về

Promise<Blob>

Được định nghĩa trong

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

imageTextToVideo

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

Nhiệm vụ này nhận đầu vào là hình ảnh và văn bản, sau đó tạo ra một video. Mô hình được khuyến nghị: Lightricks/LTX-Video

Tham số

Tên	Loại
`args`	`ImageTextToVideoArgs`
`options?`	`Options`

Trả về

Promise<Blob>

Được định nghĩa trong

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

imageToImage

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

Nhiệm vụ này đọc một số đầu vào văn bản và xuất ra một hình ảnh. Mô hình được khuyến nghị: lllyasviel/sd-controlnet-depth

Tham số

Tên	Loại
`args`	`ImageToImageArgs`
`options?`	`Options`

Trả về

Promise<Blob>

Được định nghĩa trong

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

imageToText

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

Nhiệm vụ này đọc một số đầu vào hình ảnh và xuất ra chú thích văn bản.

Tham số

Tên	Loại
`args`	`ImageToTextArgs`
`options?`	`Options`

Trả về

Promise<ImageToTextOutput>

Được định nghĩa trong

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

imageToVideo

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

Nhiệm vụ này đọc một số đầu vào văn bản và xuất ra một hình ảnh. Mô hình được khuyến nghị: Wan-AI/Wan2.1-I2V-14B-720P

Tham số

Tên	Loại
`args`	`ImageToVideoArgs`
`options?`	`Options`

Trả về

Promise<Blob>

Được định nghĩa trong

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

objectDetection

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

Nhiệm vụ này đọc một số đầu vào hình ảnh và đưa ra xác suất của các lớp & các hộp bao quanh các đối tượng được phát hiện. Mô hình được khuyến nghị: facebook/detr-resnet-50

Tham số

Tên	Loại
`args`	`ObjectDetectionArgs`
`options?`	`Options`

Trả về

Promise<ObjectDetectionOutput>

Được định nghĩa trong

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

questionAnswering

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

Bạn muốn có một bot thông thái có thể trả lời mọi câu hỏi? Mô hình được đề xuất: deepset/roberta-base-squad2

Tham số

Tên	Loại
`args`	`QuestionAnsweringArgs`
`options?`	`Options`

Trả về

Promise<QuestionAnsweringOutput[number]>

Được định nghĩa trong

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

request

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

Primitive để thực hiện các cuộc gọi tùy chỉnh đến nhà cung cấp suy luận

Tham số kiểu

Tên
`T`

Tham số

Tên	Loại
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Trả về

Promise<T>

Deprecated

Hãy sử dụng các hàm tác vụ cụ thể thay thế. Hàm này sẽ bị loại bỏ trong một phiên bản tương lai.

Được định nghĩa trong

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

sentenceSimilarity

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

Tính độ tương đồng ngữ nghĩa giữa một văn bản và danh sách các câu khác bằng cách so sánh các vector nhúng của chúng.

Tham số

Tên	Loại
`args`	`SentenceSimilarityArgs`
`options?`	`Options`

Trả về

Promise<SentenceSimilarityOutput>

Được định nghĩa trong

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

streamingRequest

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

Primitive để thực hiện các cuộc gọi suy luận tùy chỉnh, kỳ vọng các sự kiện do máy chủ gửi (server-sent events), và trả về phản hồi thông qua một generator

Tham số kiểu

Tên
`T`

Tham số

Tên	Loại
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Trả về

AsyncGenerator<T>

Deprecated

Hãy sử dụng các hàm tác vụ cụ thể thay thế. Hàm này sẽ bị loại bỏ trong một phiên bản tương lai.

Được định nghĩa trong

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

tóm tắt

▸ tóm tắt(args, options?): Promise<SummarizationOutput>

Nhiệm vụ này được biết đến rộng rãi với việc tóm tắt văn bản dài thành văn bản ngắn hơn. Hãy cẩn thận, một số mô hình có giới hạn độ dài tối đa của đầu vào. Điều đó có nghĩa là bản tóm tắt không thể xử lý các cuốn sách hoàn chỉnh, chẳng hạn. Hãy cẩn thận khi chọn mô hình của bạn.

Tham số

Tên	Loại
`args`	`SummarizationArgs`
`options?`	`Options`

Trả về

Promise<SummarizationOutput>

Được định nghĩa trong

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

tableQuestionAnswering

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

Không biết SQL? Không muốn đào sâu vào một bảng tính lớn? Hãy đặt câu hỏi bằng tiếng Anh thông thường! Mô hình được đề xuất: google/tapas-base-finetuned-wtq.

Tham số

Tên	Loại
`args`	`TableQuestionAnsweringArgs`
`options?`	`Options`

Trả về

Promise<TableQuestionAnsweringOutput[number]>

Được định nghĩa trong

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

tabularClassification

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

Dự đoán nhãn đích cho một tập hợp các đặc trưng ở dạng bảng. Thông thường, bạn sẽ muốn huấn luyện một mô hình phân loại trên dữ liệu huấn luyện của mình và sử dụng nó với dữ liệu mới có cùng định dạng. Mô hình ví dụ: vvmnnnkv/wine-quality

Tham số

Tên	Loại
`args`	`TabularClassificationArgs`
`options?`	`Options`

Trả về

Promise<TabularClassificationOutput>

Được định nghĩa trong

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

tabularRegression

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

Dự đoán giá trị mục tiêu cho một tập các đặc trưng ở dạng bảng. Thông thường, bạn sẽ muốn huấn luyện một mô hình hồi quy trên dữ liệu huấn luyện của mình và sử dụng nó với dữ liệu mới có cùng định dạng. Mô hình ví dụ: scikit-learn/Fish-Weight

Tham số

Tên	Loại
`args`	`TabularRegressionArgs`
`options?`	`Options`

Trả về

Promise<TabularRegressionOutput>

Được định nghĩa trong

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

textClassification

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

Thường được sử dụng cho phân tích cảm xúc, điều này sẽ đưa ra xác suất của các lớp đối với một đầu vào. Mô hình được khuyến nghị: distilbert-base-uncased-finetuned-sst-2-english

Tham số

Tên	Loại
`args`	`TextClassificationArgs`
`options?`	`Options`

Trả về

Promise<TextClassificationOutput>

Được định nghĩa trong

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

textGeneration

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

Sử dụng để tiếp tục văn bản từ một prompt. Đây là một tác vụ rất chung chung. Mô hình được khuyến nghị: gpt2 (đây là một mô hình đơn giản, nhưng thú vị để thử nghiệm).

Tham số

Tên	Loại
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Trả về

Promise<TextGenerationOutput>

Được định nghĩa trong

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

textGenerationStream

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

Dùng để tiếp tục văn bản từ một prompt. Giống như textGeneration nhưng trả về generator có thể đọc từng token một

Tham số

Tên	Loại
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Trả về

AsyncGenerator<TextGenerationStreamOutput>

Được định nghĩa trong

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

textRanking

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

Xếp hạng các tài liệu theo mức độ liên quan đến truy vấn bằng cách sử dụng mô hình reranker.

Tham số

Tên	Loại
`args`	`TextRankingArgs`
`options?`	`Options`

Trả về

Promise<TextRankingOutput>

Được định nghĩa trong

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

textToAudio

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

Nhiệm vụ này tạo ra âm thanh (ví dụ: nhạc hoặc hiệu ứng âm thanh) từ một câu lệnh văn bản đầu vào. Mô hình ví dụ: stabilityai/stable-audio-open-1.0

Tham số

Tên	Loại
`args`	`TextToAudioArgs`
`options?`	`Options`

Trả về

Promise<Blob>

Được định nghĩa trong

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

textToImage

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

Nhiệm vụ này đọc một số đầu vào văn bản và xuất ra một hình ảnh. Mô hình được khuyến nghị: stabilityai/stable-diffusion-2

Tham số

Tên	Loại
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"url"` }

Trả về

Promise<string>

Được định nghĩa trong

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

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

Tham số

Tên	Loại
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"dataUrl"` }

Trả về

Promise<string>

Được định nghĩa trong

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

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

Tham số

Tên	Loại
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"blob"` }

Trả về

Promise<Blob>

Được định nghĩa trong

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

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

Tham số

Tên	Loại
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"json"` }

Trả về

Promise<Record<string, unknown>>

Được định nghĩa trong

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

textToSpeech

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

Nhiệm vụ này tổng hợp âm thanh của giọng đọc một đoạn văn bản cho trước. Mô hình được khuyến nghị: espnet/kan-bayashi_ljspeech_vits

Tham số

Tên	Loại
`args`	`TextToSpeechArgs`
`options?`	`Options`

Trả về

Promise<Blob>

Được định nghĩa trong

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

textToVideo

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

Tham số

Tên	Loại
`args`	`TextToVideoArgs`
`options?`	`Options`

Trả về

Promise<TextToVideoOutput>

Được định nghĩa trong

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

tokenClassification

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

Thường được sử dụng để phân tích câu, có thể là phân tích ngữ pháp hoặc Nhận diện thực thể có tên (NER) để hiểu các từ khóa chứa trong văn bản. Mô hình được khuyến nghị: dbmdz/bert-large-cased-finetuned-conll03-english

Tham số

Tên	Loại
`args`	`TokenClassificationArgs`
`options?`	`Options`

Trả về

Promise<TokenClassificationOutput>

Được định nghĩa trong

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

dịch

▸ dịch(args, options?): Promise<TranslationOutput>

Nhiệm vụ này được biết đến rộng rãi với việc dịch văn bản từ ngôn ngữ này sang ngôn ngữ khác. Mô hình được khuyến nghị: Helsinki-NLP/opus-mt-ru-en.

Tham số

Tên	Loại
`args`	`TranslationArgs`
`options?`	`Options`

Trả về

Promise<TranslationOutput>

Được định nghĩa trong

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

visualQuestionAnswering

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

Trả lời câu hỏi về một hình ảnh. Mô hình được khuyến nghị: dandelin/vilt-b32-finetuned-vqa.

Tham số

Tên	Loại
`args`	`VisualQuestionAnsweringArgs`
`options?`	`Options`

Trả về

Promise<VisualQuestionAnsweringOutput[number]>

Được định nghĩa trong

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

zeroShotClassification

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

Nhiệm vụ này cực kỳ hữu ích để thử nghiệm phân loại với zero code, bạn chỉ cần truyền một câu/đoạn văn và các nhãn có thể có cho câu đó, và bạn sẽ nhận được kết quả. Mô hình được khuyến nghị: facebook/bart-large-mnli.

Tham số

Tên	Loại
`args`	`ZeroShotClassificationArgs`
`options?`	`Options`

Trả về

Promise<ZeroShotClassificationOutput>

Được định nghĩa trong

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

zeroShotImageClassification

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

Phân loại một hình ảnh vào các lớp được chỉ định. Mô hình được khuyến nghị: openai/clip-vit-large-patch14-336

Tham số

Tên	Loại
`args`	`ZeroShotImageClassificationArgs`
`options?`	`Options`

Trả về

Promise<ZeroShotImageClassificationOutput>

Được định nghĩa trong

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

Update on GitHub

←HfInference InferenceClientEndpoint→