Huggingface.js documentation

Classe : InferenceClientEndpoint

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

Classe : InferenceClientEndpoint

Uniquement pour la compatibilité ascendante, sera bientôt supprimé.

Deprecated

remplacer par InferenceClient

Hiérarchie

InferenceClient

↳ InferenceClientEndpoint

Constructeurs

constructor

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

Paramètres

Nom	Type	Valeur par défaut
`accessToken`	`string`	`""`
`defaultOptions`	`Options` & { `endpointUrl?`: `string` }	`{}`

Méthodes

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>

Hérité de

InferenceClient.audioClassification

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[]>

Hérité de

InferenceClient.audioToAudio

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>

Hérité de

InferenceClient.automaticSpeechRecognition

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>

Hérité de

InferenceClient.chatCompletion

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>

Hérité de

InferenceClient.chatCompletionStream

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]>

Hérité de

InferenceClient.documentQuestionAnswering

Défini dans

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

endpoint

▸ endpoint(endpointUrl) : InferenceClient

Retourne une nouvelle instance de InferenceClient liée à un point de terminaison spécifié.

Principalement pour la rétrocompatibilité.

Paramètres

Nom	Type
`endpointUrl`	`string`

Retourne

InferenceClient

Hérité de

InferenceClient.endpoint

Défini dans

inference/src/InferenceClient.ts:46

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>

Hérité de

InferenceClient.featureExtraction

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>

Hérité de

InferenceClient.fillMask

Défini dans

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

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>

Hérité de

InferenceClient.imageClassification

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>

Hérité de

InferenceClient.imageSegmentation

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>

Hérité de

InferenceClient.imageTextToImage

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>

Hérité de

InferenceClient.imageTextToVideo

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>

Hérité de

InferenceClient.imageToImage

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>

Hérité de

InferenceClient.imageToText

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>

Hérité de

InferenceClient.imageToVideo

Défini dans

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

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>

Hérité de

InferenceClient.objectDetection

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]>

Hérité de

InferenceClient.questionAnswering

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.

Hérité de

InferenceClient.request

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>

Hérité de

InferenceClient.sentenceSimilarity

Défini dans

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

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.

Hérité de

InferenceClient.streamingRequest

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>

Hérité de

InferenceClient.summarization

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]>

Hérité de

InferenceClient.tableQuestionAnswering

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>

Hérité de

InferenceClient.tabularClassification

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>

Hérité de

InferenceClient.tabularRegression

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>

Hérité de

InferenceClient.textClassification

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>

Hérité de

InferenceClient.textGeneration

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>

Hérité de

InferenceClient.textGenerationStream

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>

Hérité de

InferenceClient.textRanking

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>

Hérité de

InferenceClient.textToAudio

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>

Hérité de

InferenceClient.textToImage

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>

Hérité de

InferenceClient.textToImage

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>

Hérité de

InferenceClient.textToImage

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

Hérité de

InferenceClient.textToImage

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>

Hérité de

InferenceClient.textToSpeech

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>

Hérité de

InferenceClient.textToVideo

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>

Hérité de

InferenceClient.tokenClassification

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>

Hérité de

InferenceClient.translation

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]>

Hérité de

InferenceClient.visualQuestionAnswering

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>

Hérité de

InferenceClient.zeroShotClassification

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>

Hérité de

InferenceClient.zeroShotImageClassification

Défini dans

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

Update on GitHub

←InferenceClient InferenceClientError→