Huggingface.js documentation

Класс: 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

Класс: InferenceClient

Иерархия

Task

↳ InferenceClient

↳↳ InferenceClientEndpoint

↳↳ HfInference

Конструкторы

constructor

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

Параметры

Имя	Тип	Значение по умолчанию
`accessToken`	`string`	`""`
`defaultOptions`	`Options` & { `endpointUrl?`: `string` }	`{}`

Возвращает

InferenceClient

Определено в

inference/src/InferenceClient.ts:15

Свойства

accessToken

• Private Readonly accessToken: string

Определено в

inference/src/InferenceClient.ts:12

defaultOptions

• Private Readonly defaultOptions: Options

Определено в

inference/src/InferenceClient.ts:13

Методы

audioClassification

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

Эта задача принимает на вход аудиоданные и выводит вероятность классов. Рекомендуемая модель: superb/hubert-large-superb-er

Параметры

Имя	Тип
`args`	`AudioClassificationArgs`
`options?`	`Options`

Возвращает

Promise<AudioClassificationOutput>

Определено в

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

audioToAudio

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

Эта задача принимает на вход аудиоданные и выводит один или несколько аудиофайлов. Пример модели: speechbrain/sepformer-wham выполняет разделение источников звука.

Параметры

Имя	Тип
`args`	`AudioToAudioArgs`
`options?`	`Options`

Возвращает

Promise<AudioToAudioOutput[]>

Определено в

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

automaticSpeechRecognition

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

Эта задача считывает аудиовход и выводит произнесённые слова из аудиофайлов. Рекомендуемая модель (английский язык): facebook/wav2vec2-large-960h-lv60-self

Параметры

Имя	Тип
`args`	`AutomaticSpeechRecognitionArgs`
`options?`	`Options`

Возвращает

Promise<AutomaticSpeechRecognitionOutput>

Определено в

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

chatCompletion

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

Используйте endpoint chat completion для генерации ответа на prompt, используя API завершения сообщений OpenAI без stream

Параметры

Имя	Тип
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Возвращает

Promise<ChatCompletionOutput>

Определено в

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

chatCompletionStream

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

Используйте для продолжения текста по промпту. Аналогично textGeneration, но возвращает генератор, из которого можно читать по одному токену за раз

Параметры

Имя	Тип
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Возвращает

AsyncGenerator<ChatCompletionStreamOutput>

Определено в

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

documentQuestionAnswering

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

Отвечает на вопрос по изображению документа. Рекомендуемая модель: impira/layoutlm-document-qa.

Параметры

Имя	Тип
`args`	`DocumentQuestionAnsweringArgs`
`options?`	`Options`

Возвращает

Promise<DocumentQuestionAnsweringOutput[number]>

Определено в

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

endpoint

▸ endpoint(endpointUrl): InferenceClient

Возвращает новый экземпляр InferenceClient, привязанный к указанному конечному пункту.

В основном для обратной совместимости.

Параметры

Имя	Тип
`endpointUrl`	`string`

Возвращает

InferenceClient

Определено в

inference/src/InferenceClient.ts:46

featureExtraction

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

Эта задача принимает на вход текст и выводит необработанные значения типа float, которые обычно используются в составе семантической базы данных или семантического поиска.

Параметры

Имя	Тип
`args`	`FeatureExtractionArgs`
`options?`	`Options`

Возвращает

Promise<FeatureExtractionOutput>

Определено в

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

fillMask

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

Пытается заполнить пропуск отсутствующим словом (точнее, токеном). Это базовая задача для моделей BERT.

Параметры

Имя	Тип
`args`	`FillMaskArgs`
`options?`	`Options`

Возвращает

Promise<FillMaskOutput>

Определено в

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

imageClassification

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

Эта задача принимает на вход изображение и выводит вероятность принадлежности к классам. Рекомендуемая модель: google/vit-base-patch16-224

Параметры

Имя	Тип
`args`	`ImageClassificationArgs`
`options?`	`Options`

Возвращает

Promise<ImageClassificationOutput>

Определено в

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

imageSegmentation

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

Эта задача принимает на вход изображение и выводит вероятность классов & ограничивающие рамки обнаруженных объектов. Рекомендуемая модель: facebook/detr-resnet-50-panoptic

Параметры

Имя	Тип
`args`	`ImageSegmentationArgs`
`options?`	`Options`

Возвращает

Promise<ImageSegmentationOutput>

Определено в

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

imageTextToImage

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

Эта задача принимает на вход изображение и текст и генерирует новое изображение. Рекомендуемая модель: black-forest-labs/FLUX.2-dev

Параметры

