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

Apenas para compatibilidade reversa, será removido em breve.

Deprecated

substituir por InferenceClient

Hierarquia

InferenceClient

↳ InferenceClientEndpoint

Construtores

constructor

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

Parâmetros

Nome	Tipo	Valor padrão
`accessToken`	`string`	`""`
`defaultOptions`	`Options` & { `endpointUrl?`: `string` }	`{}`

Métodos

audioClassification

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

Esta tarefa lê uma entrada de áudio e fornece a probabilidade de classes. Modelo recomendado: superb/hubert-large-superb-er

Parâmetros

Nome	Tipo
`args`	`AudioClassificationArgs`
`options?`	`Options`

Retorna

Promise<AudioClassificationOutput>

Herdado de

InferenceClient.audioClassification

Definido em

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

audioToAudio

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

Esta tarefa lê uma entrada de áudio e gera um ou vários arquivos de áudio. Modelo de exemplo: speechbrain/sepformer-wham realiza separação de fontes de áudio.

Parâmetros

Nome	Tipo
`args`	`AudioToAudioArgs`
`options?`	`Options`

Retorna

Promise<AudioToAudioOutput[]>

Herdado de

InferenceClient.audioToAudio

Definido em

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

automaticSpeechRecognition

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

Esta tarefa lê uma entrada de áudio e exibe as palavras ditas nos arquivos de áudio. Modelo recomendado (idioma inglês): facebook/wav2vec2-large-960h-lv60-self

Parâmetros

Nome	Tipo
`args`	`AutomaticSpeechRecognitionArgs`
`options?`	`Options`

Retorna

Promise<AutomaticSpeechRecognitionOutput>

Herdado de

InferenceClient.automaticSpeechRecognition

Definido em

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

chatCompletion

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

Use o endpoint de conclusão de chat para gerar uma resposta a um prompt, usando a API de conclusão de mensagens da OpenAI sem stream

Parâmetros

Nome	Tipo
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Retorna

Promise<ChatCompletionOutput>

Herdado de

InferenceClient.chatCompletion

Definido em

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

chatCompletionStream

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

Use para continuar um texto a partir de um prompt. Igual a textGeneration, mas retorna um gerador que pode ser lido um token de cada vez

Parâmetros

Nome	Tipo
`args`	`BaseArgs` & `ChatCompletionInput`
`options?`	`Options`

Retorna

AsyncGenerator<ChatCompletionStreamOutput>

Herdado de

InferenceClient.chatCompletionStream

Definido em

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

documentQuestionAnswering

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

Responde a uma pergunta em uma imagem de documento. Modelo recomendado: impira/layoutlm-document-qa.

Parâmetros

Nome	Tipo
`args`	`DocumentQuestionAnsweringArgs`
`options?`	`Options`

Retorna

Promise<DocumentQuestionAnsweringOutput[number]>

Herdado de

InferenceClient.documentQuestionAnswering

Definido em

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

endpoint

▸ ponto de extremidade(endpointUrl): InferenceClient

Retorna uma nova instância de InferenceClient vinculada a um endpoint especificado.

Principalmente por compatibilidade reversa.

Parâmetros

Nome	Tipo
`endpointUrl`	`string`

Retorna

InferenceClient

Herdado de

InferenceClient.endpoint

Definido em

inference/src/InferenceClient.ts:46

featureExtraction

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

Esta tarefa lê algum texto e produz valores float brutos, que geralmente são consumidos como parte de um banco de dados semântico/busca semântica.

Parâmetros

Nome	Tipo
`args`	`FeatureExtractionArgs`
`options?`	`Options`

Retorna

Promise<FeatureExtractionOutput>

Herdado de

InferenceClient.featureExtraction

Definido em

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

fillMask

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

Tenta preencher um buraco com uma palavra ausente (mais precisamente, um token). Essa é a tarefa base para os modelos BERT.

Parâmetros

Nome	Tipo
`args`	`FillMaskArgs`
`options?`	`Options`

Retorna

Promise<FillMaskOutput>

Herdado de

InferenceClient.fillMask

Definido em

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

imageClassification

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

Esta tarefa lê uma entrada de imagem e produz a probabilidade das classes. Modelo recomendado: google/vit-base-patch16-224

