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

Espaces de noms

extraits de code

Classes

Interfaces

Alias de types

AudioClassificationArgs

Ƭ AudioClassificationArgs : BaseArgs & AudioClassificationInput | LegacyAudioInput

Défini dans

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

AudioToAudioArgs

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

Défini dans

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

AuthMethod

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

Défini dans

inference/src/types.ts:165

AutomaticSpeechRecognitionArgs

Ƭ AutomaticSpeechRecognitionArgs : BaseArgs & AutomaticSpeechRecognitionInput | LegacyAudioInput

Défini dans

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

DocumentQuestionAnsweringArgs

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

Défini dans

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

FeatureExtractionArgs

Ƭ FeatureExtractionArgs : BaseArgs & FeatureExtractionInput & FeatureExtractionOAICompatInput

Défini dans

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

FeatureExtractionOutput

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

Les valeurs retournées sont un tableau multidimensionnel de nombres flottants (la dimension dépendant du fait que vous ayez envoyé une chaîne de caractères ou une liste de chaînes, et de l’application ou non d’une réduction automatique, par exemple mean_pooling, comme cela devrait être expliqué dans le README du modèle).

Défini dans

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

FillMaskArgs

Ƭ FillMaskArgs : BaseArgs & FillMaskInput

Défini dans

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

ImageClassificationArgs

Ƭ ImageClassificationArgs : BaseArgs & ImageClassificationInput | LegacyImageInput

Défini dans

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

ImageSegmentationArgs

Ƭ ImageSegmentationArgs : BaseArgs & ImageSegmentationInput

Défini dans

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

ImageTextToImageArgs

Ƭ ImageTextToImageArgs : BaseArgs & ImageTextToImageInput

Défini dans

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

ImageTextToVideoArgs

Ƭ ImageTextToVideoArgs : BaseArgs & ImageTextToVideoInput

Défini dans

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

ImageToImageArgs

Ƭ ImageToImageArgs : BaseArgs & ImageToImageInput

Défini dans

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

ImageToTextArgs

Ƭ ImageToTextArgs : BaseArgs & ImageToTextInput | LegacyImageInput

Défini dans

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

ImageToVideoArgs

Ƭ ImageToVideoArgs : BaseArgs & ImageToVideoInput

Défini dans

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

InferenceProvider

Ƭ InferenceProvider : typeof INFERENCE_PROVIDERS[number]

Défini dans

inference/src/types.ts:73

InferenceProviderOrPolicy

Ƭ InferenceProviderOrPolicy : typeof PROVIDERS_OR_POLICIES[number]

Défini dans

inference/src/types.ts:75

InferenceTask

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

Défini dans

inference/src/types.ts:45

ModelId

Ƭ ModelId : string

ID de modèle HF, comme “meta-llama/Llama-3.3-70B-Instruct”

Défini dans

inference/src/types.ts:6

ObjectDetectionArgs

Ƭ ObjectDetectionArgs : BaseArgs & ObjectDetectionInput | LegacyImageInput

Défini dans

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

OutputType

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

Défini dans

inference/src/types.ts:179

QuestionAnsweringArgs

Ƭ QuestionAnsweringArgs : BaseArgs & QuestionAnsweringInput

Défini dans

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 }

Défini dans

inference/src/types.ts:152

SentenceSimilarityArgs

Ƭ SentenceSimilarityArgs : BaseArgs & SentenceSimilarityInput

Défini dans

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

SummarizationArgs

Ƭ SummarizationArgs : BaseArgs & SummarizationInput

Défini dans

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

TableQuestionAnsweringArgs

Ƭ TableQuestionAnsweringArgs : BaseArgs & TableQuestionAnsweringInput

Défini dans

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

TabularClassificationArgs

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

Défini dans

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

TabularClassificationOutput

Ƭ TabularClassificationOutput : number[]

Une liste d'étiquettes prédites pour chaque ligne

Défini dans

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

TabularRegressionArgs

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

Défini dans

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

TabularRegressionOutput

Ƭ TabularRegressionOutput : number[]

une liste de valeurs prédites pour chaque ligne

Défini dans

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

