Huggingface.js documentation
Clase: InferenceClient
Clase: InferenceClient
Jerarquía
Task↳
InferenceClient↳↳
HfInference
Constructores
constructor
• nuevo InferenceClient(accessToken?, defaultOptions?): InferenceClient
Parámetros
| Nombre | Tipo | Valor predeterminado |
|---|---|---|
accessToken | string | "" |
defaultOptions | Options & { endpointUrl?: string } | {} |
Devuelve
Definido en
inference/src/InferenceClient.ts:15
Propiedades
accessToken
• Private Readonly accessToken: string
Definido en
inference/src/InferenceClient.ts:12
defaultOptions
• Private Readonly defaultOptions: Options
Definido en
inference/src/InferenceClient.ts:13
Métodos
audioClassification
▸ audioClassification(args, options?): Promise<AudioClassificationOutput>
Esta tarea lee una entrada de audio y genera la probabilidad de las clases. Modelo recomendado: superb/hubert-large-superb-er
Parámetros
| Nombre | Tipo |
|---|---|
args | AudioClassificationArgs |
options? | Options |
Devuelve
Promise<AudioClassificationOutput>
Definido en
inference/src/tasks/audio/audioClassification.ts:15
audioToAudio
▸ audioToAudio(args, options?): Promise<AudioToAudioOutput[]>
Esta tarea lee una entrada de audio y genera uno o varios archivos de audio. Modelo de ejemplo: speechbrain/sepformer-wham realiza la separación de fuentes de audio.
Parámetros
| Nombre | Tipo |
|---|---|
args | AudioToAudioArgs |
options? | Options |
Devuelve
Promise<AudioToAudioOutput[]>
Definido en
inference/src/tasks/audio/audioToAudio.ts:41
automaticSpeechRecognition
▸ automaticSpeechRecognition(args, options?): Promise<AutomaticSpeechRecognitionOutput>
Esta tarea lee una entrada de audio y genera las palabras dichas dentro de los archivos de audio. Modelo recomendado (idioma inglés): facebook/wav2vec2-large-960h-lv60-self
Parámetros
| Nombre | Tipo |
|---|---|
args | AutomaticSpeechRecognitionArgs |
options? | Options |
Devuelve
Promise<AutomaticSpeechRecognitionOutput>
Definido en
inference/src/tasks/audio/automaticSpeechRecognition.ts:13
chatCompletion
▸ chatCompletion(args, options?): Promise<ChatCompletionOutput>
Use el endpoint de chat completion para generar una respuesta a un prompt, usando la API de completado de mensajes de OpenAI sin stream
Parámetros
| Nombre | Tipo |
|---|---|
args | BaseArgs & ChatCompletionInput |
options? | Options |
Devuelve
Promise<ChatCompletionOutput>
Definido en
inference/src/tasks/nlp/chatCompletion.ts:12
chatCompletionStream
▸ chatCompletionStream(args, options?): AsyncGenerator<ChatCompletionStreamOutput>
Se utiliza para continuar un texto a partir de un prompt. Es lo mismo que textGeneration, pero devuelve un generador que se puede leer un token a la vez.
Parámetros
| Nombre | Tipo |
|---|---|
args | BaseArgs & ChatCompletionInput |
options? | Options |
Devuelve
AsyncGenerator<ChatCompletionStreamOutput>
Definido en
inference/src/tasks/nlp/chatCompletionStream.ts:12
documentQuestionAnswering
▸ documentQuestionAnswering(args, options?): Promise<DocumentQuestionAnsweringOutput[number]>
Responde una pregunta sobre una imagen de documento. Modelo recomendado: impira/layoutlm-document-qa.
Parámetros
| Nombre | Tipo |
|---|---|
args | DocumentQuestionAnsweringArgs |
options? | Options |
Devuelve
Promise<DocumentQuestionAnsweringOutput[number]>
Definido en
inference/src/tasks/multimodal/documentQuestionAnswering.ts:19
endpoint
▸ punto de acceso(endpointUrl): InferenceClient
Devuelve una nueva instancia de InferenceClient vinculada a un punto de acceso especificado.
Principalmente por compatibilidad con versiones anteriores.
Parámetros
| Nombre | Tipo |
|---|---|
endpointUrl | string |
Devuelve
Definido en
inference/src/InferenceClient.ts:46
featureExtraction
▸ featureExtraction(args, options?): Promise<FeatureExtractionOutput>
Esta tarea lee algún texto y genera valores flotantes crudos, que normalmente se consumen como parte de una base de datos semántica o una búsqueda semántica.
Parámetros
| Nombre | Tipo |
|---|---|
args | FeatureExtractionArgs |
options? | Options |
Devuelve
Promise<FeatureExtractionOutput>
Definido en
inference/src/tasks/nlp/featureExtraction.ts:22
fillMask
▸ fillMask(args, options?): Promise<FillMaskOutput>
Intenta rellenar un hueco con una palabra faltante (un token, para ser precisos). Esa es la tarea base para los modelos BERT.
Parámetros
| Nombre | Tipo |
|---|---|
args | FillMaskArgs |
options? | Options |
Devuelve
Promise<FillMaskOutput>
Definido en
inference/src/tasks/nlp/fillMask.ts:12
imageClassification
▸ imageClassification(args, options?): Promise<ImageClassificationOutput>
Esta tarea lee una entrada de imagen y genera la probabilidad de las clases. Modelo recomendado: google/vit-base-patch16-224
Parámetros
| Nombre | Tipo |
|---|---|
args | ImageClassificationArgs |
options? | Options |
Devuelve
Promise<ImageClassificationOutput>
Definido en
inference/src/tasks/cv/imageClassification.ts:14
imageSegmentation
▸ imageSegmentation(args, options?): Promise<ImageSegmentationOutput>
Esta tarea lee una entrada de imagen y genera la probabilidad de las clases y las cajas delimitadoras de los objetos detectados. Modelo recomendado: facebook/detr-resnet-50-panoptic
Parámetros
| Nombre | Tipo |
|---|---|
args | ImageSegmentationArgs |
options? | Options |
Devuelve
Promise<ImageSegmentationOutput>
Definido en
inference/src/tasks/cv/imageSegmentation.ts:14
imageTextToImage
▸ imageTextToImage(args, options?): Promise<Blob>
Esta tarea toma una imagen y un texto como entrada y genera una nueva imagen. Modelo recomendado: black-forest-labs/FLUX.2-dev
Parámetros
| Nombre | Tipo |
|---|---|
args | ImageTextToImageArgs |
options? | Options |
Devuelve
Promise<Blob>
Definido en
inference/src/tasks/cv/imageTextToImage.ts:13
imageTextToVideo
▸ imageTextToVideo(args, options?): Promise<Blob>
Esta tarea toma una imagen y un texto como entrada y genera un video como salida. Modelo recomendado: Lightricks/LTX-Video
Parámetros
| Nombre | Tipo |
|---|---|
args | ImageTextToVideoArgs |
options? | Options |
Devuelve
Promise<Blob>
Definido en
inference/src/tasks/cv/imageTextToVideo.ts:13
imageToImage
▸ imageToImage(args, options?): Promise<Blob>
Esta tarea lee una entrada de texto y genera una imagen. Modelo recomendado: lllyasviel/sd-controlnet-depth
Parámetros
| Nombre | Tipo |
|---|---|
args | ImageToImageArgs |
options? | Options |
Devuelve
Promise<Blob>
Definido en
inference/src/tasks/cv/imageToImage.ts:14
imageToText
▸ imageToText(args, options?): Promise<ImageToTextOutput>
Esta tarea lee una entrada de imagen y genera la descripción de texto.
Parámetros
| Nombre | Tipo |
|---|---|
args | ImageToTextArgs |
options? | Options |
Devuelve
Promise<ImageToTextOutput>
Definido en
inference/src/tasks/cv/imageToText.ts:12
imageToVideo
▸ imageToVideo(args, options?): Promise<Blob>
Esta tarea lee una entrada de texto y genera una imagen. Modelo recomendado: Wan-AI/Wan2.1-I2V-14B-720P
Parámetros
| Nombre | Tipo |
|---|---|
args | ImageToVideoArgs |
options? | Options |
Devuelve
Promise<Blob>
Definido en
inference/src/tasks/cv/imageToVideo.ts:14
objectDetection
▸ objectDetection(args, options?): Promise<ObjectDetectionOutput>
Esta tarea lee una entrada de imagen y genera la probabilidad de las clases y las cajas delimitadoras de los objetos detectados. Modelo recomendado: facebook/detr-resnet-50
Parámetros
| Nombre | Tipo |
|---|---|
args | ObjectDetectionArgs |
options? | Options |
Devuelve
Promise<ObjectDetectionOutput>
Definido en
inference/src/tasks/cv/objectDetection.ts:14
questionAnswering
▸ questionAnswering(args, options?): Promise<QuestionAnsweringOutput[number]>
¿Quieres tener un bot que lo sepa todo y pueda responder cualquier pregunta? Modelo recomendado: deepset/roberta-base-squad2
Parámetros
| Nombre | Tipo |
|---|---|
args | QuestionAnsweringArgs |
options? | Options |
Devuelve
Promise<QuestionAnsweringOutput[number]>
Definido en
inference/src/tasks/nlp/questionAnswering.ts:13
request
▸ request<T>(args, options?): Promise<T>
Primitive para realizar llamadas personalizadas al proveedor de inferencia
Parámetros de tipo
| Nombre |
|---|
T |
Parámetros
| Nombre | Tipo |
|---|---|
args | RequestArgs |
options? | Options & { task?: InferenceTask } |
Devuelve
Promise<T>
Deprecated
Use en su lugar funciones de tareas específicas. Esta función se eliminará en una versión futura.
Definido en
inference/src/tasks/custom/request.ts:11
sentenceSimilarity
▸ sentenceSimilarity(args, options?): Promise<SentenceSimilarityOutput>
Calcule la similitud semántica entre un texto y una lista de otras oraciones comparando sus embeddings.
Parámetros
| Nombre | Tipo |
|---|---|
args | SentenceSimilarityArgs |
options? | Options |
Devuelve
Promise<SentenceSimilarityOutput>
Definido en
inference/src/tasks/nlp/sentenceSimilarity.ts:12
streamingRequest
▸ streamingRequest<T>(args, options?): AsyncGenerator<T>
Primitive para realizar llamadas de inferencia personalizadas que esperan eventos enviados por el servidor y devuelve la respuesta a través de un generador
Parámetros de tipo
| Nombre |
|---|
T |
Parámetros
| Nombre | Tipo |
|---|---|
args | RequestArgs |
options? | Options & { task?: InferenceTask } |
Devuelve
AsyncGenerator<T>
Deprecated
Use en su lugar funciones de tareas específicas. Esta función se eliminará en una versión futura.
Definido en
inference/src/tasks/custom/streamingRequest.ts:11
resumen
▸ resumen(args, options?): Promise<SummarizationOutput>
Esta tarea es bien conocida por resumir textos más largos en textos más cortos. Ten en cuenta que algunos modelos tienen una longitud máxima de entrada. Esto significa que el resumen no puede manejar, por ejemplo, libros completos. Ten cuidado al elegir tu modelo.
Parámetros
| Nombre | Tipo |
|---|---|
args | SummarizationArgs |
options? | Options |
Devuelve
Promise<SummarizationOutput>
Definido en
inference/src/tasks/nlp/summarization.ts:12
tableQuestionAnswering
▸ tableQuestionAnswering(args, options?): Promise<TableQuestionAnsweringOutput[number]>
¿No conoces SQL? ¿No quieres meterte en una hoja de cálculo enorme? ¡Haz preguntas en inglés sencillo! Modelo recomendado: google/tapas-base-finetuned-wtq.
Parámetros
| Nombre | Tipo |
|---|---|
args | TableQuestionAnsweringArgs |
options? | Options |
Devuelve
Promise<TableQuestionAnsweringOutput[number]>
Definido en
inference/src/tasks/nlp/tableQuestionAnswering.ts:12
tabularClassification
▸ tabularClassification(args, options?): Promise<TabularClassificationOutput>
Predice la etiqueta objetivo para un conjunto de características dado en formato tabular. Normalmente, se desea entrenar un modelo de clasificación con los datos de entrenamiento y utilizarlo con nuevos datos del mismo formato. Modelo de ejemplo: vvmnnnkv/wine-quality
Parámetros
| Nombre | Tipo |
|---|---|
args | TabularClassificationArgs |
options? | Options |
Devuelve
Promise<TabularClassificationOutput>
Definido en
inference/src/tasks/tabular/tabularClassification.ts:25
tabularRegression
▸ tabularRegression(args, options?): Promise<TabularRegressionOutput>
Predice el valor objetivo para un conjunto de características dado en formato tabular. Normalmente, se desea entrenar un modelo de regresión con los datos de entrenamiento y utilizarlo con nuevos datos del mismo formato. Modelo de ejemplo: scikit-learn/Fish-Weight
Parámetros
| Nombre | Tipo |
|---|---|
args | TabularRegressionArgs |
options? | Options |
Devuelve
Promise<TabularRegressionOutput>
Definido en
inference/src/tasks/tabular/tabularRegression.ts:25
textClassification
▸ textClassification(args, options?): Promise<TextClassificationOutput>
Se utiliza habitualmente para el análisis de sentimiento y devuelve la probabilidad de las clases de una entrada. Modelo recomendado: distilbert-base-uncased-finetuned-sst-2-english
Parámetros
| Nombre | Tipo |
|---|---|
args | TextClassificationArgs |
options? | Options |
Devuelve
Promise<TextClassificationOutput>
Definido en
inference/src/tasks/nlp/textClassification.ts:12
textGeneration
▸ textGeneration(args, options?): Promise<TextGenerationOutput>
Se utiliza para continuar un texto a partir de un prompt. Esta es una tarea muy genérica. Modelo recomendado: gpt2 (es un modelo simple, pero divertido de usar).
Parámetros
| Nombre | Tipo |
|---|---|
args | BaseArgs & TextGenerationInput |
options? | Options |
Devuelve
Promise<TextGenerationOutput>
Definido en
inference/src/tasks/nlp/textGeneration.ts:12
textGenerationStream
▸ textGenerationStream(args, options?): AsyncGenerator<TextGenerationStreamOutput>
Se utiliza para continuar un texto a partir de un prompt. Es lo mismo que textGeneration, pero devuelve un generador que se puede leer un token a la vez.
Parámetros
| Nombre | Tipo |
|---|---|
args | BaseArgs & TextGenerationInput |
options? | Options |
Devuelve
AsyncGenerator<TextGenerationStreamOutput>
Definido en
inference/src/tasks/nlp/textGenerationStream.ts:90
textRanking
▸ textRanking(args, options?): Promise<TextRankingOutput>
Rankear documentos según su relevancia para una consulta utilizando un modelo reranker.
Parámetros
| Nombre | Tipo |
|---|---|
args | TextRankingArgs |
options? | Options |
Devuelve
Promise<TextRankingOutput>
Definido en
inference/src/tasks/nlp/textRanking.ts:12
textToAudio
▸ textToAudio(args, options?): Promise<Blob>
Esta tarea genera audio (por ejemplo, música o efectos de sonido) a partir de un texto de entrada. Modelo de ejemplo: stabilityai/stable-audio-open-1.0
Parámetros
| Nombre | Tipo |
|---|---|
args | TextToAudioArgs |
options? | Options |
Devuelve
Promise<Blob>
Definido en
inference/src/tasks/audio/textToAudio.ts:18
textToImage
▸ textToImage(args, options?): Promise<string>
Esta tarea lee una entrada de texto y genera una imagen. Modelo recomendado: stabilityai/stable-diffusion-2
Parámetros
| Nombre | Tipo |
|---|---|
args | TextToImageArgs |
options? | TextToImageOptions & { outputType: "url" } |
Devuelve
Promise<string>
Definido en
inference/src/tasks/cv/textToImage.ts:18
▸ textToImage(args, options?): Promise<string>
Parámetros
| Nombre | Tipo |
|---|---|
args | TextToImageArgs |
options? | TextToImageOptions & { outputType: "dataUrl" } |
Devuelve
Promise<string>
Definido en
inference/src/tasks/cv/textToImage.ts:22
▸ textToImage(args, options?): Promise<Blob>
Parámetros
| Nombre | Tipo |
|---|---|
args | TextToImageArgs |
options? | TextToImageOptions & { outputType?: "blob" } |
Devuelve
Promise<Blob>
Definido en
inference/src/tasks/cv/textToImage.ts:26
▸ textToImage(args, options?): Promise<Record<string, unknown>>
Parámetros
| Nombre | Tipo |
|---|---|
args | TextToImageArgs |
options? | TextToImageOptions & { outputType?: "json" } |
Devuelve
Promise<Record<string, unknown>>
Definido en
inference/src/tasks/cv/textToImage.ts:30
textToSpeech
▸ textToSpeech(args, options?): Promise<Blob>
Esta tarea sintetiza un audio de una voz que pronuncia un texto dado. Modelo recomendado: espnet/kan-bayashi_ljspeech_vits
Parámetros
| Nombre | Tipo |
|---|---|
args | TextToSpeechArgs |
options? | Options |
Devuelve
Promise<Blob>
Definido en
inference/src/tasks/audio/textToSpeech.ts:15
textToVideo
▸ textToVideo(args, options?): Promise<TextToVideoOutput>
Parámetros
| Nombre | Tipo |
|---|---|
args | TextToVideoArgs |
options? | Options |
Devuelve
Promise<TextToVideoOutput>
Definido en
inference/src/tasks/cv/textToVideo.ts:15
tokenClassification
▸ tokenClassification(args, options?): Promise<TokenClassificationOutput>
Se utiliza habitualmente para el análisis de oraciones, ya sea gramatical o para el reconocimiento de entidades nombradas (NER), con el fin de comprender las palabras clave contenidas en el texto. Modelo recomendado: dbmdz/bert-large-cased-finetuned-conll03-english
Parámetros
| Nombre | Tipo |
|---|---|
args | TokenClassificationArgs |
options? | Options |
Devuelve
Promise<TokenClassificationOutput>
Definido en
inference/src/tasks/nlp/tokenClassification.ts:12
traducción
▸ traducción(args, options?): Promise<TranslationOutput>
Esta tarea es bien conocida para traducir texto de un idioma a otro. Modelo recomendado: Helsinki-NLP/opus-mt-ru-en.
Parámetros
| Nombre | Tipo |
|---|---|
args | TranslationArgs |
options? | Options |
Devuelve
Promise<TranslationOutput>
Definido en
inference/src/tasks/nlp/translation.ts:11
visualQuestionAnswering
▸ visualQuestionAnswering(args, options?): Promise<VisualQuestionAnsweringOutput[number]>
Responde a una pregunta sobre una imagen. Modelo recomendado: dandelin/vilt-b32-finetuned-vqa.
Parámetros
| Nombre | Tipo |
|---|---|
args | VisualQuestionAnsweringArgs |
options? | Options |
Devuelve
Promise<VisualQuestionAnsweringOutput[number]>
Definido en
inference/src/tasks/multimodal/visualQuestionAnswering.ts:19
zeroShotClassification
▸ zeroShotClassification(args, options?): Promise<ZeroShotClassificationOutput>
Esta tarea es muy útil para probar la clasificación sin escribir código: simplemente pasas una oración o párrafo y las posibles etiquetas para esa oración, y obtienes un resultado. Modelo recomendado: facebook/bart-large-mnli.
Parámetros
| Nombre | Tipo |
|---|---|
args | ZeroShotClassificationArgs |
options? | Options |
Devuelve
Promise<ZeroShotClassificationOutput>
Definido en
inference/src/tasks/nlp/zeroShotClassification.ts:12
zeroShotImageClassification
▸ zeroShotImageClassification(args, options?): Promise<ZeroShotImageClassificationOutput>
Clasifica una imagen en clases especificadas. Modelo recomendado: openai/clip-vit-large-patch14-336
Parámetros
| Nombre | Tipo |
|---|---|
args | ZeroShotImageClassificationArgs |
options? | Options |
Devuelve
Promise<ZeroShotImageClassificationOutput>
Definido en
inference/src/tasks/cv/zeroShotImageClassification.ts:44
Update on GitHub