Huggingface.js documentation

Sınıf: HfInference

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

Sınıf: HfInference

Yalnızca geriye dönük uyumluluk için, yakında kaldırılacak.

Deprecated

InferenceClient ile değiştirin

Hiyerarşi

InferenceClient

↳ HfInference

Oluşturucular

constructor

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

Parametreler

Ad	Tür	Varsayılan değer
`accessToken`	`string`	`""`
`defaultOptions`	`Options` & { `endpointUrl?`: `string` }	`{}`

Yöntemler

audioClassification

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

Bu görev, bazı ses girdilerini okur ve sınıfların olasılığını çıktılar. Önerilen model: superb/hubert-large-superb-er

Parametreler

Ad	Tür
`args`	`AudioClassificationArgs`
`options?`	`Options`

Dönüş

Promise<AudioClassificationOutput>

Şuradan devralınır

InferenceClient.audioClassification

Tanımlandığı yer

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

audioToAudio

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

Bu görev, bazı ses girdilerini okur ve bir veya birden fazla ses dosyası üretir. Örnek model: speechbrain/sepformer-wham ses kaynak ayırma yapar.

Parametreler

Ad	Tür
`args`	`AudioToAudioArgs`
`options?`	`Options`

Dönüş

Promise<AudioToAudioOutput[]>

Şuradan devralınır

InferenceClient.audioToAudio

Tanımlandığı yer

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

automaticSpeechRecognition

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

Bu görev, bazı ses girdilerini okur ve ses dosyalarındaki söylenen kelimeleri çıktılar. Önerilen model (İngilizce dil): facebook/wav2vec2-large-960h-lv60-self

Parametreler

Ad	Tür
`args`	`AutomaticSpeechRecognitionArgs`
`options?`	`Options`

Dönüş

Promise<AutomaticSpeechRecognitionOutput>

Şuradan devralınır

InferenceClient.automaticSpeechRecognition

Tanımlandığı yer

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

chatCompletion

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

OpenAI mesaj tamamlama API'sini kullanarak, akışsız (no stream) bir şekilde bir istemciye (prompt) yanıt üretmek için sohbet tamamlama uç noktasını (chat completion endpoint) kullanın.

Parametreler

Ad	Tür
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Dönüş

Promise<ChatCompletionOutput>

Şuradan devralınır

InferenceClient.chatCompletion

Tanımlandığı yer

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

chatCompletionStream

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

Bir istemden metni devam ettirmek için kullanılır. textGeneration ile aynıdır ancak her seferinde bir token okunabilen bir üreteç döndürür

Parametreler

Ad	Tür
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Dönüş

AsyncGenerator<ChatCompletionStreamOutput>

Şuradan devralınır

InferenceClient.chatCompletionStream

Tanımlandığı yer

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

documentQuestionAnswering

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

Bir belge görüntüsündeki soruyu yanıtlar. Önerilen model: impira/layoutlm-document-qa.

Parametreler

Ad	Tür
`args`	`DocumentQuestionAnsweringArgs`
`options?`	`Options`

Dönüş

Promise<DocumentQuestionAnsweringOutput[number]>

Şuradan devralınır

InferenceClient.documentQuestionAnswering

Tanımlandığı yer

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

endpoint

▸ uç nokta(endpointUrl): InferenceClient

Belirtilen bir uç noktaya bağlı yeni bir InferenceClient örneği döndürür.

Ağırlıklı olarak geriye dönük uyumluluk için.

Parametreler

Ad	Tür
`endpointUrl`	`string`

Dönüş

InferenceClient

Şuradan devralınır

InferenceClient.endpoint

Tanımlandığı yer

inference/src/InferenceClient.ts:46

featureExtraction

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

Bu görev, bazı metinleri okur ve genellikle bir anlamsal veritabanı/anlamsal arama parçası olarak tüketilen ham float değerlerini çıktılar.

Parametreler

Ad	Tür
`args`	`FeatureExtractionArgs`
`options?`	`Options`

Dönüş

Promise<FeatureExtractionOutput>

Şuradan devralınır

InferenceClient.featureExtraction

Tanımlandığı yer

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

fillMask

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

Eksik bir kelime (daha doğrusu token) bulunan boşluğu doldurmaya çalışır. Bu, BERT modelleri için temel görevdir.

Parametreler

Ad	Tür
`args`	`FillMaskArgs`
`options?`	`Options`

Dönüş

Promise<FillMaskOutput>

Şuradan devralınır

InferenceClient.fillMask

Tanımlandığı yer

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

