api-inference 文档

摘要

Hugging Face's logo
加入 Hugging Face 社区

并获得增强文档体验的访问权限

开始使用

摘要

摘要是指在保留文档重要信息的同时生成较短版本文档的任务。一些模型可以从原始输入中提取文本,而其他模型可以生成全新的文本。

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

推荐模型

  • facebook/bart-large-cnn:一个强大的摘要模型,在英文新闻文章上训练。擅长生成事实性摘要。

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

使用 API

Python
JavaScript
cURL
import requests

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

def query(payload):
	response = requests.post(API_URL, headers=headers, json=payload)
	return response.json()
	
output = query({
	"inputs": "The tower is 324 metres (1,063 ft) tall, about the same height as an 81-storey building, and the tallest structure in Paris. Its base is square, measuring 125 metres (410 ft) on each side. During its construction, the Eiffel Tower surpassed the Washington Monument to become the tallest man-made structure in the world, a title it held for 41 years until the Chrysler Building in New York City was finished in 1930. It was the first structure to reach a height of 300 metres. Due to the addition of a broadcasting aerial at the top of the tower in 1957, it is now taller than the Chrysler Building by 5.2 metres (17 ft). Excluding transmitters, the Eiffel Tower is the second tallest free-standing structure in France after the Millau Viaduct.",
})

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

API 规范

请求

有效负载
inputs* 字符串 要汇总的输入文本。
参数 对象 摘要的其他推理参数。
        clean_up_tokenization_spaces 布尔值 是否清理文本输出中潜在的多余空格。
        截断 枚举 可能的值:do_not_truncate、longest_first、only_first、only_second。
        生成参数 对象 文本生成算法的其他参数化。

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

标头
授权 字符串 hf_****是具有推理 API 权限的个人用户访问令牌时,采用'Bearer: hf_****'形式的身份验证标头。您可以从您的设置页面生成一个。
x-use-cache 布尔值,默认为true 推理 API 上有一个缓存层来加速我们已经看到的请求。大多数模型可以使用这些结果,因为它们是确定性的(这意味着输出无论如何都将相同)。但是,如果您使用非确定性模型,则可以将此参数设置为阻止使用缓存机制,从而导致一个真正的新的查询。阅读有关缓存的更多信息此处
x-wait-for-model 布尔值,默认为false 如果模型未就绪,请等待它,而不是接收 503。它限制了完成推理所需的请求数量。建议仅在收到 503 错误后才将此标志设置为 true,因为它会将应用程序中的挂起限制在已知位置。阅读有关模型可用性的更多信息此处

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

响应

主体
summary_text 字符串 摘要文本。
< > 更新 在 GitHub 上