Имя	Тип
`args`	`ImageTextToImageArgs`
`options?`	`Options`

Возвращает

Promise<Blob>

Определено в

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

imageTextToVideo

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

Эта задача принимает на вход изображение и текст и генерирует видео. Рекомендуемая модель: Lightricks/LTX-Video

Параметры

Имя	Тип
`args`	`ImageTextToVideoArgs`
`options?`	`Options`

Возвращает

Promise<Blob>

Определено в

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

imageToImage

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

Эта задача принимает текстовый ввод и генерирует изображение. Рекомендуемая модель: lllyasviel/sd-controlnet-depth

Параметры

Имя	Тип
`args`	`ImageToImageArgs`
`options?`	`Options`

Возвращает

Promise<Blob>

Определено в

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

imageToText

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

Эта задача принимает на вход изображение и выводит текстовое описание.

Параметры

Имя	Тип
`args`	`ImageToTextArgs`
`options?`	`Options`

Возвращает

Promise<ImageToTextOutput>

Определено в

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

imageToVideo

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

Эта задача принимает текстовый ввод и генерирует изображение. Рекомендуемая модель: Wan-AI/Wan2.1-I2V-14B-720P

Параметры

Имя	Тип
`args`	`ImageToVideoArgs`
`options?`	`Options`

Возвращает

Promise<Blob>

Определено в

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

objectDetection

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

Эта задача принимает на вход изображение и выводит вероятности классов & ограничивающие рамки обнаруженных объектов. Рекомендуемая модель: facebook/detr-resnet-50

Параметры

Имя	Тип
`args`	`ObjectDetectionArgs`
`options?`	`Options`

Возвращает

Promise<ObjectDetectionOutput>

Определено в

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

questionAnswering

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

Хотите получить умного бота, который может ответить на любой вопрос? Рекомендуемая модель: deepset/roberta-base-squad2

Параметры

Имя	Тип
`args`	`QuestionAnsweringArgs`
`options?`	`Options`

Возвращает

Promise<QuestionAnsweringOutput[number]>

Определено в

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

запрос

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

Примитив для выполнения собственных вызовов провайдера инференса

Параметры типа

Имя
`T`

Параметры

Имя	Тип
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Возвращает

Promise<T>

Deprecated

Вместо этого используйте функции для конкретных задач. Эта функция будет удалена в будущей версии.

Определено в

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

sentenceSimilarity

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

Вычислите семантическую сходимость между одним текстом и списком других предложений, сравнив их эмбеддинги.

Параметры

Имя	Тип
`args`	`SentenceSimilarityArgs`
`options?`	`Options`

Возвращает

Promise<SentenceSimilarityOutput>

Определено в

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

streamingRequest

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

Примитив для создания собственных вызовов инференса, ожидающих события, отправляемые сервером, и возвращающих ответ через генератор

Параметры типа

Имя
`T`

Параметры

Имя	Тип
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Возвращает

AsyncGenerator<T>

Deprecated

Вместо этого используйте функции для конкретных задач. Эта функция будет удалена в будущей версии.

Определено в

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

суммаризация

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

Эта задача хорошо известна как суммаризация: она превращает длинный текст в более короткий. Обратите внимание, что у некоторых моделей есть максимальная длина входных данных. Это означает, например, что они не могут обработать целую книгу. Будьте внимательны при выборе модели.

Параметры

Имя	Тип
`args`	`SummarizationArgs`
`options?`	`Options`

Возвращает

Promise<SummarizationOutput>

Определено в

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

tableQuestionAnswering

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

Не знаете SQL? Не хотите погружаться в большую таблицу? Задавайте вопросы на обычном английском! Рекомендуемая модель: google/tapas-base-finetuned-wtq.

Параметры

Имя	Тип
`args`	`TableQuestionAnsweringArgs`
`options?`	`Options`

Возвращает

Promise<TableQuestionAnsweringOutput[number]>

Определено в

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

tabularClassification

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

Предсказывает целевую метку для заданного набора признаков в табличном формате. Как правило, вы хотите обучить модель классификации на обучающих данных и использовать её с новыми данными того же формата. Пример модели: vvmnnnkv/wine-quality

Параметры

Имя	Тип
`args`	`TabularClassificationArgs`
`options?`	`Options`

Возвращает

Promise<TabularClassificationOutput>

Определено в

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

tabularRegression

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

Предсказывает целевое значение для заданного набора признаков в табличном формате. Как правило, вы хотите обучить модель регрессии на своих обучающих данных и использовать её с новыми данными того же формата. Пример модели: scikit-learn/Fish-Weight

Параметры