imageClassification

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

Bu görev, bazı görüntü girdilerini okur ve sınıfların olasılığını çıktılar. Önerilen model: google/vit-base-patch16-224

Parametreler

Ad	Tür
`args`	`ImageClassificationArgs`
`options?`	`Options`

Dönüş

Promise<ImageClassificationOutput>

Şuradan devralınır

InferenceClient.imageClassification

Tanımlandığı yer

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

imageSegmentation

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

Bu görev, bazı görüntü girdilerini okur ve sınıfların olasılıkları ile algılanan nesnelerin sınırlayıcı kutularını (bounding box) çıktılar. Önerilen model: facebook/detr-resnet-50-panoptic

Parametreler

Ad	Tür
`args`	`ImageSegmentationArgs`
`options?`	`Options`

Dönüş

Promise<ImageSegmentationOutput>

Şuradan devralınır

InferenceClient.imageSegmentation

Tanımlandığı yer

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

imageTextToImage

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

Bu görev, bir görüntü ve metin girdisi alır ve yeni oluşturulmuş bir görüntü çıktısı üretir. Önerilen model: black-forest-labs/FLUX.2-dev

Parametreler

Ad	Tür
`args`	`ImageTextToImageArgs`
`options?`	`Options`

Dönüş

Promise<Blob>

Şuradan devralınır

InferenceClient.imageTextToImage

Tanımlandığı yer

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

imageTextToVideo

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

Bu görev, bir görüntü ve metin girdisi alır ve üretilmiş bir video çıktısı verir. Önerilen model: Lightricks/LTX-Video

Parametreler

Ad	Tür
`args`	`ImageTextToVideoArgs`
`options?`	`Options`

Dönüş

Promise<Blob>

Şuradan devralınır

InferenceClient.imageTextToVideo

Tanımlandığı yer

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

imageToImage

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

Bu görev, bazı metin girdilerini okur ve bir görüntü çıktısı üretir. Önerilen model: lllyasviel/sd-controlnet-depth

Parametreler

Ad	Tür
`args`	`ImageToImageArgs`
`options?`	`Options`

Dönüş

Promise<Blob>

Şuradan devralınır

InferenceClient.imageToImage

Tanımlandığı yer

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

imageToText

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

Bu görev, bazı görüntü girdilerini okur ve metin başlığını (caption) çıktılar.

Parametreler

Ad	Tür
`args`	`ImageToTextArgs`
`options?`	`Options`

Dönüş

Promise<ImageToTextOutput>

Şuradan devralınır

InferenceClient.imageToText

Tanımlandığı yer

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

imageToVideo

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

Bu görev, bazı metin girdilerini okur ve bir görüntü çıktısı üretir. Önerilen model: Wan-AI/Wan2.1-I2V-14B-720P

Parametreler

Ad	Tür
`args`	`ImageToVideoArgs`
`options?`	`Options`

Dönüş

Promise<Blob>

Şuradan devralınır

InferenceClient.imageToVideo

Tanımlandığı yer

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

objectDetection

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

Parametreler

Ad	Tür
`args`	`ObjectDetectionArgs`
`options?`	`Options`

Dönüş

Promise<ObjectDetectionOutput>

Şuradan devralınır

InferenceClient.objectDetection

Tanımlandığı yer

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

questionAnswering

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

Herhangi bir soruyu yanıtlayabilen, her şeyi bilen şık bir bot istiyor musunuz? Önerilen model: deepset/roberta-base-squad2

Parametreler

Ad	Tür
`args`	`QuestionAnsweringArgs`
`options?`	`Options`

Dönüş

Promise<QuestionAnsweringOutput[number]>

Şuradan devralınır

InferenceClient.questionAnswering

Tanımlandığı yer

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

istek

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

Çıkarım sağlayıcısına özel çağrılar yapmak için ilkel

Tip parametreleri

Ad
`T`

Parametreler

Ad	Tür
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Dönüş

Promise<T>

Deprecated

Bunun yerine belirli görev işlevlerini kullanın. Bu işlev, gelecekteki bir sürümde kaldırılacaktır.

Şuradan devralınır

InferenceClient.request

Tanımlandığı yer

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

sentenceSimilarity

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

Bir metin ile diğer cümlelerin listesi arasındaki anlamsal benzerliği, gömme (embedding) değerlerini karşılaştırarak hesaplayın.

Parametreler

Ad	Tür
`args`	`SentenceSimilarityArgs`
`options?`	`Options`

Dönüş

Promise<SentenceSimilarityOutput>