TextClassificationArgs

Ƭ TextClassificationArgs : BaseArgs & TextClassificationInput

Défini dans

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

TextGenerationStreamFinishReason

Ƭ TextGenerationStreamFinishReason : "length" | "eos_token" | "stop_sequence"

Défini dans

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

TextRankingArgs

Ƭ TextRankingArgs : BaseArgs & TextRankingInput

Défini dans

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

TextToAudioArgs

Ƭ TextToAudioArgs : BaseArgs & TextToAudioInput

Défini dans

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

TextToImageArgs

Ƭ TextToImageArgs : BaseArgs & TextToImageInput

Défini dans

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

TextToVideoArgs

Ƭ TextToVideoArgs : BaseArgs & TextToVideoInput

Défini dans

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

TextToVideoOutput

Ƭ TextToVideoOutput : Blob

Défini dans

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

TokenClassificationArgs

Ƭ TokenClassificationArgs : BaseArgs & TokenClassificationInput

Défini dans

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

TranslationArgs

Ƭ TranslationArgs : BaseArgs & TranslationInput

Défini dans

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

VisualQuestionAnsweringArgs

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

Défini dans

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

ZeroShotClassificationArgs

Ƭ ZeroShotClassificationArgs : BaseArgs & ZeroShotClassificationInput

Défini dans

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

ZeroShotImageClassificationArgs

Ƭ ZeroShotImageClassificationArgs : BaseArgs & ZeroShotImageClassificationInput | LegacyZeroShotImageClassificationInput

Défini dans

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

Variables

INFÉRENCE _ Fournisseurs

• Const INFERENCE_PROVIDERS : en lecture seule ["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"]

Défini dans

inference/src/types.ts:47

PROVIDERS

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

Défini dans

inference/src/lib/getProviderHelper.ts:61

PROVIDERS _ HUB _ ORGS

• Const PROVIDERS_HUB_ORGS : Record<InferenceProvider, string>

L'espace de noms d'organisation sur le HF Hub, c'est-à-dire hf.co/…

Dans la mesure du possible, InferenceProvider doit == espace de noms org

Défini dans

inference/src/types.ts:82

PROVIDERS _ OR _ POLICIES

• Const PROVIDERS_OR_POLICIES : en lecture seule ["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"]

Défini dans

inference/src/types.ts:71

Fonctions

audioClassification

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

Cette tâche lit une entrée audio et sort la probabilité de classes. Modèle recommandé : superb/hubert-large-superb-er

Paramètres

Nom	Type
`args`	`AudioClassificationArgs`
`options?`	`Options`

Retourne

Promise<AudioClassificationOutput>

Défini dans

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

audioToAudio

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

Cette tâche lit une entrée audio et produit un ou plusieurs fichiers audio. Exemple de modèle : speechbrain/sepformer-wham effectue la séparation des sources audio.

Paramètres

Nom	Type
`args`	`AudioToAudioArgs`
`options?`	`Options`

Retourne

Promise<AudioToAudioOutput[]>

Défini dans

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

automaticSpeechRecognition

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

Cette tâche lit une entrée audio et restitue les mots prononcés dans les fichiers audio. Modèle recommandé (langue anglaise) : facebook/wav2vec2-large-960h-lv60-self

Paramètres

Nom	Type
`args`	`AutomaticSpeechRecognitionArgs`
`options?`	`Options`

Retourne

Promise<AutomaticSpeechRecognitionOutput>

Défini dans

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

chatCompletion

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

Utilisez le point de terminaison de complétion de chat pour générer une réponse à un prompt, en utilisant l'API de complétion de messages OpenAI sans flux

Paramètres

Nom	Type
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Retourne

Promise<ChatCompletionOutput>

Défini dans

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

chatCompletionStream

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

Utilisez pour continuer un texte à partir d'un prompt. Identique à textGeneration mais renvoie un générateur qui peut être lu un jeton à la fois

Paramètres

Nom	Type
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Retourne

AsyncGenerator<ChatCompletionStreamOutput>

Défini dans

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

documentQuestionAnswering

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

