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

Namespaces

trechos de código

Classes

Interfaces

Aliases de Tipo

AudioClassificationArgs

Ƭ AudioClassificationArgs: BaseArgs & AudioClassificationInput | LegacyAudioInput

Definido em

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

AudioToAudioArgs

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

Definido em

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

AuthMethod

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

Definido em

inference/src/types.ts:165

AutomaticSpeechRecognitionArgs

Ƭ AutomaticSpeechRecognitionArgs: BaseArgs & AutomaticSpeechRecognitionInput | LegacyAudioInput

Definido em

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

DocumentQuestionAnsweringArgs

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

Definido em

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

FeatureExtractionArgs

Ƭ FeatureExtractionArgs: BaseArgs & FeatureExtractionInput & FeatureExtractionOAICompatInput

Definido em

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

FeatureExtractionOutput

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

Os valores retornados são um array multidimensional de floats (a dimensão depende de você ter enviado uma string ou uma lista de strings, e se a redução automática, por exemplo, mean_pooling, foi aplicada para você ou não. Isso deve estar explicado no README do modelo).

Definido em

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

FillMaskArgs

Ƭ FillMaskArgs: BaseArgs & FillMaskInput

Definido em

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

ImageClassificationArgs

Ƭ ImageClassificationArgs: BaseArgs & ImageClassificationInput | LegacyImageInput

Definido em

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

ImageSegmentationArgs

Ƭ ImageSegmentationArgs: BaseArgs & ImageSegmentationInput

Definido em

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

ImageTextToImageArgs

Ƭ ImageTextToImageArgs: BaseArgs & ImageTextToImageInput

Definido em

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

ImageTextToVideoArgs

Ƭ ImageTextToVideoArgs: BaseArgs & ImageTextToVideoInput

Definido em

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

ImageToImageArgs

Ƭ ImageToImageArgs: BaseArgs & ImageToImageInput

Definido em

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

ImageToTextArgs

Ƭ ImageToTextArgs: BaseArgs & ImageToTextInput | LegacyImageInput

Definido em

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

ImageToVideoArgs

Ƭ ImageToVideoArgs: BaseArgs & ImageToVideoInput

Definido em

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

InferenceProvider

Ƭ InferenceProvider: typeof INFERENCE_PROVIDERS[number]

Definido em

inference/src/types.ts:73

InferenceProviderOrPolicy

Ƭ InferenceProviderOrPolicy: typeof PROVIDERS_OR_POLICIES[number]

Definido em

inference/src/types.ts:75

InferenceTask

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

Definido em

inference/src/types.ts:45

ModelId

Ƭ ModelId: string

ID do modelo do HF, como “meta-llama/Llama-3.3-70B-Instruct”

Definido em

inference/src/types.ts:6

ObjectDetectionArgs

Ƭ ObjectDetectionArgs: BaseArgs & ObjectDetectionInput | LegacyImageInput

Definido em

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

OutputType

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

Definido em

inference/src/types.ts:179

QuestionAnsweringArgs

Ƭ QuestionAnsweringArgs: BaseArgs & QuestionAnsweringInput

Definido em

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 }

Definido em

inference/src/types.ts:152

SentenceSimilarityArgs

Ƭ SentenceSimilarityArgs: BaseArgs & SentenceSimilarityInput

Definido em

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

SummarizationArgs

Ƭ SummarizationArgs: BaseArgs & SummarizationInput

Definido em

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

TableQuestionAnsweringArgs

Ƭ TableQuestionAnsweringArgs: BaseArgs & TableQuestionAnsweringInput

Definido em

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

TabularClassificationArgs

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

Definido em

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

TabularClassificationOutput

Ƭ TabularClassificationOutput: number[]

Uma lista de rótulos previstos para cada linha

Definido em

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

TabularRegressionArgs

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

Definido em

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

TabularRegressionOutput

Ƭ TabularRegressionOutput: number[]

uma lista de valores previstos para cada linha

Definido em

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

TextClassificationArgs

Ƭ TextClassificationArgs: BaseArgs & TextClassificationInput

Definido em

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

TextGenerationStreamFinishReason

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

Definido em

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

TextRankingArgs

Ƭ TextRankingArgs: BaseArgs & TextRankingInput

Definido em

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

TextToAudioArgs

Ƭ TextToAudioArgs: BaseArgs & TextToAudioInput

Definido em

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

TextToImageArgs

Ƭ TextToImageArgs: BaseArgs & TextToImageInput

Definido em

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

TextToVideoArgs

Ƭ TextToVideoArgs: BaseArgs & TextToVideoInput

Definido em

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

TextToVideoOutput

Ƭ TextToVideoOutput: Blob

Definido em

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

TokenClassificationArgs

Ƭ TokenClassificationArgs: BaseArgs & TokenClassificationInput

Definido em

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

TranslationArgs

Ƭ TranslationArgs: BaseArgs & TranslationInput

Definido em

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

VisualQuestionAnsweringArgs

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

Definido em

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

ZeroShotClassificationArgs

Ƭ ZeroShotClassificationArgs: BaseArgs & ZeroShotClassificationInput

Definido em

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

ZeroShotImageClassificationArgs

Ƭ ZeroShotImageClassificationArgs: BaseArgs & ZeroShotImageClassificationInput | LegacyZeroShotImageClassificationInput

Definido em

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

Variáveis

INFORÊNCIA _ FORNECEDORES

• Const INFERENCE_PROVIDERS: somente leitura ["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"]

