类：HfInferenceEndpoint
层级结构
TaskWithNoAccessTokenNoEndpointUrl↳
HfInferenceEndpoint
构造函数
构造函数
• new HfInferenceEndpoint(endpointUrl, accessToken?, defaultOptions?): HfInferenceEndpoint
参数
| 名称 | 类型 | 默认值 |
|---|---|---|
endpointUrl | string | undefined |
accessToken | string | "" |
defaultOptions | Options | {} |
返回值
定义于
inference/src/HfInference.ts:51
属性
audioClassification
• audioClassification: (args: { data: Blob | ArrayBuffer ; model?: string }, options?: Options) => Promise\<AudioClassificationReturn>
类型声明
▸ (args, options?): Promise\<AudioClassificationReturn>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.data | Blob | ArrayBuffer | 二进制音频数据 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<AudioClassificationReturn>
定义于
inference/src/tasks/audio/audioClassification.ts:30
audioToAudio
• audioToAudio: (args: { data: Blob | ArrayBuffer ; model?: string }, options?: Options) => Promise\<AudioToAudioReturn>
类型声明
▸ (args, options?): Promise\<AudioToAudioReturn>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.data | Blob | ArrayBuffer | 二进制音频数据 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<AudioToAudioReturn>
定义于
inference/src/tasks/audio/audioToAudio.ts:35
automaticSpeechRecognition
• automaticSpeechRecognition: (args: { data: Blob | ArrayBuffer ; model?: string }, options?: Options) => Promise\<AutomaticSpeechRecognitionOutput>
类型声明
▸ (args, options?): Promise\<AutomaticSpeechRecognitionOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.data | Blob | ArrayBuffer | 二进制音频数据 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<AutomaticSpeechRecognitionOutput>
定义于
inference/src/tasks/audio/automaticSpeechRecognition.ts:23
chatCompletion
• chatCompletion: (args: {}, options?: Options) => Promise\<ChatCompletionOutput>
类型声明
▸ (args, options?): Promise\<ChatCompletionOutput>
参数
| 名称 | 类型 |
|---|---|
args | 对象 |
options? | Options |
返回值
Promise\<ChatCompletionOutput>
定义于
inference/src/tasks/nlp/chatCompletion.ts:10
chatCompletionStream
• chatCompletionStream: (args: {}, options?: Options) => AsyncGenerator\<ChatCompletionStreamOutput, any, unknown>
类型声明
▸ (args, options?): AsyncGenerator\<ChatCompletionStreamOutput, any, unknown>
参数
| 名称 | 类型 |
|---|---|
args | 对象 |
options? | Options |
返回值
AsyncGenerator\<ChatCompletionStreamOutput, any, unknown>
定义于
inference/src/tasks/nlp/chatCompletionStream.ts:8
documentQuestionAnswering
• documentQuestionAnswering: (args: { inputs: { image: Blob | ArrayBuffer ; question: string } ; model?: string }, options?: Options) => Promise\<DocumentQuestionAnsweringOutput>
类型声明
▸ (args, options?): Promise\<DocumentQuestionAnsweringOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | 对象 | - |
args.inputs.image | Blob | ArrayBuffer | 原始图像。您可以在浏览器中使用原生 `File`，在 Node.js 中使用 `new Blob([buffer])`，对于 Base64 图像，使用 `new Blob([btoa(base64String)])`，甚至可以使用 `await (await fetch('...)).blob()`。 |
args.inputs.question | string | - |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<DocumentQuestionAnsweringOutput>
定义于
inference/src/tasks/multimodal/documentQuestionAnswering.ts:42
featureExtraction
• featureExtraction: (args: { inputs: string | string[] ; model?: string }, options?: Options) => Promise\<FeatureExtractionOutput>
类型声明
▸ (args, options?): Promise\<FeatureExtractionOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | string | string[] | 输入是一个字符串或字符串列表，用于从中获取特征。输入：“那是一个快乐的人”， |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<FeatureExtractionOutput>
定义于
inference/src/tasks/nlp/featureExtraction.ts:24
fillMask
• fillMask: (args: { inputs: string ; model?: string }, options?: Options) => Promise\<FillMaskOutput>
类型声明
▸ (args, options?): Promise\<FillMaskOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | string | - |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<FillMaskOutput>
定义于
inference/src/tasks/nlp/fillMask.ts:31
图像分类
• 图像分类: (args: { data: Blob | ArrayBuffer ; model?: string }, options?: Options) => Promise\<ImageClassificationOutput>
类型声明
▸ (args, options?): Promise\<ImageClassificationOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.data | Blob | ArrayBuffer | 二进制图像数据 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<ImageClassificationOutput>
定义于
inference/src/tasks/cv/imageClassification.ts:29
imageSegmentation
• imageSegmentation: (args: { data: Blob | ArrayBuffer ; model?: string }, options?: Options) => Promise\<ImageSegmentationOutput>
类型声明
▸ (args, options?): Promise\<ImageSegmentationOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.data | Blob | ArrayBuffer | 二进制图像数据 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<ImageSegmentationOutput>
定义于
inference/src/tasks/cv/imageSegmentation.ts:33
imageToImage
• imageToImage: (args: { inputs: Blob | ArrayBuffer ; model?: string ; parameters?: { guess_mode?: boolean ; guidance_scale?: number ; height?: number ; negative_prompt?: string ; num_inference_steps?: number ; prompt?: string ; strength?: number ; width?: number } }, options?: Options) => Promise\<Blob>
类型声明
▸ (args, options?): Promise\<Blob>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | Blob | ArrayBuffer | 初始图像条件 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
args.parameters？ | 对象 | - |
args.parameters.guess_mode？ | 布尔值 | guess_mode 仅适用于 ControlNet 模型，默认为 False。在此模式下，即使您删除所有提示，ControlNet 编码器也会尽力识别输入图像的内容。建议使用 3.0 到 5.0 之间的 guidance_scale。 |
args.parameters.guidance_scale？ | 数字 | 引导比例：更高的引导比例鼓励生成与文本 prompt 密切相关的图像，但这通常会降低图像质量。 |
args.parameters.height？ | 数字 | 生成图像的高度（以像素为单位） |
args.parameters.negative_prompt？ | string | 用于图像生成的可选负面提示 |
args.parameters.num_inference_steps？ | 数字 | 去噪步骤的数量。更多的去噪步骤通常会导致更高的图像质量，但会降低推理速度。 |
args.parameters.prompt？ | string | 用于指导图像生成的文本提示。 |
args.parameters.strength？ | 数字 | strengh 参数仅适用于 SD img2img 和 alt diffusion img2img 模型。从概念上讲，它表示要对参考 image 进行多少转换。必须介于 0 到 1 之间。image 将用作起点，strength 越大，添加到其中的噪声就越多。去噪步骤的数量取决于最初添加的噪声量。当 strength 为 1 时，添加的噪声将达到最大值，并且去噪过程将在 num_inference_steps 中指定的完整迭代次数内运行。因此，值为 1 本质上会忽略 image。 |
args.parameters.width？ | 数字 | 生成图像的宽度（以像素为单位） |
options? | Options | - |
返回值
Promise\<Blob>
定义于
inference/src/tasks/cv/imageToImage.ts:61
imageToText
• imageToText: (args: { data: Blob | ArrayBuffer ; model?: string }, options?: Options) => Promise\<ImageToTextOutput>
类型声明
▸ (args, options?): Promise\<ImageToTextOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.data | Blob | ArrayBuffer | 二进制图像数据 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<ImageToTextOutput>
定义于
inference/src/tasks/cv/imageToText.ts:22
objectDetection
• objectDetection: (args: { data: Blob | ArrayBuffer ; model?: string }, options?: Options) => Promise\<ObjectDetectionOutput>
类型声明
▸ (args, options?): Promise\<ObjectDetectionOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.data | Blob | ArrayBuffer | 二进制图像数据 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<ObjectDetectionOutput>
定义于
inference/src/tasks/cv/objectDetection.ts:39
questionAnswering
• questionAnswering: (args: { inputs: { context: string ; question: string } ; model?: string }, options?: Options) => Promise\<QuestionAnsweringOutput>
类型声明
▸ (args, options?): Promise\<QuestionAnsweringOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | 对象 | - |
args.inputs.context | string | - |
args.inputs.question | string | - |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<QuestionAnsweringOutput>
定义于
inference/src/tasks/nlp/questionAnswering.ts:34
请求
• request: (args: { data: Blob | ArrayBuffer ; model?: string ; parameters?: Record\<string, unknown> } | { inputs: unknown ; model?: string ; parameters?: Record\<string, unknown> } | {}, options?: Options & { chatCompletion?: boolean ; task?: string ; taskHint?: InferenceTask }) => Promise\<unknown>
类型声明
▸ (args, options?): Promise\<unknown>
参数
| 名称 | 类型 |
|---|---|
args | { data: Blob | ArrayBuffer ; model?: string ; parameters?: Record\<string, unknown> } | { inputs: unknown ; model?: string ; parameters?: Record\<string, unknown> } | {} |
options? | Options & { chatCompletion?: boolean ; task?: string ; taskHint?: InferenceTask } |
返回值
Promise\<unknown>
定义于
inference/src/tasks/custom/request.ts:7
sentenceSimilarity
• sentenceSimilarity: (args: { inputs: Record\<string, unknown> | Record\<string, unknown>[] ; model?: string }, options?: Options) => Promise\<SentenceSimilarityOutput>
类型声明
▸ (args, options?): Promise\<SentenceSimilarityOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | Record\<string, unknown> | Record\<string, unknown>[] | 输入根据模型的不同而不同。例如，当使用 sentence-transformers/paraphrase-xlm-r-multilingual-v1 时，输入将有一个 source_sentence 字符串和一个 sentences 字符串数组 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<SentenceSimilarityOutput>
定义于
inference/src/tasks/nlp/sentenceSimilarity.ts:24
streamingRequest
• streamingRequest: (args: { data: Blob | ArrayBuffer ; model?: string ; parameters?: Record\<string, unknown> } | { inputs: unknown ; model?: string ; parameters?: Record\<string, unknown> } | {}, options?: Options & { chatCompletion?: boolean ; task?: string ; taskHint?: InferenceTask }) => AsyncGenerator\<unknown, any, unknown>
类型声明
▸ (args, options?): AsyncGenerator\<unknown, any, unknown>
参数
| 名称 | 类型 |
|---|---|
args | { data: Blob | ArrayBuffer ; model?: string ; parameters?: Record\<string, unknown> } | { inputs: unknown ; model?: string ; parameters?: Record\<string, unknown> } | {} |
options? | Options & { chatCompletion?: boolean ; task?: string ; taskHint?: InferenceTask } |
返回值
AsyncGenerator\<unknown, any, unknown>
定义于
inference/src/tasks/custom/streamingRequest.ts:9
summarization
• summarization: (args: { inputs: string ; model?: string ; parameters?: { max_length?: number ; max_time?: number ; min_length?: number ; repetition_penalty?: number ; temperature?: number ; top_k?: number ; top_p?: number } }, options?: Options) => Promise\<SummarizationOutput>
类型声明
▸ (args, options?): Promise\<SummarizationOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | string | 要汇总的字符串 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
args.parameters？ | 对象 | - |
args.parameters.max_length? | 数字 | （默认值：无）。 整数，用于定义输出摘要的最大令牌长度。 |
args.parameters.max_time? | 数字 | （默认值：无）。 浮点数 (0-120.0)。 查询最多应花费的时间（以秒为单位）。 网络可能会导致一些开销，因此这将是一个软限制。 |
args.parameters.min_length? | 数字 | （默认值：无）。 整数，用于定义输出摘要的最小令牌长度。 |
args.parameters.repetition_penalty? | 数字 | （默认值：无）。 浮点数 (0.0-100.0)。 令牌在生成中使用的次数越多，它在后续生成过程中被选中的可能性就越小。 |
args.parameters.temperature? | 数字 | （默认值：1.0）。 浮点数 (0.0-100.0)。 采样操作的温度。 1 表示常规采样，0 表示始终采用最高分数，100.0 表示接近均匀概率。 |
args.parameters.top_k? | 数字 | （默认值：无）。 整数，用于定义在样本操作中考虑用于创建新文本的顶部令牌。 |
args.parameters.top_p? | 数字 | （默认值：无）。 浮点数，用于定义文本生成样本操作中的令牌。 在样本中添加令牌，从概率最高的令牌到概率最低的令牌，直到概率总和大于 top_p。 |
options? | Options | - |
返回值
Promise\<SummarizationOutput>
定义于
inference/src/tasks/nlp/summarization.ts:52
tableQuestionAnswering
• **tableQuestionAnswering**: (args: { inputs: { query: string ; table: Record\<string, string[]> } ; model?: string }, options?: Options) => Promise\<TableQuestionAnsweringOutput>
类型声明
▸ (args, options?): Promise\<TableQuestionAnsweringOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | 对象 | - |
args.inputs.query | string | 您想查询表格的纯文本格式的查询 |
args.inputs.table | Record\<string, string[]> | 一个以字典列表形式表示的数据表，其中条目是标题，列表是所有值，所有列表必须大小相同。 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<TableQuestionAnsweringOutput>
定义于
inference/src/tasks/nlp/tableQuestionAnswering.ts:40
tabularClassification
• **tabularClassification**: (args: { inputs: { data: Record\<string, string[]> } ; model?: string }, options?: Options) => Promise\<TabularClassificationOutput>
类型声明
▸ (args, options?): Promise\<TabularClassificationOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | 对象 | - |
args.inputs.data | Record\<string, string[]> | 一个以字典列表形式表示的数据表，其中条目是标题，列表是所有值，所有列表必须大小相同。 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<TabularClassificationOutput>
定义于
inference/src/tasks/tabular/tabularClassification.ts:24
tabularRegression
• tabularRegression: (args: { inputs: { data: Record\<string, string[]> } ; model?: string }, options?: Options) => Promise\<TabularRegressionOutput>
类型声明
▸ (args, options?): Promise\<TabularRegressionOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | 对象 | - |
args.inputs.data | Record\<string, string[]> | 一个以字典列表形式表示的数据表，其中条目是标题，列表是所有值，所有列表必须大小相同。 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<TabularRegressionOutput>
定义于
inference/src/tasks/tabular/tabularRegression.ts:24
textClassification
• textClassification: (args: { inputs: string ; model?: string }, options?: Options) => Promise\<TextClassificationOutput>
类型声明
▸ (args, options?): Promise\<TextClassificationOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | string | 要分类的字符串 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<TextClassificationOutput>
定义于
inference/src/tasks/nlp/textClassification.ts:26
textGeneration
• textGeneration: (args: {}, options?: Options) => Promise\<TextGenerationOutput>
类型声明
▸ (args, options?): Promise\<TextGenerationOutput>
参数
| 名称 | 类型 |
|---|---|
args | 对象 |
options? | Options |
返回值
Promise\<TextGenerationOutput>
定义于
inference/src/tasks/nlp/textGeneration.ts:12
textGenerationStream
• textGenerationStream: (args: {}, options?: Options) => AsyncGenerator\<TextGenerationStreamOutput, any, unknown>
类型声明
▸ (args, options?): AsyncGenerator\<TextGenerationStreamOutput, any, unknown>
参数
| 名称 | 类型 |
|---|---|
args | 对象 |
options? | Options |
返回
AsyncGenerator\<TextGenerationStreamOutput, any, unknown>
定义于
inference/src/tasks/nlp/textGenerationStream.ts:88
textToImage
• textToImage: (args: { inputs: string ; model?: string ; parameters?: { guidance_scale?: number ; height?: number ; negative_prompt?: string ; num_inference_steps?: number ; width?: number } }, options?: Options) => Promise\<Blob>
类型声明
▸ (args, options?): Promise\<Blob>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | string | 要从中生成图像的文本 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
args.parameters？ | 对象 | - |
args.parameters.guidance_scale？ | 数字 | 引导比例：更高的引导比例鼓励生成与文本 prompt 密切相关的图像，但这通常会降低图像质量。 |
args.parameters.height？ | 数字 | 生成图像的高度（以像素为单位） |
args.parameters.negative_prompt？ | string | 用于图像生成的可选负面提示 |
args.parameters.num_inference_steps？ | 数字 | 去噪步骤的数量。更多的去噪步骤通常会导致更高的图像质量，但会降低推理速度。 |
args.parameters.width？ | 数字 | 生成图像的宽度（以像素为单位） |
options? | Options | - |
返回值
Promise\<Blob>
定义于
inference/src/tasks/cv/textToImage.ts:41
文本转语音
• textToSpeech: (args: { inputs: string ; model?: string }, options?: Options) => Promise\<Blob>
类型声明
▸ (args, options?): Promise\<Blob>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | string | 要从中生成音频的文本 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<Blob>
定义于
inference/src/tasks/audio/textToSpeech.ts:18
词分类
• tokenClassification: (args: { inputs: string ; model?: string ; parameters?: { aggregation_strategy?: "none" | "simple" | "first" | "average" | "max" } }, options?: Options) => Promise\<TokenClassificationOutput>
类型声明
▸ (args, options?): Promise\<TokenClassificationOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | string | 要分类的字符串 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
args.parameters？ | 对象 | - |
args.parameters.aggregation_strategy? | "none" | "simple" | "first" | "average" | "max" | （默认值：simple）。有几种聚合策略：none：每个标记在不进行进一步聚合的情况下进行分类。simple：实体根据默认模式分组（当标记相同时，B-、I- 标记将合并）。first：与简单策略相同，但单词不能以不同的标记结尾。当存在歧义时，单词将使用第一个标记的标记。average：与简单策略相同，但单词不能以不同的标记结尾。分数在标记之间取平均值，然后应用最大标签。max：与简单策略相同，但单词不能以不同的标记结尾。单词实体将是得分最高的标记。 |
options? | Options | - |
返回值
Promise\<TokenClassificationOutput>
定义于
inference/src/tasks/nlp/tokenClassification.ts:57
翻译
• translation: (args: { inputs: string | string[] ; model?: string }, options?: Options) => Promise\<TranslationOutput>
类型声明
▸ (args, options?): Promise\<TranslationOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | string | string[] | 要翻译的字符串 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<TranslationOutput>
定义于
inference/src/tasks/nlp/translation.ts:24
visualQuestionAnswering
• visualQuestionAnswering: (args: { inputs: { image: Blob | ArrayBuffer ; question: string } ; model?: string }, options?: Options) => Promise\<VisualQuestionAnsweringOutput>
类型声明
▸ (args, options?): Promise\<VisualQuestionAnsweringOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | 对象 | - |
args.inputs.image | Blob | ArrayBuffer | 原始图像。您可以在浏览器中使用原生 `File`，在 Node.js 中使用 `new Blob([buffer])`，对于 Base64 图像，使用 `new Blob([btoa(base64String)])`，甚至可以使用 `await (await fetch('...)).blob()`。 |
args.inputs.question | string | - |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
options? | Options | - |
返回值
Promise\<VisualQuestionAnsweringOutput>
定义于
inference/src/tasks/multimodal/visualQuestionAnswering.ts:32
zeroShotClassification
• zeroShotClassification: (args: { inputs: string | string[] ; model?: string ; parameters: { candidate_labels: string[] ; multi_label?: boolean } }, options?: Options) => Promise\<ZeroShotClassificationOutput>
类型声明
▸ (args, options?): Promise\<ZeroShotClassificationOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | string | string[] | 字符串或字符串列表 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
args.parameters | 对象 | - |
args.parameters.candidate_labels | string[] | 输入的潜在类别列表。（最多 10 个 candidate_labels，如果需要更多，只需运行多个请求，如果使用太多 candidate_labels，结果无论如何都会产生误导。如果您想保持完全相同，只需运行 multi_label=True 并在您的终端进行缩放。 |
args.parameters.multi_label？ | 布尔值 | （默认值：false）如果类别可以重叠，则设置为 True 的布尔值 |
options? | Options | - |
返回值
Promise\<ZeroShotClassificationOutput>
定义于
inference/src/tasks/nlp/zeroShotClassification.ts:34
zeroShotImageClassification
• zeroShotImageClassification: (args: { inputs: { image: Blob | ArrayBuffer } ; model?: string ; parameters: { candidate_labels: string[] } }, options?: Options) => Promise\<ZeroShotImageClassificationOutput>
类型声明
▸ (args, options?): Promise\<ZeroShotImageClassificationOutput>
参数
| 名称 | 类型 | 描述 |
|---|---|---|
args | 对象 | - |
args.inputs | 对象 | - |
args.inputs.image | Blob | ArrayBuffer | 二进制图像数据 |
args.model? | string | 要使用的模型。如果未指定，将调用 huggingface.co/api/tasks 获取任务的默认模型。/!\ 旧版行为允许这是一个 URL，但此方法已被弃用，并将在未来版本中删除。请改用 endpointUrl 参数。 |
args.parameters | 对象 | - |
args.parameters.candidate_labels | string[] | 输入的潜在类别列表。（最多 10 个） |
options? | Options | - |
返回值
Promise\<ZeroShotImageClassificationOutput>
定义于
inference/src/tasks/cv/zeroShotImageClassification.ts:33
< > 在 GitHub 上更新