Şuradan devralınır

InferenceClient.sentenceSimilarity

Tanımlandığı yer

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

streamingRequest

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

Sunucu gönderimli olaylar bekleyen özel çıkarım çağrıları yapmak için kullanılan bir ilkel; yanıtı bir üreteç üzerinden döndürür

Tip parametreleri

Ad
`T`

Parametreler

Ad	Tür
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Dönüş

AsyncGenerator<T>

Deprecated

Bunun yerine belirli görev işlevlerini kullanın. Bu işlev, gelecekteki bir sürümde kaldırılacaktır.

Şuradan devralınır

InferenceClient.streamingRequest

Tanımlandığı yer

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

özetleme

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

Bu görev, uzun metinleri daha kısa metinlere özetlemesiyle iyi bilinir. Dikkatli olun, bazı modellerin girdi için bir maksimum uzunluğu vardır. Bu, örneğin özetlemenin tam kitapları işleyemeyeceği anlamına gelir. Modelinizi seçerken dikkatli olun.

Parametreler

Ad	Tür
`args`	`SummarizationArgs`
`options?`	`Options`

Dönüş

Promise<SummarizationOutput>

Şuradan devralınır

InferenceClient.summarization

Tanımlandığı yer

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

tableQuestionAnswering

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

SQL bilmiyor musunuz? Büyük bir elektronik tabloya dalmak istemiyor musunuz? Sorularınızı düz İngilizce olarak sorun! Önerilen model: google/tapas-base-finetuned-wtq.

Parametreler

Ad	Tür
`args`	`TableQuestionAnsweringArgs`
`options?`	`Options`

Dönüş

Promise<TableQuestionAnsweringOutput[number]>

Şuradan devralınır

InferenceClient.tableQuestionAnswering

Tanımlandığı yer

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

tabularClassification

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

Tabular formda verilen bir özellik seti için hedef etiketi tahmin eder. Genellikle, eğitim verileriniz üzerinde bir sınıflandırma modeli eğitmek ve aynı formattaki yeni verilerinizle kullanmak istersiniz. Örnek model: vvmnnnkv/wine-quality

Parametreler

Ad	Tür
`args`	`TabularClassificationArgs`
`options?`	`Options`

Dönüş

Promise<TabularClassificationOutput>

Şuradan devralınır

InferenceClient.tabularClassification

Tanımlandığı yer

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

tabularRegression

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

Tabular formda verilen bir özellik seti için hedef değeri tahmin eder. Genellikle, eğitim verileriniz üzerinde bir regresyon modeli eğitmek ve aynı formattaki yeni verilerinizle kullanmak istersiniz. Örnek model: scikit-learn/Fish-Weight

Parametreler

Ad	Tür
`args`	`TabularRegressionArgs`
`options?`	`Options`

Dönüş

Promise<TabularRegressionOutput>

Şuradan devralınır

InferenceClient.tabularRegression

Tanımlandığı yer

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

textClassification

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

Genellikle duygu analizi için kullanılan bu yöntem, bir girdinin sınıflarına ait olasılıkları çıktılar. Önerilen model: distilbert-base-uncased-finetuned-sst-2-english

Parametreler

Ad	Tür
`args`	`TextClassificationArgs`
`options?`	`Options`

Dönüş

Promise<TextClassificationOutput>

Şuradan devralınır

InferenceClient.textClassification

Tanımlandığı yer

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

textGeneration

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

Bir istemden metni devam ettirmek için kullanılır. Bu, oldukça genel bir görevdir. Önerilen model: gpt2 (basit bir modeldir, ancak oynaması eğlencelidir).

Parametreler

Ad	Tür
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Dönüş

Promise<TextGenerationOutput>

Şuradan devralınır

InferenceClient.textGeneration

Tanımlandığı yer

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

textGenerationStream

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

Bir istemden metni devam ettirmek için kullanılır. textGeneration ile aynıdır ancak her seferinde bir token okunabilen bir üreteç döndürür

Parametreler

Ad	Tür
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Dönüş

AsyncGenerator<TextGenerationStreamOutput>

Şuradan devralınır

InferenceClient.textGenerationStream

Tanımlandığı yer

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

textRanking

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

Bir yeniden sıralayıcı (reranker) modeli kullanarak belgeleri bir sorguya göre ilgili olma derecesine göre sıralayın.

Parametreler

Ad	Tür
`args`	`TextRankingArgs`
`options?`	`Options`

Dönüş

Promise<TextRankingOutput>

Şuradan devralınır

InferenceClient.textRanking