Definido em

inference/src/types.ts:47

PROVEDORES

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

Definido em

inference/src/lib/getProviderHelper.ts:61

PROVEDORES _ HUB _ ORGS

• Const PROVIDERS_HUB_ORGS: Record<InferenceProvider, string>

O namespace de organização no HF Hub, ou seja, hf.co/…

Sempre que possível, InferenceProvider deve == namespace da organização

Definido em

inference/src/types.ts:82

PROVEDORES _ OU _ POLÍTICAS

• Const PROVIDERS_OR_POLICIES: somente leitura ["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"]

Definido em

inference/src/types.ts:71

Funções

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>

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

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>

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>

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>

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

Definido em

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

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>

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>

Definido em

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

getProviderHelper

▸ getProviderHelper(provider, task): TextToImageTaskHelper & TaskProviderHelper

Obter instância de helper de provedor por nome e tarefa

Parâmetros

Nome	Tipo
`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"`

Retorna

TextToImageTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:201

▸ getProviderHelper(provider, task): ConversationalTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ConversationalTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:205

▸ getProviderHelper(provider, task): TextGenerationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TextGenerationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:209

▸ getProviderHelper(provider, task): TextToSpeechTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TextToSpeechTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:213

▸ getProviderHelper(provider, task): TextToAudioTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TextToAudioTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:217

▸ getProviderHelper(provider, task): AutomaticSpeechRecognitionTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

AutomaticSpeechRecognitionTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:221

▸ getProviderHelper(provider, task): TextToVideoTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TextToVideoTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:225

▸ getProviderHelper(provider, task): TextClassificationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TextClassificationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:229

▸ getProviderHelper(provider, task): QuestionAnsweringTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

QuestionAnsweringTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:233

▸ getProviderHelper(provider, task): AudioClassificationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

AudioClassificationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:237

▸ getProviderHelper(provider, task): AudioToAudioTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

AudioToAudioTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:241

▸ getProviderHelper(provider, task): FillMaskTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

FillMaskTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:245

▸ getProviderHelper(provider, task): FeatureExtractionTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

FeatureExtractionTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:249

▸ getProviderHelper(provider, task): ImageClassificationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ImageClassificationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:253

▸ getProviderHelper(provider, task): ImageSegmentationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ImageSegmentationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:257

▸ getProviderHelper(provider, task): DocumentQuestionAnsweringTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

DocumentQuestionAnsweringTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:261

▸ getProviderHelper(provider, task): ImageToTextTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ImageToTextTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:265

▸ getProviderHelper(provider, task): ObjectDetectionTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ObjectDetectionTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:269

▸ getProviderHelper(provider, task): ZeroShotImageClassificationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ZeroShotImageClassificationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:273

▸ getProviderHelper(provider, task): ZeroShotClassificationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ZeroShotClassificationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:277

▸ getProviderHelper(provider, task): ImageToImageTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ImageToImageTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:281

▸ getProviderHelper(provider, task): ImageToVideoTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ImageToVideoTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:285

▸ getProviderHelper(provider, task): ImageTextToImageTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ImageTextToImageTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:289

▸ getProviderHelper(provider, task): ImageTextToVideoTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

ImageTextToVideoTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:293

▸ getProviderHelper(provider, task): TextRankingTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TextRankingTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:297

▸ getProviderHelper(provider, task): SentenceSimilarityTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

SentenceSimilarityTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:301

▸ getProviderHelper(provider, task): TableQuestionAnsweringTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TableQuestionAnsweringTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:305

▸ getProviderHelper(provider, task): TabularClassificationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TabularClassificationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:309

▸ getProviderHelper(provider, task): TabularRegressionTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TabularRegressionTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:313

▸ getProviderHelper(provider, task): TokenClassificationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TokenClassificationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:317

▸ getProviderHelper(provider, task): TranslationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

TranslationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:321

▸ getProviderHelper(provider, task): SummarizationTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

SummarizationTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:325

▸ getProviderHelper(provider, task): VisualQuestionAnsweringTaskHelper & TaskProviderHelper

Parâmetros

Nome	Tipo
`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"`

Retorna

VisualQuestionAnsweringTaskHelper & TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:329

▸ getProviderHelper(provider, task): TaskProviderHelper

Parâmetros

Nome	Tipo
`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`

Retorna

TaskProviderHelper

Definido em

inference/src/lib/getProviderHelper.ts:333

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>

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>

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>

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>

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>

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>

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>

Definido em

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

makeRequestOptions

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

Auxiliar que prepara os argumentos da solicitação. Esta versão assíncrona trata a etapa de resolução do ID do modelo.

Parâmetros

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

Retorna

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

Definido em

inference/src/lib/makeRequestOptions.ts:19

makeRequestOptionsFromResolvedModel

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

Auxiliar que prepara os argumentos da solicitação. - apenas para uso interno Esta versão síncrona ignora a etapa de resolução do ID do modelo

Parâmetros

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

Retorna

Object

Nome	Tipo
`info`	`RequestInit`
`url`	`string`

Definido em

inference/src/lib/makeRequestOptions.ts:105

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>

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

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.

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>

Definido em

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

setLogger

▸ setLogger(logger): void

Parâmetros

Nome	Tipo
`logger`	`Logger`

Retorna

void

Definido em

inference/src/lib/logger.ts:5

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.

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>

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

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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

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>

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>

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>

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>

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

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>

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>

Definido em

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

Update on GitHub

←Usar o Inference Client HfInference→