Huggingface.js documentation
클래스: HfInference
클래스: HfInference
하위 호환성을 위해만 유지되며, 곧 제거될 예정입니다.
Deprecated
InferenceClient로 교체
계층 구조
-
↳
HfInference
생성자
constructor
• new HfInference(accessToken?, defaultOptions?): HfInference
매개변수
| 이름 | 유형 | 기본값 |
|---|---|---|
accessToken | string | "" |
defaultOptions | Options & { endpointUrl?: string } | {} |
반환
다음에서 상속
정의 위치
inference/src/InferenceClient.ts:15
메서드
audioClassification
▸ audioClassification(args, options?): Promise<AudioClassificationOutput>
이 작업은 오디오 입력을 읽고 클래스의 확률을 출력합니다. 권장 모델: superb/hubert-large-superb-er
매개변수
| 이름 | 유형 |
|---|---|
args | AudioClassificationArgs |
options? | Options |
반환
Promise<AudioClassificationOutput>
다음에서 상속
InferenceClient.audioClassification
정의 위치
inference/src/tasks/audio/audioClassification.ts:15
audioToAudio
▸ audioToAudio(args, options?): Promise<AudioToAudioOutput[]>
이 작업은 오디오 입력을 읽고 하나 이상의 오디오 파일을 출력합니다. 예시 모델: speechbrain/sepformer-wham은 오디오 소스 분리(audio source separation)를 수행합니다.
매개변수
| 이름 | 유형 |
|---|---|
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>
다음에서 상속
InferenceClient.automaticSpeechRecognition
정의 위치
inference/src/tasks/audio/automaticSpeechRecognition.ts:13
chatCompletion
▸ chatCompletion(args, options?): Promise<ChatCompletionOutput>
OpenAI 메시지 완성 API를 스트리밍 없이 사용하여 채팅 완성 엔드포인트로 프롬프트에 대한 응답을 생성합니다
매개변수
| 이름 | 유형 |
|---|---|
args | BaseArgs & ChatCompletionInput |
options? | Options |
반환
Promise<ChatCompletionOutput>
다음에서 상속
InferenceClient.chatCompletion
정의 위치
inference/src/tasks/nlp/chatCompletion.ts:12
chatCompletionStream
▸ chatCompletionStream(args, options?): AsyncGenerator<ChatCompletionStreamOutput>
프롬프트에서 텍스트를 계속 생성하는 데 사용합니다. textGeneration과 동일하지만, 토큰 단위로 읽을 수 있는 생성기를 반환합니다.
매개변수
| 이름 | 유형 |
|---|---|
args | BaseArgs & ChatCompletionInput |
options? | Options |
반환
AsyncGenerator<ChatCompletionStreamOutput>
다음에서 상속
InferenceClient.chatCompletionStream
정의 위치
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]>
다음에서 상속
InferenceClient.documentQuestionAnswering
정의 위치
inference/src/tasks/multimodal/documentQuestionAnswering.ts:19
엔드포인트
▸ 엔드포인트(endpointUrl): InferenceClient
지정된 엔드포인트에 연결된 InferenceClient의 새 인스턴스를 반환합니다.
주로 후방 호환성을 위해.
매개변수
| 이름 | 유형 |
|---|---|
endpointUrl | string |
반환
다음에서 상속
정의 위치
inference/src/InferenceClient.ts:46
featureExtraction
▸ featureExtraction(args, options?): Promise<FeatureExtractionOutput>
이 작업은 텍스트를 읽고, 일반적으로 의미론적 데이터베이스/의미론적 검색의 일부로 소비되는 원시 float 값을 출력합니다.
매개변수
| 이름 | 유형 |
|---|---|
args | FeatureExtractionArgs |
options? | Options |
반환
Promise<FeatureExtractionOutput>
다음에서 상속
InferenceClient.featureExtraction
정의 위치
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>
다음에서 상속
InferenceClient.imageClassification
정의 위치
inference/src/tasks/cv/imageClassification.ts:14
이미지 분할
▸ imageSegmentation(args, options?): Promise<ImageSegmentationOutput>
이 작업은 이미지 입력을 읽고, 클래스의 확률 및 감지된 객체의 바운딩 박스를 출력합니다. 권장 모델: facebook/detr-resnet-50-panoptic
매개변수
| 이름 | 유형 |
|---|---|
args | ImageSegmentationArgs |
options? | Options |
반환
Promise<ImageSegmentationOutput>
다음에서 상속
InferenceClient.imageSegmentation
정의 위치
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>
다음에서 상속
InferenceClient.imageTextToImage
정의 위치
inference/src/tasks/cv/imageTextToImage.ts:13
imageTextToVideo
▸ imageTextToVideo(args, options?): Promise<Blob>
이 작업은 이미지와 텍스트를 입력으로 받아 생성된 비디오를 출력합니다. 권장 모델: Lightricks/LTX-Video
매개변수
| 이름 | 유형 |
|---|---|
args | ImageTextToVideoArgs |
options? | Options |
반환
Promise<Blob>
다음에서 상속
InferenceClient.imageTextToVideo
정의 위치
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>
다음에서 상속
InferenceClient.objectDetection
정의 위치
inference/src/tasks/cv/objectDetection.ts:14
질문 답변
▸ questionAnswering(args, options?): Promise<QuestionAnsweringOutput[number]>
모든 질문에 답할 수 있는 똑똑한 봇을 만들고 싶으신가요? 추천 모델: deepset/roberta-base-squad2
매개변수
| 이름 | 유형 |
|---|---|
args | QuestionAnsweringArgs |
options? | Options |
반환
Promise<QuestionAnsweringOutput[number]>
다음에서 상속
InferenceClient.questionAnswering
정의 위치
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>
다음에서 상속
InferenceClient.sentenceSimilarity
정의 위치
inference/src/tasks/nlp/sentenceSimilarity.ts:12
streamingRequest
▸ streamingRequest<T>(args, options?): AsyncGenerator<T>
서버 전송 이벤트(SSE)를 기대하는 사용자 정의 추론 호출을 수행하는 프리미티브이며, 응답을 제너레이터를 통해 반환합니다
형식 매개변수
| 이름 |
|---|
T |
매개변수
| 이름 | 유형 |
|---|---|
args | RequestArgs |
options? | Options & { task?: InferenceTask } |
반환
AsyncGenerator<T>
Deprecated
대신 특정 작업 함수를 사용하세요. 이 함수는 향후 버전에서 제거됩니다.
다음에서 상속
InferenceClient의 streamingRequest
정의 위치
inference/src/tasks/custom/streamingRequest.ts:11
요약
▸ 요약(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]>
다음에서 상속
InferenceClient.tableQuestionAnswering
정의 위치
inference/src/tasks/nlp/tableQuestionAnswering.ts:12
tabularClassification
▸ tabularClassification(args, options?): Promise<TabularClassificationOutput>
테이블 형식의 주어진 특징 집합에 대해 대상 라벨을 예측합니다. 일반적으로 학습 데이터로 분류 모델을 학습한 후, 동일한 형식의 새로운 데이터와 함께 사용하는 것이 좋습니다. 예시 모델: vvmnnnkv/wine-quality
매개변수
| 이름 | 유형 |
|---|---|
args | TabularClassificationArgs |
options? | Options |
반환
Promise<TabularClassificationOutput>
다음에서 상속
InferenceClient.tabularClassification
정의 위치
inference/src/tasks/tabular/tabularClassification.ts:25
tabularRegression
▸ tabularRegression(args, options?): Promise<TabularRegressionOutput>
테이블 형식의 주어진 특징 집합에 대해 목표 값을 예측합니다. 일반적으로 학습 데이터에 회귀 모델을 학습시킨 후, 동일한 형식의 새로운 데이터에 이를 적용하게 됩니다. 예시 모델: scikit-learn/Fish-Weight
매개변수
| 이름 | 유형 |
|---|---|
args | TabularRegressionArgs |
options? | Options |
반환
Promise<TabularRegressionOutput>
다음에서 상속
InferenceClient.tabularRegression
정의 위치
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>
다음에서 상속
InferenceClient.textClassification
정의 위치
inference/src/tasks/nlp/textClassification.ts:12
textGeneration
▸ textGeneration(args, options?): Promise<TextGenerationOutput>
프롬프트에서 텍스트를 계속 생성하는 데 사용합니다. 이는 매우 일반적인 작업입니다. 권장 모델: gpt2 (단순한 모델이지만 다루기 재미있습니다).
매개변수
| 이름 | 유형 |
|---|---|
args | BaseArgs & TextGenerationInput |
options? | Options |
반환
Promise<TextGenerationOutput>
다음에서 상속
InferenceClient.textGeneration
정의 위치
inference/src/tasks/nlp/textGeneration.ts:12
textGenerationStream
▸ textGenerationStream(args, options?): AsyncGenerator<TextGenerationStreamOutput>
프롬프트에서 텍스트를 계속 생성하는 데 사용합니다. textGeneration과 동일하지만, 토큰 단위로 읽을 수 있는 생성기를 반환합니다.
매개변수
| 이름 | 유형 |
|---|---|
args | BaseArgs & TextGenerationInput |
options? | Options |
반환
AsyncGenerator<TextGenerationStreamOutput>
다음에서 상속
InferenceClient.textGenerationStream
정의 위치
inference/src/tasks/nlp/textGenerationStream.ts:90
textRanking
▸ textRanking(args, options?): Promise<TextRankingOutput>
reranker 모델을 사용하여 쿼리에 대한 문서의 관련성 순서대로 정렬합니다.
매개변수
| 이름 | 유형 |
|---|---|
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>
다음에서 상속
InferenceClient.tokenClassification
정의 위치
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]>
다음에서 상속
InferenceClient.visualQuestionAnswering
정의 위치
inference/src/tasks/multimodal/visualQuestionAnswering.ts:19
zeroShotClassification
▸ zeroShotClassification(args, options?): Promise<ZeroShotClassificationOutput>
이 작업은 코드를 전혀 작성하지 않고 분류를 시도해 보기에 매우 유용합니다. 문장/단락을 전달하고 해당 문장에 대한 가능한 라벨을 지정하면 결과를 얻을 수 있습니다. 권장 모델: facebook/bart-large-mnli.
매개변수
| 이름 | 유형 |
|---|---|
args | ZeroShotClassificationArgs |
options? | Options |
반환
Promise<ZeroShotClassificationOutput>
다음에서 상속
InferenceClient.zeroShotClassification
정의 위치
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>
다음에서 상속
InferenceClient.zeroShotImageClassification
정의 위치
inference/src/tasks/cv/zeroShotImageClassification.ts:44
Update on GitHub