api-inference 文档

特征提取

Hugging Face's logo
加入 Hugging Face 社区

并获得增强型文档体验

开始使用

特征提取

特征提取是将文本转换为向量(通常称为“嵌入”)的任务。

示例应用

  • 检索与查询最相关的文档(用于 RAG 应用)。
  • 根据文档与查询的相似度重新排序文档列表。
  • 计算两个句子之间的相似度。

有关 feature-extraction 任务的更多详细信息,请查看其 专用页面!您将找到示例和相关材料。

推荐模型

探索所有可用的模型并找到最适合您的模型 此处

使用 API

Python
JavaScript
cURL
import requests

API_URL = "https://api-inference.huggingface.co/models/thenlper/gte-large"
headers = {"Authorization": "Bearer hf_***"}

def query(payload):
	response = requests.post(API_URL, headers=headers, json=payload)
	return response.json()
	
output = query({
	"inputs": "Today is a sunny day and I will get some ice cream.",
})

要使用 Python 客户端,请参阅 huggingface_hub软件包参考

API 规范

请求

有效负载
输入* 字符串 要嵌入的文本。
规范化 布尔值
提示名称 字符串 用于编码的提示名称。如果未设置,则不会应用任何提示。必须是 Sentence Transformers 配置 prompts 字典中的一个键。例如,如果 prompt_name 为“query”并且 prompts 为 {“query”: “query: ”, …},则句子“法国的首都是什么?”将被编码为“query: 法国的首都是什么?”,因为提示文本将在任何要编码的文本之前添加。
截断 布尔值
截断方向 枚举 可能的值:左、右。

可以通过将标头传递到推理 API 来配置某些选项。以下是可用的标头

标头
授权 字符串 hf_**** 是具有推理 API 权限的个人用户访问令牌时,采用 'Bearer: hf_****' 形式的身份验证标头。您可以在 您的设置页面 生成一个。
x-use-cache 布尔值,默认为 true 推理 API 上有一个缓存层来加快我们已经看到的请求的速度。大多数模型可以使用这些结果,因为它们是确定性的(这意味着输出无论如何都会相同)。但是,如果您使用非确定性模型,则可以将此参数设置为阻止使用缓存机制,从而导致一个真正的全新查询。阅读更多关于缓存的信息 此处
x-wait-for-model 布尔值,默认为 false

如果模型未就绪,请等待模型就绪,而不是接收 503 错误。这可以减少获取推理结果所需的请求次数。建议仅在收到 503 错误后才将此标志设置为 true,因为它会将应用程序挂起限制在已知位置。有关模型可用性的更多信息,请点击此处

有关推理 API 标头的更多信息,请查看参数指南

响应

主体
(数组) 数组[] 输出是一个数组的数组。
< > 在 GitHub 上更新