Huggingface.js documentation

Kelas: 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

Kelas: InferenceClient

Hierarki

Task

↳ InferenceClient

↳↳ InferenceClientEndpoint

↳↳ HfInference

Konstruktor

constructor

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

Parameter

Nama	Tipe	Nilai default
`accessToken`	`string`	`""`
`defaultOptions`	`Options` & { `endpointUrl?`: `string` }	`{}`

Mengembalikan

InferenceClient

Didefinisikan di

inference/src/InferenceClient.ts:15

Properti

accessToken

• Private Readonly accessToken: string

Didefinisikan di

inference/src/InferenceClient.ts:12

defaultOptions

• Private Readonly defaultOptions: Options

Didefinisikan di

inference/src/InferenceClient.ts:13

Metode

audioClassification

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

Tugas ini membaca beberapa input audio dan menghasilkan kemungkinan kelas. Model yang direkomendasikan: superb/hubert-large-superb-er

Parameter

Nama	Tipe
`args`	`AudioClassificationArgs`
`options?`	`Options`

Mengembalikan

Promise<AudioClassificationOutput>

Didefinisikan di

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

audioToAudio

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

Tugas ini membaca beberapa input audio dan menghasilkan satu atau beberapa file audio. Contoh model: speechbrain/sepformer-wham melakukan pemisahan sumber audio.

Parameter

Nama	Tipe
`args`	`AudioToAudioArgs`
`options?`	`Options`

Mengembalikan

Promise<AudioToAudioOutput[]>

Didefinisikan di

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

automaticSpeechRecognition

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

Tugas ini membaca beberapa input audio dan mengoutputkan kata-kata yang diucapkan di dalam file audio. Model yang direkomendasikan (bahasa Inggris): facebook/wav2vec2-large-960h-lv60-self

Parameter

Nama	Tipe
`args`	`AutomaticSpeechRecognitionArgs`
`options?`	`Options`

Mengembalikan

Promise<AutomaticSpeechRecognitionOutput>

Didefinisikan di

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

chatCompletion

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

Gunakan endpoint chat completion untuk menghasilkan respons terhadap prompt, menggunakan API penyelesaian pesan OpenAI tanpa stream

Parameter

Nama	Tipe
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Mengembalikan

Promise<ChatCompletionOutput>

Didefinisikan di

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

chatCompletionStream

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

Gunakan untuk melanjutkan teks dari sebuah prompt. Sama seperti textGeneration tetapi mengembalikan generator yang dapat dibaca satu token pada satu waktu

Parameter

Nama	Tipe
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Mengembalikan

AsyncGenerator<ChatCompletionStreamOutput>

Didefinisikan di

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

documentQuestionAnswering

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

Menjawab pertanyaan pada gambar dokumen. Model yang direkomendasikan: impira/layoutlm-document-qa.

Parameter

Nama	Tipe
`args`	`DocumentQuestionAnsweringArgs`
`options?`	`Options`

Mengembalikan

Promise<DocumentQuestionAnsweringOutput[number]>

Didefinisikan di

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

endpoint

▸ endpoint(endpointUrl): InferenceClient

Mengembalikan instance baru dari InferenceClient yang terhubung ke endpoint yang ditentukan.

Sebagian besar untuk kompatibilitas mundur.

Parameter

Nama	Tipe
`endpointUrl`	`string`

Mengembalikan

InferenceClient

Didefinisikan di

inference/src/InferenceClient.ts:46

featureExtraction

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

Tugas ini membaca beberapa teks dan menghasilkan nilai float mentah, yang biasanya dikonsumsi sebagai bagian dari basis data semantik/pencarian semantik.

Parameter

Nama	Tipe
`args`	`FeatureExtractionArgs`
`options?`	`Options`

Mengembalikan

Promise<FeatureExtractionOutput>

Didefinisikan di

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

fillMask

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

Mencoba mengisi celah dengan kata yang hilang (lebih tepatnya, token). Itulah tugas dasar untuk model BERT.