Parâmetros

Nome	Tipo
`args`	`ImageClassificationArgs`
`options?`	`Options`

Retorna

Promise<ImageClassificationOutput>

Herdado de

InferenceClient.imageClassification

Definido em

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

imageSegmentation

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

Esta tarefa lê uma entrada de imagem e produz a probabilidade das classes & as caixas delimitadoras dos objetos detectados. Modelo recomendado: facebook/detr-resnet-50-panoptic

Parâmetros

Nome	Tipo
`args`	`ImageSegmentationArgs`
`options?`	`Options`

Retorna

Promise<ImageSegmentationOutput>

Herdado de

InferenceClient.imageSegmentation

Definido em

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

imageTextToImage

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

Esta tarefa recebe uma imagem e um texto como entrada e gera uma nova imagem. Modelo recomendado: black-forest-labs/FLUX.2-dev

Parâmetros

Nome	Tipo
`args`	`ImageTextToImageArgs`
`options?`	`Options`

Retorna

Promise<Blob>

Herdado de

InferenceClient.imageTextToImage

Definido em

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

imageTextToVideo

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

Esta tarefa recebe uma imagem e um texto como entrada e gera um vídeo como saída. Modelo recomendado: Lightricks/LTX-Video

Parâmetros

Nome	Tipo
`args`	`ImageTextToVideoArgs`
`options?`	`Options`

Retorna

Promise<Blob>

Herdado de

InferenceClient.imageTextToVideo

Definido em

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

imageToImage

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

Esta tarefa lê uma entrada de texto e gera uma imagem. Modelo recomendado: lllyasviel/sd-controlnet-depth

Parâmetros

Nome	Tipo
`args`	`ImageToImageArgs`
`options?`	`Options`

Retorna

Promise<Blob>

Herdado de

InferenceClient.imageToImage

Definido em

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

imageToText

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

Esta tarefa lê uma entrada de imagem e gera a legenda de texto.

Parâmetros

Nome	Tipo
`args`	`ImageToTextArgs`
`options?`	`Options`

Retorna

Promise<ImageToTextOutput>

Herdado de

InferenceClient.imageToText

Definido em

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

imageToVideo

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

Esta tarefa lê uma entrada de texto e gera uma imagem. Modelo recomendado: Wan-AI/Wan2.1-I2V-14B-720P

Parâmetros

Nome	Tipo
`args`	`ImageToVideoArgs`
`options?`	`Options`

Retorna

Promise<Blob>

Herdado de

InferenceClient.imageToVideo

Definido em

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

objectDetection

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

Esta tarefa lê uma entrada de imagem e produz a probabilidade das classes & as caixas delimitadoras dos objetos detectados. Modelo recomendado: facebook/detr-resnet-50

Parâmetros

Nome	Tipo
`args`	`ObjectDetectionArgs`
`options?`	`Options`

Retorna

Promise<ObjectDetectionOutput>

Herdado de

InferenceClient.objectDetection

Definido em

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

questionAnswering

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

Quer ter um bot que sabe de tudo e pode responder a qualquer pergunta? Modelo recomendado: deepset/roberta-base-squad2

Parâmetros

Nome	Tipo
`args`	`QuestionAnsweringArgs`
`options?`	`Options`

Retorna

Promise<QuestionAnsweringOutput[number]>

Herdado de

InferenceClient.questionAnswering

Definido em

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

request

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

Primitive para fazer chamadas personalizadas ao provedor de inferência

Parâmetros de tipo

Nome
`T`

Parâmetros

Nome	Tipo
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Retorna

Promise<T>

Deprecated

Use funções de tarefa específicas em vez disso. Esta função será removida em uma versão futura.

Herdado de

InferenceClient.request

Definido em

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

sentenceSimilarity

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

Calcule a similaridade semântica entre um texto e uma lista de outras frases comparando seus embeddings.

Parâmetros

Nome	Tipo
`args`	`SentenceSimilarityArgs`
`options?`	`Options`

Retorna

Promise<SentenceSimilarityOutput>

Herdado de

InferenceClient.sentenceSimilarity

Definido em

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

streamingRequest

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