Имя	Тип
`args`	`TabularRegressionArgs`
`options?`	`Options`

Возвращает

Promise<TabularRegressionOutput>

Определено в

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

textClassification

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

Обычно используется для анализа тональности; выводит вероятность классов для входных данных. Рекомендуемая модель: distilbert-base-uncased-finetuned-sst-2-english

Параметры

Имя	Тип
`args`	`TextClassificationArgs`
`options?`	`Options`

Возвращает

Promise<TextClassificationOutput>

Определено в

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

textGeneration

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

Используйте для продолжения текста по заданному промпту. Это очень общая задача. Рекомендуемая модель: gpt2 (это простая модель, но с ней интересно поиграть).

Параметры

Имя	Тип
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Возвращает

Promise<TextGenerationOutput>

Определено в

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

textGenerationStream

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

Параметры

Имя	Тип
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Возвращает

AsyncGenerator<TextGenerationStreamOutput>

Определено в

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

textRanking

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

Ранжируйте документы по их релевантности запросу с помощью модели-реранкера.

Параметры

Имя	Тип
`args`	`TextRankingArgs`
`options?`	`Options`

Возвращает

Promise<TextRankingOutput>

Определено в

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

textToAudio

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

Эта задача генерирует аудио (например, музыку или звуковые эффекты) по текстовому запросу. Пример модели: stabilityai/stable-audio-open-1.0

Параметры

Имя	Тип
`args`	`TextToAudioArgs`
`options?`	`Options`

Возвращает

Promise<Blob>

Определено в

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

textToImage

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

Эта задача принимает текстовый вход и выводит изображение. Рекомендуемая модель: stabilityai/stable-diffusion-2

Параметры

Имя	Тип
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"url"` }

Возвращает

Promise<string>

Определено в

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

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

Параметры

Имя	Тип
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"dataUrl"` }

Возвращает

Promise<string>

Определено в

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

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

Параметры

Имя	Тип
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"blob"` }

Возвращает

Promise<Blob>

Определено в

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

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

Параметры

Имя	Тип
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"json"` }

Возвращает

Promise<Record<string, unknown>>

Определено в

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

textToSpeech

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

Эта задача синтезирует аудио с голосом, произносящим заданный текст. Рекомендуемая модель: espnet/kan-bayashi_ljspeech_vits

Параметры

Имя	Тип
`args`	`TextToSpeechArgs`
`options?`	`Options`

Возвращает

Promise<Blob>

Определено в

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

textToVideo

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

Параметры

Имя	Тип
`args`	`TextToVideoArgs`
`options?`	`Options`

Возвращает

Promise<TextToVideoOutput>

Определено в

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

tokenClassification

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

Обычно используется для разбора предложений, грамматического или распознавания именованных сущностей (NER), чтобы понять ключевые слова, содержащиеся в тексте. Рекомендуемая модель: dbmdz/bert-large-cased-finetuned-conll03-english

Параметры

Имя	Тип
`args`	`TokenClassificationArgs`
`options?`	`Options`

Возвращает

Promise<TokenClassificationOutput>

Определено в

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

перевод

▸ перевод(args, options?): Promise<TranslationOutput>

Эта задача хорошо известна как перевод текста с одного языка на другой. Рекомендуемая модель: Helsinki-NLP/opus-mt-ru-en.

Параметры

Имя	Тип
`args`	`TranslationArgs`
`options?`	`Options`

Возвращает

Promise<TranslationOutput>

Определено в

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

visualQuestionAnswering

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

Отвечает на вопрос по изображению. Рекомендуемая модель: dandelin/vilt-b32-finetuned-vqa.

Параметры

Имя	Тип
`args`	`VisualQuestionAnsweringArgs`
`options?`	`Options`

Возвращает

Promise<VisualQuestionAnsweringOutput[number]>

Определено в

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

zeroShotClassification

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

Эта задача очень полезна для проверки классификации без написания кода: вы просто передаёте предложение/абзац и возможные метки для этого предложения, и получаете результат. Рекомендуемая модель: facebook/bart-large-mnli.

Параметры

Имя	Тип
`args`	`ZeroShotClassificationArgs`
`options?`	`Options`

Возвращает

Promise<ZeroShotClassificationOutput>

Определено в

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

zeroShotImageClassification

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

Классификация изображения по заданным классам. Рекомендуемая модель: openai/clip-vit-large-patch14-336

Параметры

Имя	Тип
`args`	`ZeroShotImageClassificationArgs`
`options?`	`Options`

Возвращает

Promise<ZeroShotImageClassificationOutput>

Определено в

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

Update on GitHub

←HfInference InferenceClientEndpoint→