Parameter

Nama	Tipe
`args`	`FillMaskArgs`
`options?`	`Options`

Mengembalikan

Promise<FillMaskOutput>

Didefinisikan di

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

imageClassification

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

Tugas ini membaca beberapa input gambar dan menghasilkan kemungkinan kelas. Model yang direkomendasikan: google/vit-base-patch16-224

Parameter

Nama	Tipe
`args`	`ImageClassificationArgs`
`options?`	`Options`

Mengembalikan

Promise<ImageClassificationOutput>

Didefinisikan di

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

imageSegmentation

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

Tugas ini membaca beberapa input gambar dan menghasilkan kemungkinan kelas & kotak pembatas dari objek yang terdeteksi. Model yang direkomendasikan: facebook/detr-resnet-50-panoptic

Parameter

Nama	Tipe
`args`	`ImageSegmentationArgs`
`options?`	`Options`

Mengembalikan

Promise<ImageSegmentationOutput>

Didefinisikan di

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

imageTextToImage

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

Tugas ini menerima input gambar dan teks, lalu menghasilkan gambar baru yang dibuat. Model yang direkomendasikan: black-forest-labs/FLUX.2-dev

Parameter

Nama	Tipe
`args`	`ImageTextToImageArgs`
`options?`	`Options`

Mengembalikan

Promise<Blob>

Didefinisikan di

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

imageTextToVideo

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

Tugas ini menerima input gambar dan teks serta menghasilkan video yang dibuat. Model yang direkomendasikan: Lightricks/LTX-Video

Parameter

Nama	Tipe
`args`	`ImageTextToVideoArgs`
`options?`	`Options`

Mengembalikan

Promise<Blob>

Didefinisikan di

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

imageToImage

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

Tugas ini membaca beberapa teks input dan menghasilkan gambar. Model yang direkomendasikan: lllyasviel/sd-controlnet-depth

Parameter

Nama	Tipe
`args`	`ImageToImageArgs`
`options?`	`Options`

Mengembalikan

Promise<Blob>

Didefinisikan di

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

imageToText

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

Tugas ini membaca beberapa input gambar dan menghasilkan teks keterangan.

Parameter

Nama	Tipe
`args`	`ImageToTextArgs`
`options?`	`Options`

Mengembalikan

Promise<ImageToTextOutput>

Didefinisikan di

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

imageToVideo

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

Tugas ini membaca beberapa teks masukan dan menghasilkan gambar. Model yang direkomendasikan: Wan-AI/Wan2.1-I2V-14B-720P

Parameter

Nama	Tipe
`args`	`ImageToVideoArgs`
`options?`	`Options`

Mengembalikan

Promise<Blob>

Didefinisikan di

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

objectDetection

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

Tugas ini membaca beberapa input gambar dan menghasilkan kemungkinan kelas & kotak pembatas dari objek yang terdeteksi. Model yang direkomendasikan: facebook/detr-resnet-50

Parameter

Nama	Tipe
`args`	`ObjectDetectionArgs`
`options?`	`Options`

Mengembalikan

Promise<ObjectDetectionOutput>

Didefinisikan di

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

questionAnswering

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

Ingin memiliki bot pintar yang bisa menjawab pertanyaan apa pun? Model yang direkomendasikan: deepset/roberta-base-squad2

Parameter

Nama	Tipe
`args`	`QuestionAnsweringArgs`
`options?`	`Options`

Mengembalikan

Promise<QuestionAnsweringOutput[number]>

Didefinisikan di

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

request

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

Primitive untuk membuat panggilan khusus ke penyedia inferensi

Parameter tipe

Nama
`T`

Parameter

Nama	Tipe
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Mengembalikan

Promise<T>

Deprecated

Gunakan fungsi tugas tertentu sebagai gantinya. Fungsi ini akan dihapus dalam versi mendatang.

Didefinisikan di

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

sentenceSimilarity

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

Hitung kemiripan semantik antara satu teks dan daftar kalimat lainnya dengan membandingkan embedding mereka.

