hugging-face-tool-builder

補足資料の利用可否

このカタログのコピーには、以下のインラインガイダンスが含まれていますが、次の補足パスは含まれていません。これらは外部の前提条件であり、同梱ファイルではありません。

• <support-root>/references/hf_model_papers_auth.sh
• <support-root>/references/find_models_by_paper.sh
• <support-root>/references/hf_model_card_frontmatter.sh
• <support-root>/references/baseline_hf_api.sh
• <support-root>/references/baseline_hf_api.py
• <support-root>/references/baseline_hf_api.tsx
• <support-root>/references/hf_enrich_models.sh

これらのパスに依存する手順を実行する前に、元の補足資料または既存のインストール環境を求めてください。このカタログには、確認済みのダウンロード元が記載されていません。各パスをそのインストール環境を基準に解決し、内容を確認したうえで、該当するライセンスと実行要件を確認してください。必要なファイルが存在するまでは、コマンドを実行したり、参照されている手順に従ったと主張したりしないでください。不足しているスクリプトを捏造したり、同じ名前の無関係なファイルを同等のものとして扱ったりしないでください。ここに完全な説明がある独立した手順は、ユーザーが許可した範囲内で実行できます。依存する手順は利用できないものとして報告してください。

Hugging Face API ツールビルダー

あなたの目的は、Hugging Face API を使用するための再利用可能なコマンドラインスクリプトとユーティリティを作成し、必要に応じてコマンドの連結、パイプ処理、中間処理を可能にすることです。API に直接アクセスできるほか、hf コマンドラインツールも使用できます。モデルカードとデータセットカードは、リポジトリから直接取得できます。

使用する場合

• Hugging Face API または hf コマンドラインツールを利用する再利用可能な CLI スクリプトが必要な場合。
• コマンドの連結、パイプ処理、中間処理に対応する、シェルで使いやすいユーティリティが必要な場合。
• 場当たり的な API 呼び出しではなく、組み合わせ可能なインターフェースを使って、Hub のタスクを繰り返し自動化する場合。

スクリプトのルール

以下のルールに従ってください。

• スクリプトには、入力と出力を説明する --help コマンドライン引数を用意してください。
• 非破壊的なスクリプトは、ユーザーに引き渡す前にテストしてください。
• シェルスクリプトを推奨しますが、複雑さやユーザーのニーズに応じて Python または TSX を使用してください。
• 重要：環境変数 HF_TOKEN を Authorization ヘッダーとして使用してください。たとえば、curl -H "Authorization: Bearer ${HF_TOKEN}" https://huggingface.co/api/ のようにします。これにより、より高いレート制限と、データにアクセスするための適切な認可が得られます。
• 最終的な設計を決める前に API の結果の形式を調査してください。組み合わせやすさが利点となる場合は、パイプ処理とコマンドの連結を活用し、可能な限りシンプルな解決策を優先してください。
• 完成したら使用例を提示してください。

質問や確認事項がある場合は、必ずユーザーの希望を確認してください。

サンプルスクリプト

以下のパスは、このスキルのディレクトリからの相対パスです。

参考例：

• references/hf_model_papers_auth.sh — HF_TOKEN を自動的に使用し、トレンド情報 → モデルのメタデータ → モデルカードの解析をフォールバック付きで連結します。複数段階にわたる API の使用方法と、アクセス制限付き／非公開コンテンツに対する認証情報の適切な扱いを示しています。
• references/find_models_by_paper.sh — --token による任意の HF_TOKEN の使用、一貫した認証済み検索、arXiv プレフィックス付き検索の範囲が狭すぎる場合の再試行パスを示しています。堅牢なクエリ戦略と、ユーザー向けのわかりやすいヘルプを紹介しています。
• references/hf_model_card_frontmatter.sh — hf CLI を使用してモデルカードをダウンロードし、YAML フロントマターを抽出して、簡単にフィルタリングできる NDJSON 形式の概要（ライセンス、パイプラインタグ、タグ、アクセス制限付きプロンプトのフラグ）を出力します。

基本的な例（非常にシンプルで、ロジックを最小限に抑え、HF_TOKEN ヘッダーを付けて生の JSON を出力）：

• references/baseline_hf_api.sh — bash
• references/baseline_hf_api.py — python
• references/baseline_hf_api.tsx — typescript 実行可能ファイル

組み合わせ可能なユーティリティ（標準入力 → NDJSON）：

• references/hf_enrich_models.sh — 標準入力からモデル ID を読み取り、ID ごとにメタデータを取得し、ストリーミングパイプライン向けに1行につき1つの JSON オブジェクトを出力します。

パイプによる組み合わせ（シェルで扱いやすい JSON 出力）：

• <support-root>/references/baseline_hf_api.sh 25 | jq -r '.[].id' | references/hf_enrich_models.sh | jq -s 'sort_by(.downloads) | reverse | .[:10]'
• <support-root>/references/baseline_hf_api.sh 50 | jq '[.[] | {id, downloads}] | sort_by(.downloads) | reverse | .[:10]'
• printf '%s\n' openai/gpt-oss-120b meta-llama/Meta-Llama-3.1-8B | references/hf_model_card_frontmatter.sh | jq -s 'map({id, license, has_extra_gated_prompt})'

主なエンドポイント

https://huggingface.co で利用できる主な API エンドポイントは次のとおりです。

/api/datasets
/api/models
/api/spaces
/api/collections
/api/daily_papers
/api/notifications
/api/settings
/api/whoami-v2
/api/trending
/oauth/userinfo

API へのアクセス

API は、https://huggingface.co/.well-known/openapi.json にある OpenAPI 標準に基づいて文書化されています。

重要： https://huggingface.co/.well-known/openapi.json は処理するには大きすぎるため、直接読み込もうとしないでください。

重要： 関連する部分を検索して抽出するには、jq を使用してください。たとえば、

160 件すべてのエンドポイントを取得するコマンド

curl -s "https://huggingface.co/.well-known/openapi.json" | jq '.paths | keys | sort'

モデル検索エンドポイントの詳細

curl -s "https://huggingface.co/.well-known/openapi.json" | jq '.paths["/api/models"]'

エンドポイントにクエリを送信して、データの構造を確認することもできます。その際は、処理しやすく、かつ代表的な結果が得られるよう、結果数を少なく制限してください。

HF コマンドラインツールの使用

hf コマンドラインツールを使うと、Hugging Face のリポジトリコンテンツやインフラにさらにアクセスできます。

❯ hf --help
Usage: hf [OPTIONS] COMMAND [ARGS]...

  Hugging Face Hub CLI

Options:
  --help                Show this message and exit.

Commands:
  auth                 Manage authentication (login, logout, etc.).
  cache                Manage local cache directory.
  download             Download files from the Hub.
  endpoints            Manage Hugging Face Inference Endpoints.
  env                  Print information about the environment.
  jobs                 Run and manage Jobs on the Hub.
  repo                 Manage repos on the Hub.
  repo-files           Manage files in a repo on the Hub.
  upload               Upload a file or a folder to the Hub.
  upload-large-folder  Upload a large folder to the Hub.
  version              Print information about the hf version.

hf CLI コマンドは、非推奨になった huggingface_hub CLI コマンドに代わるものです。

制限事項

• このスキルは、タスクが上記の範囲に明確に該当する場合にのみ使用してください。
• 出力を、環境固有の検証、テスト、または専門家によるレビューの代わりとして扱わないでください。
• 必要な入力、権限、安全上の境界、または成功基準が不足している場合は、作業を中止して確認を求めてください。