Primitive para fazer chamadas de inferência personalizadas que esperam eventos enviados pelo servidor e retorna a resposta por meio de um gerador

Parâmetros de tipo

Nome
`T`

Parâmetros

Nome	Tipo
`args`	`RequestArgs`
`options?`	`Options` & { `task?`: `InferenceTask` }

Retorna

AsyncGenerator<T>

Deprecated

Use funções de tarefa específicas em vez disso. Esta função será removida em uma versão futura.

Herdado de

InferenceClient.streamingRequest

Definido em

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

sumarização

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

Esta tarefa é bem conhecida por resumir textos mais longos em textos mais curtos. Tenha cuidado, pois alguns modelos possuem um comprimento máximo de entrada. Isso significa que o resumo não consegue processar, por exemplo, livros inteiros. Tenha cuidado ao escolher seu modelo.

Parâmetros

Nome	Tipo
`args`	`SummarizationArgs`
`options?`	`Options`

Retorna

Promise<SummarizationOutput>

Herdado de

InferenceClient.summarization

Definido em

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

tableQuestionAnswering

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

Não sabe SQL? Não quer se aprofundar em uma planilha grande? Faça perguntas em inglês simples! Modelo recomendado: google/tapas-base-finetuned-wtq.

Parâmetros

Nome	Tipo
`args`	`TableQuestionAnsweringArgs`
`options?`	`Options`

Retorna

Promise<TableQuestionAnsweringOutput[number]>

Herdado de

InferenceClient.tableQuestionAnswering

Definido em

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

tabularClassification

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

Prevê o rótulo alvo para um conjunto de recursos em formato tabular. Normalmente, você treinará um modelo de classificação em seus dados de treinamento e o usará com seus novos dados no mesmo formato. Modelo de exemplo: vvmnnnkv/wine-quality

Parâmetros

Nome	Tipo
`args`	`TabularClassificationArgs`
`options?`	`Options`

Retorna

Promise<TabularClassificationOutput>

Herdado de

InferenceClient.tabularClassification

Definido em

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

tabularRegression

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

Prevê o valor alvo para um conjunto de recursos em formato tabular. Normalmente, você treinará um modelo de regressão em seus dados de treinamento e o usará com seus novos dados no mesmo formato. Modelo de exemplo: scikit-learn/Fish-Weight

Parâmetros

Nome	Tipo
`args`	`TabularRegressionArgs`
`options?`	`Options`

Retorna

Promise<TabularRegressionOutput>

Herdado de

InferenceClient.tabularRegression

Definido em

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

textClassification

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

Normalmente usado para análise de sentimento, isso exibirá a probabilidade das classes de uma entrada. Modelo recomendado: distilbert-base-uncased-finetuned-sst-2-english

Parâmetros

Nome	Tipo
`args`	`TextClassificationArgs`
`options?`	`Options`

Retorna

Promise<TextClassificationOutput>

Herdado de

InferenceClient.textClassification

Definido em

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

textGeneration

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

Use para continuar um texto a partir de um prompt. Esta é uma tarefa muito genérica. Modelo recomendado: gpt2 (é um modelo simples, mas divertido para experimentar).

Parâmetros

Nome	Tipo
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Retorna

Promise<TextGenerationOutput>

Herdado de

InferenceClient.textGeneration

Definido em

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

textGenerationStream

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

Use para continuar um texto a partir de um prompt. Igual a textGeneration, mas retorna um gerador que pode ser lido um token de cada vez

Parâmetros

Nome	Tipo
`args`	`BaseArgs` & `TextGenerationInput`
`options?`	`Options`

Retorna

AsyncGenerator<TextGenerationStreamOutput>

Herdado de

InferenceClient.textGenerationStream

Definido em

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

textRanking

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

Classifique documentos pela sua relevância em relação a uma consulta usando um modelo de reranker.

Parâmetros

Nome	Tipo
`args`	`TextRankingArgs`
`options?`	`Options`

Retorna

Promise<TextRankingOutput>

Herdado de

InferenceClient.textRanking

Definido em

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

textToAudio

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

Esta tarefa gera áudio (por exemplo, música ou efeitos sonoros) a partir de um prompt de texto de entrada. Modelo de exemplo: stabilityai/stable-audio-open-1.0