Parameter

Nama	Tipe
`args`	`SentenceSimilarityArgs`
`options?`	`Options`

Mengembalikan

Promise<SentenceSimilarityOutput>

Didefinisikan di

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

streamingRequest

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

Primitive untuk membuat panggilan inferensi kustom yang mengharapkan server-sent events, dan mengembalikan respons melalui generator

Parameter tipe

Nama
`T`

Parameter

Nama	Tipe
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Mengembalikan

AsyncGenerator<T>

Deprecated

Gunakan fungsi tugas tertentu sebagai gantinya. Fungsi ini akan dihapus dalam versi mendatang.

Didefinisikan di

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

ringkasan

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

Tugas ini dikenal luas untuk merangkum teks yang lebih panjang menjadi lebih pendek. Hati-hati, beberapa model memiliki batas maksimum panjang input. Artinya, ringkasan tidak dapat memproses buku utuh, misalnya. Perhatikan dengan baik saat memilih model Anda.

Parameter

Nama	Tipe
`args`	`SummarizationArgs`
`options?`	`Options`

Mengembalikan

Promise<SummarizationOutput>

Didefinisikan di

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

tableQuestionAnswering

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

Tidak tahu SQL? Tidak ingin menyelami spreadsheet besar? Ajukan pertanyaan dalam bahasa Inggris biasa! Model yang direkomendasikan: google/tapas-base-finetuned-wtq.

Parameter

Nama	Tipe
`args`	`TableQuestionAnsweringArgs`
`options?`	`Options`

Mengembalikan

Promise<TableQuestionAnsweringOutput[number]>

Didefinisikan di

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

Klasifikasi Data Tabular

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

Memprediksi label target untuk seperangkat fitur tertentu dalam bentuk tabular. Biasanya, Anda akan ingin melatih model klasifikasi pada data pelatihan Anda dan menggunakannya dengan data baru Anda yang memiliki format yang sama. Contoh model: vvmnnnkv/wine-quality

Parameter

Nama	Tipe
`args`	`TabularClassificationArgs`
`options?`	`Options`

Mengembalikan

Promise<TabularClassificationOutput>

Didefinisikan di

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

tabularRegression

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

Memprediksi nilai target untuk seperangkat fitur tertentu dalam bentuk tabel. Biasanya, Anda akan melatih model regresi pada data pelatihan Anda dan menggunakannya dengan data baru Anda yang memiliki format yang sama. Contoh model: scikit-learn/Fish-Weight

Parameter

Nama	Tipe
`args`	`TabularRegressionArgs`
`options?`	`Options`

Mengembalikan

Promise<TabularRegressionOutput>

Didefinisikan di

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

textClassification

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

Biasanya digunakan untuk analisis sentimen, ini akan menghasilkan kemungkinan kelas dari input. Model yang direkomendasikan: distilbert-base-uncased-finetuned-sst-2-english

Parameter

Nama	Tipe
`args`	`TextClassificationArgs`
`options?`	`Options`

Mengembalikan

Promise<TextClassificationOutput>

Didefinisikan di

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

textGeneration

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

Gunakan untuk melanjutkan teks dari sebuah prompt. Ini adalah tugas yang sangat umum. Model yang direkomendasikan: gpt2 (ini adalah model sederhana, tetapi menyenangkan untuk dicoba).

Parameter

Nama	Tipe
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Mengembalikan

Promise<TextGenerationOutput>

Didefinisikan di

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

textGenerationStream

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

Gunakan untuk melanjutkan teks dari sebuah prompt. Sama seperti textGeneration tetapi mengembalikan generator yang dapat dibaca satu token pada satu waktu

Parameter

Nama	Tipe
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Mengembalikan

AsyncGenerator<TextGenerationStreamOutput>

Didefinisikan di

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

textRanking

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

Urutkan dokumen berdasarkan relevansinya terhadap kueri menggunakan model reranker.

Parameter