Répond à une question sur une image de document. Modèle recommandé : impira/layoutlm-document-qa.

Paramètres

Nom	Type
`args`	`DocumentQuestionAnsweringArgs`
`options?`	`Options`

Retourne

Promise<DocumentQuestionAnsweringOutput[number]>

Défini dans

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

featureExtraction

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

Cette tâche lit du texte et produit des valeurs flottantes brutes, généralement consommées dans le cadre d'une base de données sémantique ou d'une recherche sémantique.

Paramètres

Nom	Type
`args`	`FeatureExtractionArgs`
`options?`	`Options`

Retourne

Promise<FeatureExtractionOutput>

Défini dans

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

fillMask

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

Tente de combler un trou avec un mot manquant (un jeton, pour être précis). C'est la tâche de base pour les modèles BERT.

Paramètres

Nom	Type
`args`	`FillMaskArgs`
`options?`	`Options`

Retourne

Promise<FillMaskOutput>

Défini dans

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

getProviderHelper

▸ getProviderHelper(provider, task) : TextToImageTaskHelper & TaskProviderHelper

Obtenir l'instance d'assistance du fournisseur par nom et tâche

Paramètres

Nom	Type
`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"`

Retourne

TextToImageTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:201

▸ getProviderHelper(provider, task) : ConversationalTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ConversationalTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:205

▸ getProviderHelper(provider, task) : TextGenerationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TextGenerationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:209

▸ getProviderHelper(provider, task) : TextToSpeechTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TextToSpeechTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:213

▸ getProviderHelper(provider, task) : TextToAudioTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TextToAudioTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:217

▸ getProviderHelper(provider, task) : AutomaticSpeechRecognitionTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

AutomaticSpeechRecognitionTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:221

▸ getProviderHelper(provider, task) : TextToVideoTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TextToVideoTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:225

▸ getProviderHelper(provider, task) : TextClassificationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TextClassificationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:229

▸ getProviderHelper(provider, task) : QuestionAnsweringTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

QuestionAnsweringTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:233

▸ getProviderHelper(provider, task) : AudioClassificationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

AudioClassificationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:237

▸ getProviderHelper(provider, task) : AudioToAudioTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

AudioToAudioTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:241

▸ getProviderHelper(provider, task) : FillMaskTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

FillMaskTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:245

▸ getProviderHelper(provider, task) : FeatureExtractionTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

FeatureExtractionTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:249

▸ getProviderHelper(provider, task) : ImageClassificationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ImageClassificationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:253

▸ getProviderHelper(provider, task) : ImageSegmentationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ImageSegmentationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:257

▸ getProviderHelper(provider, task) : DocumentQuestionAnsweringTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

DocumentQuestionAnsweringTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:261

▸ getProviderHelper(provider, task) : ImageToTextTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ImageToTextTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:265

▸ getProviderHelper(provider, task) : ObjectDetectionTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ObjectDetectionTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:269

▸ getProviderHelper(provider, task) : ZeroShotImageClassificationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ZeroShotImageClassificationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:273

▸ getProviderHelper(provider, task) : ZeroShotClassificationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ZeroShotClassificationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:277

▸ getProviderHelper(provider, task) : ImageToImageTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ImageToImageTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:281

▸ getProviderHelper(provider, task) : ImageToVideoTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ImageToVideoTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:285

▸ getProviderHelper(provider, task) : ImageTextToImageTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ImageTextToImageTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:289

▸ getProviderHelper(provider, task) : ImageTextToVideoTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

ImageTextToVideoTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:293

▸ getProviderHelper(provider, task) : TextRankingTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TextRankingTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:297

▸ getProviderHelper(provider, task) : SentenceSimilarityTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

SentenceSimilarityTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:301

▸ getProviderHelper(provider, task) : TableQuestionAnsweringTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TableQuestionAnsweringTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:305

▸ getProviderHelper(provider, task) : TabularClassificationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TabularClassificationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:309

▸ getProviderHelper(provider, task) : TabularRegressionTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TabularRegressionTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:313

▸ getProviderHelper(provider, task) : TokenClassificationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TokenClassificationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:317

▸ getProviderHelper(provider, task) : TranslationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

TranslationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:321

▸ getProviderHelper(provider, task) : SummarizationTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

SummarizationTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:325

▸ getProviderHelper(provider, task) : VisualQuestionAnsweringTaskHelper & TaskProviderHelper

Paramètres

Nom	Type
`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"`

Retourne

VisualQuestionAnsweringTaskHelper & TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:329

▸ getProviderHelper(provider, task) : TaskProviderHelper

Paramètres

Nom	Type
`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`

Retourne

TaskProviderHelper

Défini dans

inference/src/lib/getProviderHelper.ts:333

imageClassification

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

Cette tâche lit une entrée d'image et sort la probabilité des classes. Modèle recommandé : google/vit-base-patch16-224

Paramètres

Nom	Type
`args`	`ImageClassificationArgs`
`options?`	`Options`

Retourne

Promise<ImageClassificationOutput>

Défini dans

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

imageSegmentation

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

Cette tâche lit une entrée d'image et produit la probabilité des classes ainsi que les boîtes englobantes des objets détectés. Modèle recommandé : facebook/detr-resnet-50-panoptic

Paramètres

Nom	Type
`args`	`ImageSegmentationArgs`
`options?`	`Options`

Retourne

Promise<ImageSegmentationOutput>

Défini dans

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

imageTextToImage

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

Cette tâche prend en entrée une image et du texte et génère une nouvelle image. Modèle recommandé : black-forest-labs/FLUX.2-dev

Paramètres

Nom	Type
`args`	`ImageTextToImageArgs`
`options?`	`Options`

Retourne

Promise<Blob>

Défini dans

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

imageTextToVideo

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

Cette tâche prend en entrée une image et du texte et génère une vidéo en sortie. Modèle recommandé : Lightricks/LTX-Video

Paramètres

Nom	Type
`args`	`ImageTextToVideoArgs`
`options?`	`Options`

Retourne

Promise<Blob>

Défini dans

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

imageToImage

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

Cette tâche lit une entrée de texte et génère une image en sortie. Modèle recommandé : lllyasviel/sd-controlnet-depth

Paramètres

Nom	Type
`args`	`ImageToImageArgs`
`options?`	`Options`

Retourne

Promise<Blob>

Défini dans

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

imageToText

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

Cette tâche lit une entrée image et produit la légende de texte correspondante.

Paramètres

Nom	Type
`args`	`ImageToTextArgs`
`options?`	`Options`

Retourne

Promise<ImageToTextOutput>

Défini dans

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

imageToVideo

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

Cette tâche lit une entrée de texte et génère une image en sortie. Modèle recommandé : Wan-AI/Wan2.1-I2V-14B-720P

Paramètres

Nom	Type
`args`	`ImageToVideoArgs`
`options?`	`Options`

Retourne

Promise<Blob>

Défini dans

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

makeRequestOptions

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

Assistant qui prépare les arguments de la requête. Cette version asynchrone gère l'étape de résolution de l'identifiant du modèle.

Paramètres

Nom	Type
`args`	`RequestArgs` & { `data?`: `Blob` \| `ArrayBuffer` ; `stream?`: `boolean` }
`providerHelper`	`TaskProviderHelper`
`options?`	`Options` & { `task?`: `InferenceTask` }

Retourne

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

Défini dans

inference/src/lib/makeRequestOptions.ts:19

makeRequestOptionsFromResolvedModel

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

Assistant qui prépare les arguments de la requête. - à usage interne uniquement Cette version synchrone ignore l'étape de résolution de l'identifiant du modèle

Paramètres

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

Retourne

Object

Nom	Type
`info`	`RequestInit`
`url`	`string`

Défini dans

inference/src/lib/makeRequestOptions.ts:105

objectDetection

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

Cette tâche lit une entrée d'image et produit la probabilité des classes et les boîtes englobantes des objets détectés. Modèle recommandé : facebook/detr-resnet-50

Paramètres

Nom	Type
`args`	`ObjectDetectionArgs`
`options?`	`Options`

Retourne

Promise<ObjectDetectionOutput>

Défini dans

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

questionAnswering

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