Tanımlandığı yer

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

textToAudio

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

Bu görev, girdi metin komutundan ses (ör. müzik veya ses efektleri) üretir. Örnek model: stabilityai/stable-audio-open-1.0

Parametreler

Ad	Tür
`args`	`TextToAudioArgs`
`options?`	`Options`

Dönüş

Promise<Blob>

Şuradan devralınır

InferenceClient.textToAudio

Tanımlandığı yer

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

textToImage

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

Bu görev, bazı metin girdilerini okur ve bir görüntü çıktısı üretir. Önerilen model: stabilityai/stable-diffusion-2

Parametreler

Ad	Tür
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"url"` }

Dönüş

Promise<string>

Şuradan devralınır

InferenceClient.textToImage

Tanımlandığı yer

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

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

Parametreler

Ad	Tür
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"dataUrl"` }

Dönüş

Promise<string>

Şuradan devralınır

InferenceClient.textToImage

Tanımlandığı yer

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

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

Parametreler

Ad	Tür
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"blob"` }

Dönüş

Promise<Blob>

Şuradan devralınır

InferenceClient.textToImage

Tanımlandığı yer

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

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

Parametreler

Ad	Tür
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"json"` }

Dönüş

Promise<Record<string, unknown>>

Şuradan devralınır

InferenceClient.textToImage

Tanımlandığı yer

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

textToSpeech

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

Bu görev, verilen bir metni seslendiren bir sesin ses kaydını sentezler. Önerilen model: espnet/kan-bayashi_ljspeech_vits

Parametreler

Ad	Tür
`args`	`TextToSpeechArgs`
`options?`	`Options`

Dönüş

Promise<Blob>

Şuradan devralınır

InferenceClient.textToSpeech

Tanımlandığı yer

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

textToVideo

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

Parametreler

Ad	Tür
`args`	`TextToVideoArgs`
`options?`	`Options`

Dönüş

Promise<TextToVideoOutput>

Şuradan devralınır

InferenceClient.textToVideo

Tanımlandığı yer

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

tokenClassification

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

Genellikle cümle ayrıştırma için kullanılır; dilbilgisel ayrıştırma veya metin içindeki anahtar kelimeleri anlamak için Adlandırılmış Varlık Tanıma (NER). Önerilen model: dbmdz/bert-large-cased-finetuned-conll03-english

Parametreler

Ad	Tür
`args`	`TokenClassificationArgs`
`options?`	`Options`

Dönüş

Promise<TokenClassificationOutput>

Şuradan devralınır

InferenceClient.tokenClassification

Tanımlandığı yer

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

çeviri

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

Bu görev, metni bir dilden diğerine çevirmek için iyi bilinmektedir. Önerilen model: Helsinki-NLP/opus-mt-ru-en.

Parametreler

Ad	Tür
`args`	`TranslationArgs`
`options?`	`Options`

Dönüş

Promise<TranslationOutput>

Şuradan devralınır

InferenceClient.çeviri

Tanımlandığı yer

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

visualQuestionAnswering

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

Bir görüntüdeki soruyu yanıtlar. Önerilen model: dandelin/vilt-b32-finetuned-vqa.

Parametreler

Ad	Tür
`args`	`VisualQuestionAnsweringArgs`
`options?`	`Options`

Dönüş

Promise<VisualQuestionAnsweringOutput[number]>

Şuradan devralınır

InferenceClient.visualQuestionAnswering

Tanımlandığı yer

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

zeroShotClassification

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

Bu görev, sıfır kodla sınıflandırmayı denemek için son derece faydalıdır; yalnızca bir cümle/paragrafı ve o cümle için olası etiketleri iletirsiniz ve bir sonuç alırsınız. Önerilen model: facebook/bart-large-mnli.

Parametreler

Ad	Tür
`args`	`ZeroShotClassificationArgs`
`options?`	`Options`

Dönüş

Promise<ZeroShotClassificationOutput>

Şuradan devralınır

InferenceClient.zeroShotClassification

Tanımlandığı yer

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

zeroShotImageClassification

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

Bir görüntüyü belirtilen sınıflara sınıflandırın. Önerilen model: openai/clip-vit-large-patch14-336

Parametreler

Ad	Tür
`args`	`ZeroShotImageClassificationArgs`
`options?`	`Options`

Dönüş

Promise<ZeroShotImageClassificationOutput>

Şuradan devralınır

InferenceClient.zeroShotImageClassification

Tanımlandığı yer

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

Update on GitHub

←API referansı InferenceClient→