Nama	Tipe
`args`	`TextRankingArgs`
`options?`	`Options`

Mengembalikan

Promise<TextRankingOutput>

Didefinisikan di

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

textToAudio

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

Tugas ini menghasilkan audio (misalnya musik atau efek suara) dari prompt teks input. Contoh model: stabilityai/stable-audio-open-1.0

Parameter

Nama	Tipe
`args`	`TextToAudioArgs`
`options?`	`Options`

Mengembalikan

Promise<Blob>

Didefinisikan di

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

textToImage

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

Tugas ini membaca beberapa teks masukan dan menghasilkan gambar. Model yang direkomendasikan: stabilityai/stable-diffusion-2

Parameter

Nama	Tipe
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"url"` }

Mengembalikan

Promise<string>

Didefinisikan di

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

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

Parameter

Nama	Tipe
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"dataUrl"` }

Mengembalikan

Promise<string>

Didefinisikan di

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

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

Parameter

Nama	Tipe
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"blob"` }

Mengembalikan

Promise<Blob>

Didefinisikan di

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

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

Parameter

Nama	Tipe
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"json"` }

Mengembalikan

Promise<Record<string, unknown>>

Didefinisikan di

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

textToSpeech

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

Tugas ini mensintesis audio suara yang mengucapkan teks tertentu. Model yang direkomendasikan: espnet/kan-bayashi_ljspeech_vits

Parameter

Nama	Tipe
`args`	`TextToSpeechArgs`
`options?`	`Options`

Mengembalikan

Promise<Blob>

Didefinisikan di

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

textToVideo

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

Parameter

Nama	Tipe
`args`	`TextToVideoArgs`
`options?`	`Options`

Mengembalikan

Promise<TextToVideoOutput>

Didefinisikan di

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

tokenClassification

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

Biasanya digunakan untuk parsing kalimat, baik secara gramatikal maupun Named Entity Recognition (NER) untuk memahami kata kunci yang terkandung dalam teks. Model yang direkomendasikan: dbmdz/bert-large-cased-finetuned-conll03-english

Parameter

Nama	Tipe
`args`	`TokenClassificationArgs`
`options?`	`Options`

Mengembalikan

Promise<TokenClassificationOutput>

Didefinisikan di

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

terjemahan

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

Tugas ini dikenal luas untuk menerjemahkan teks dari satu bahasa ke bahasa lain. Model yang direkomendasikan: Helsinki-NLP/opus-mt-ru-en.

Parameter

Nama	Tipe
`args`	`TranslationArgs`
`options?`	`Options`

Mengembalikan

Promise<TranslationOutput>

Didefinisikan di

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

visualQuestionAnswering

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

Menjawab pertanyaan pada gambar. Model yang direkomendasikan: dandelin/vilt-b32-finetuned-vqa.

Parameter

Nama	Tipe
`args`	`VisualQuestionAnsweringArgs`
`options?`	`Options`

Mengembalikan

Promise<VisualQuestionAnsweringOutput[number]>

Didefinisikan di

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

zeroShotClassification

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

Tugas ini sangat berguna untuk mencoba klasifikasi tanpa kode, Anda cukup melewatkan kalimat/paragraf dan label-label yang mungkin untuk kalimat tersebut, lalu Anda akan mendapatkan hasil. Model yang direkomendasikan: facebook/bart-large-mnli.

Parameter

Nama	Tipe
`args`	`ZeroShotClassificationArgs`
`options?`	`Options`

Mengembalikan

Promise<ZeroShotClassificationOutput>

Didefinisikan di

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

zeroShotImageClassification

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

Klasifikasikan gambar ke kelas yang ditentukan. Model yang direkomendasikan: openai/clip-vit-large-patch14-336

Parameter

Nama	Tipe
`args`	`ZeroShotImageClassificationArgs`
`options?`	`Options`

Mengembalikan

Promise<ZeroShotImageClassificationOutput>

Didefinisikan di

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

Update on GitHub

←HfInference InferenceClientEndpoint→