Envie d’avoir un bot omniscient capable de répondre à n’importe quelle question ? Modèle recommandé : deepset/roberta-base-squad2

Paramètres

Nom	Type
`args`	`QuestionAnsweringArgs`
`options?`	`Options`

Retourne

Promise<QuestionAnsweringOutput[number]>

Défini dans

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

demande

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

Primitive permettant d'effectuer des appels personnalisés au fournisseur d'inférence

Paramètres de type

Nom
`T`

Paramètres

Nom	Type
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Retourne

Promise<T>

Deprecated

Utilisez plutôt des fonctions de tâches spécifiques. Cette fonction sera supprimée dans une version future.

Défini dans

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

sentenceSimilarity

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

Calculer la similarité sémantique entre un texte et une liste d'autres phrases en comparant leurs embeddings.

Paramètres

Nom	Type
`args`	`SentenceSimilarityArgs`
`options?`	`Options`

Retourne

Promise<SentenceSimilarityOutput>

Défini dans

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

setLogger

▸ setLogger(logger) : void

Paramètres

Nom	Type
`logger`	`Logger`

Retourne

void

Défini dans

inference/src/lib/logger.ts:5

streamingRequest

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

Primitive permettant d’effectuer des appels d’inférence personnalisés qui s’attendent à des événements envoyés par le serveur, et renvoyant la réponse via un générateur

Paramètres de type

Nom
`T`

Paramètres

Nom	Type
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Retourne

AsyncGenerator<T>

Deprecated

Utilisez plutôt des fonctions de tâches spécifiques. Cette fonction sera supprimée dans une version future.

Défini dans

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

résumé

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

Cette tâche consiste à résumer un texte long en un texte plus court. Attention, certains modèles ont une longueur d’entrée maximale. Cela signifie que le résumé ne peut pas traiter des livres entiers, par exemple. Faites attention lors du choix de votre modèle.

Paramètres

Nom	Type
`args`	`SummarizationArgs`
`options?`	`Options`

Retourne

Promise<SummarizationOutput>

Défini dans

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

tableQuestionAnswering

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

Vous ne connaissez pas SQL ? Vous ne souhaitez pas vous plonger dans un grand tableur ? Posez vos questions en anglais courant ! Modèle recommandé : google/tapas-base-finetuned-wtq.

Paramètres

Nom	Type
`args`	`TableQuestionAnsweringArgs`
`options?`	`Options`

Retourne

Promise<TableQuestionAnsweringOutput[number]>

Défini dans

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

tabularClassification

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

Prédit l'étiquette cible pour un ensemble de caractéristiques donné sous forme tabulaire. En général, vous souhaitez entraîner un modèle de classification sur vos données d'entraînement et l'utiliser avec vos nouvelles données du même format. Exemple de modèle : vvmnnnkv/wine-quality

Paramètres

Nom	Type
`args`	`TabularClassificationArgs`
`options?`	`Options`

Retourne

Promise<TabularClassificationOutput>

Défini dans

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

tabularRegression

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

Prédit la valeur cible pour un ensemble de caractéristiques donné, sous forme tabulaire. En général, vous souhaitez entraîner un modèle de régression sur vos données d’entraînement et l’utiliser avec vos nouvelles données du même format. Exemple de modèle : scikit-learn/Fish-Weight

Paramètres

Nom	Type
`args`	`TabularRegressionArgs`
`options?`	`Options`

Retourne

Promise<TabularRegressionOutput>

Défini dans

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

textClassification

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

Utilisé généralement pour l'analyse de sentiments, il renvoie la probabilité des classes d'une entrée. Modèle recommandé : distilbert-base-uncased-finetuned-sst-2-english

Paramètres

Nom	Type
`args`	`TextClassificationArgs`
`options?`	`Options`

Retourne

Promise<TextClassificationOutput>

Défini dans

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

textGeneration

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

Utilisez pour continuer un texte à partir d'un prompt. Il s'agit d'une tâche très générique. Modèle recommandé : gpt2 (c'est un modèle simple, mais amusant à manipuler).

Paramètres

Nom	Type
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Retourne

Promise<TextGenerationOutput>

