用途:当任务需要借助 Hugging Face API 数据时,构建可复用的命令行脚本与工具,便于链式调用、管道和中间处理。可直接访问 API,也可使用 hf 命令行工具;模型与数据集卡片可从仓库直接获取。
主要能力:脚本须支持 --help 说明输入输出;非破坏性脚本交付前应测试;优先 Shell,复杂或用户需要时用 Python 或 TSX。使用 HF_TOKEN 环境变量作为 Authorization 头,例如 curl -H "Authorization: Bearer ${HF_TOKEN}" https://huggingface.co/api/,以获得更高速率限制与授权。设计前先调查 API 返回结构,善用管道与链式组合,优先简单方案,完成后提供用法示例,有疑问先确认用户偏好。
参考示例:references/hf_model_papers_auth.sh 自动使用 HF_TOKEN 并链式处理 trending→模型元数据→模型卡片解析;references/find_models_by_paper.sh 支持可选 --token 与重试;references/hf_model_card_frontmatter.sh 用 hf CLI 下载卡片并输出 NDJSON;另有 baseline_hf_api.sh/.py/.tsx 及 hf_enrich_models.sh 等可组合工具。
主要端点:/api/datasets、/api/models、/api/spaces、/api/collections、/api/daily_papers、/api/notifications、/api/settings、/api/whoami-v2、/api/trending、/oauth/userinfo。API 以 OpenAPI 标准记录于 https://huggingface.co/.well-known/openapi.json,但不要直接读取该文件(过大),应使用 jq 查询,例如 curl -s "https://huggingface.co/.well-known/openapi.json" | jq '.paths | keys | sort'。
hf CLI 提供 auth、cache、download、endpoints、env、jobs、repo、repo-files、upload、upload-large-folder、version 等命令,已取代废弃的 huggingface_hub CLI。
限制:资料未提供具体收费、价格、平台支持范围或效果数据;需注意令牌权限与速率限制,避免直接读取过大的 OpenAPI 文件。