Parâmetros

Nome	Tipo
`args`	`TextToAudioArgs`
`options?`	`Options`

Retorna

Promise<Blob>

Herdado de

InferenceClient.textToAudio

Definido em

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

textToImage

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

Esta tarefa lê uma entrada de texto e gera uma imagem. Modelo recomendado: stabilityai/stable-diffusion-2

Parâmetros

Nome	Tipo
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"url"` }

Retorna

Promise<string>

Herdado de

InferenceClient.textToImage

Definido em

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

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

Parâmetros

Nome	Tipo
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType`: `"dataUrl"` }

Retorna

Promise<string>

Herdado de

InferenceClient.textToImage

Definido em

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

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

Parâmetros

Nome	Tipo
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"blob"` }

Retorna

Promise<Blob>

Herdado de

InferenceClient.textToImage

Definido em

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

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

Parâmetros

Nome	Tipo
`args`	`TextToImageArgs`
`options?`	`TextToImageOptions` & { `outputType?`: `"json"` }

Retorna

Promise<Record<string, unknown>>

Herdado de

InferenceClient.textToImage

Definido em

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

textToSpeech

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

Esta tarefa sintetiza um áudio de uma voz pronunciando um texto dado. Modelo recomendado: espnet/kan-bayashi_ljspeech_vits

Parâmetros

Nome	Tipo
`args`	`TextToSpeechArgs`
`options?`	`Options`

Retorna

Promise<Blob>

Herdado de

InferenceClient.textToSpeech

Definido em

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

textToVideo

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

Parâmetros

Nome	Tipo
`args`	`TextToVideoArgs`
`options?`	`Options`

Retorna

Promise<TextToVideoOutput>

Herdado de

InferenceClient.textToVideo

Definido em

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

tokenClassification

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

Normalmente usado para análise de sentenças, seja gramatical, seja Reconhecimento de Entidades Nomeadas (NER), para entender as palavras-chave contidas no texto. Modelo recomendado: dbmdz/bert-large-cased-finetuned-conll03-english

Parâmetros

Nome	Tipo
`args`	`TokenClassificationArgs`
`options?`	`Options`

Retorna

Promise<TokenClassificationOutput>

Herdado de

InferenceClient.tokenClassification

Definido em

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

tradução

▸ tradução(args, options?): Promise<TranslationOutput>

Esta tarefa é bem conhecida para traduzir texto de um idioma para outro. Modelo recomendado: Helsinki-NLP/opus-mt-ru-en.

Parâmetros

Nome	Tipo
`args`	`TranslationArgs`
`options?`	`Options`

Retorna

Promise<TranslationOutput>

Herdado de

InferenceClient.tradução

Definido em

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

visualQuestionAnswering

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

Responde a uma pergunta sobre uma imagem. Modelo recomendado: dandelin/vilt-b32-finetuned-vqa.

Parâmetros

Nome	Tipo
`args`	`VisualQuestionAnsweringArgs`
`options?`	`Options`

Retorna

Promise<VisualQuestionAnsweringOutput[number]>

Herdado de

InferenceClient.visualQuestionAnswering

Definido em

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

zeroShotClassification

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

Esta tarefa é muito útil para experimentar a classificação sem escrever código: basta passar uma frase/parágrafo e os rótulos possíveis para essa frase, e você obtém um resultado. Modelo recomendado: facebook/bart-large-mnli.

Parâmetros

Nome	Tipo
`args`	`ZeroShotClassificationArgs`
`options?`	`Options`

Retorna

Promise<ZeroShotClassificationOutput>

Herdado de

InferenceClient.zeroShotClassification

Definido em

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

zeroShotImageClassification

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

Classifique uma imagem em classes especificadas. Modelo recomendado: openai/clip-vit-large-patch14-336

Parâmetros

Nome	Tipo
`args`	`ZeroShotImageClassificationArgs`
`options?`	`Options`

Retorna

Promise<ZeroShotImageClassificationOutput>

Herdado de

InferenceClient.zeroShotImageClassification

Definido em

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

Update on GitHub

←InferenceClient InferenceClientError→