Défini dans

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

textGenerationStream

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

Utilisez pour continuer un texte à partir d'un prompt. Identique à textGeneration mais renvoie un générateur qui peut être lu un jeton à la fois

Paramètres

Nom	Type
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Retourne

AsyncGenerator<TextGenerationStreamOutput>

Défini dans

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

textRanking

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

Classez les documents par pertinence par rapport à une requête à l'aide d'un modèle de reranker.

Paramètres

Nom	Type
`args`	`TextRankingArgs`
`options?`	`Options`

Retourne

Promise<TextRankingOutput>

Défini dans

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

textToAudio

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

Cette tâche génère de l'audio (par exemple de la musique ou des effets sonores) à partir d'un prompt texte en entrée. Modèle d'exemple : stabilityai/stable-audio-open-1.0

Paramètres

Nom	Type
`args`	`TextToAudioArgs`
`options?`	`Options`

Retourne

Promise<Blob>

Défini dans

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

textToImage

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

Cette tâche lit une entrée de texte et génère une image en sortie. Modèle recommandé : stabilityai/stable-diffusion-2

Paramètres

Nom	Type
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"url"` }

Retourne

Promise<string>

Défini dans

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

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

Paramètres

Nom	Type
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"dataUrl"` }

Retourne

Promise<string>

Défini dans

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

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

Paramètres

Nom	Type
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"blob"` }

Retourne

Promise<Blob>

Défini dans

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

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

Paramètres

Nom	Type
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"json"` }

Retourne

Promise<Record<string, unknown>>

Défini dans

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

textToSpeech

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

Cette tâche synthétise un audio d'une voix prononçant un texte donné. Modèle recommandé : espnet/kan-bayashi_ljspeech_vits

Paramètres

Nom	Type
`args`	`TextToSpeechArgs`
`options?`	`Options`

Retourne

Promise<Blob>

Défini dans

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

textToVideo

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

Paramètres

Nom	Type
`args`	`TextToVideoArgs`
`options?`	`Options`

Retourne

Promise<TextToVideoOutput>

Défini dans

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

tokenClassification

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

Utilisé généralement pour l'analyse de phrases, qu'elle soit grammaticale ou de reconnaissance d'entités nommées (NER), afin de comprendre les mots-clés contenus dans le texte. Modèle recommandé : dbmdz/bert-large-cased-finetuned-conll03-english

Paramètres

Nom	Type
`args`	`TokenClassificationArgs`
`options?`	`Options`

Retourne

Promise<TokenClassificationOutput>

Défini dans

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

traduction

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

Cette tâche est bien connue pour traduire un texte d'une langue à une autre. Modèle recommandé : Helsinki-NLP/opus-mt-ru-en.

Paramètres

Nom	Type
`args`	`TranslationArgs`
`options?`	`Options`

Retourne

Promise<TranslationOutput>

Défini dans

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

visualQuestionAnswering

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

Répond à une question sur une image. Modèle recommandé : dandelin/vilt-b32-finetuned-vqa.

Paramètres

Nom	Type
`args`	`VisualQuestionAnsweringArgs`
`options?`	`Options`

Retourne

Promise<VisualQuestionAnsweringOutput[number]>

Défini dans

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

zeroShotClassification

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

Cette tâche est très utile pour tester la classification sans écrire de code : il suffit de transmettre une phrase ou un paragraphe ainsi que les étiquettes possibles pour cette phrase, et un résultat est renvoyé. Modèle recommandé : facebook/bart-large-mnli.

Paramètres

Nom	Type
`args`	`ZeroShotClassificationArgs`
`options?`	`Options`

Retourne

Promise<ZeroShotClassificationOutput>

Défini dans

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

zeroShotImageClassification

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

Classer une image dans des classes spécifiées. Modèle recommandé : openai/clip-vit-large-patch14-336

Paramètres

Nom	Type
`args`	`ZeroShotImageClassificationArgs`
`options?`	`Options`

Retourne

Promise<ZeroShotImageClassificationOutput>

Défini dans

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

Update on GitHub

←Utiliser le client d'inférence HfInference→