| # e-Gov PDF → Page Images + Text: 生成仕様（Spec） | |
| 本ドキュメントは、e-Gov の PDF を取得し、ページ画像化およびページテキストを対応付けた Hugging Face Datasets 形式に変換するまでの生成手順・仕様をまとめたものです。データセット README は本仕様を参照します。 | |
| ## 出所（Source of Data） | |
| - ポータル: <https://data.e-gov.go.jp/> | |
| - API: CKAN | |
| - `resource_search`: `https://data.e-gov.go.jp/data/api/3/action/resource_search` | |
| - `package_search`: `https://data.e-gov.go.jp/data/api/3/action/package_search` | |
| - 取得スクリプト: `egov/dl.py` | |
| - PDF 資源を検索・判定して保存（`format:PDF OR format:pdf OR url:pdf` など）。 | |
| - 同名回避のため URL 由来の短ハッシュを付加。 | |
| ## 保存レイアウト（Storage Layout） | |
| - PDF: `data/JpOCR-XL/egov/<year>/*.pdf` | |
| - ページ画像: `data/JpOCR-XL/egov/images/<year>/<pdf_stem>/<pdf_stem>_p0001.png` | |
| - ローカル Datasets 保存: `data/JpOCR-XL/egov/dataset`（`--save-dir data/JpOCR-XL/egov` で生成） | |
| ## PDF→ 画像変換（Rendering） | |
| - ライブラリ: MuPDF（`pymupdf` / `fitz`） | |
| - DPI: 200（既定、`--dpi` で変更可） | |
| - カラー: RGB（`alpha=False`） | |
| - 出力ファイル名: ページは 1 始まり、ゼロパディング（例: `_p0001.png`） | |
| ## テキスト抽出（No OCR） | |
| - ライブラリ: `pdfplumber` | |
| - 方法: PDF の text layer を抽出（ToUnicode）。OCR は実施しない。 | |
| - 埋め込みテキストが無いページは空文字列。 | |
| ## HF Datasets スキーマ | |
| - `image`: `datasets.Image()`（PIL） | |
| - `text`: `string`（ページテキスト、空の場合あり） | |
| - `source`: `string`（元 PDF のパス） | |
| - `page`: `int32`（1 始まり） | |
| ## ライセンスと規約（License & Terms） | |
| - オリジナルのライセンス: CC-BY-4.0（要クレジット） | |
| - 利用規約: <https://data.e-gov.go.jp/info/terms> | |
| - 再配布: 出典（e-Gov Open Data）を明示し、CC-BY-4.0 を維持。 | |
| ## 再現手順（Repro） | |
| ### 1. 依存関係のインストール | |
| ```sh | |
| uv sync | |
| ``` | |
| ### 2. 少量試験（レンダリングと容量を抑制） | |
| ```sh | |
| uv run egov/build_hf_dataset.py --limit-files 3 --max-pages 2 -v \ | |
| --images-root data/JpOCR-XL/egov/images \ | |
| --save-dir data/JpOCR-XL/egov | |
| ``` | |
| ### 3. 全量ビルド＋ Hub へ公開（public） | |
| ```sh | |
| export HUGGINGFACE_HUB_TOKEN=... # または .env を読み込み | |
| uv run egov/build_hf_dataset.py -v \ | |
| --images-root data/JpOCR-XL/egov/images \ | |
| --save-dir data/JpOCR-XL/egov \ | |
| --push Silviase/jgov \ | |
| --spec egov/spec.md | |
| ``` | |
| すでに `data/JpOCR-XL/egov/dataset` が存在する場合は、再計算せずそのまま Hub に push されます（`--save-dir` からロード）。 | |
| 部分保存（`dataset_parts/`）を使って段階的に生成した場合は、最後に以下で単一データセットに統合できます。 | |
| ```sh | |
| uv run egov/build_hf_dataset.py \ | |
| --save-dir data/JpOCR-XL/egov \ | |
| --finalize -v | |
| ``` | |
| ## 補遺: e-Gov CKAN 検索メモ（resource_search と package_search） | |
| この補遺は e-Gov データポータル（CKAN API）で PDF 資源を探す手段として、`resource_search` と `package_search` の違い・使い分け・実行例を簡潔にまとめたものです。`egov/dl.py` が内部でどう使い分けているかも記載します。 | |
| ### 用語 | |
| - CKAN: オープンデータ基盤ソフトウェア。データセット（= package）の下にリソース（= resource, 実ファイルや API など）がぶら下がる構造。 | |
| - データセット（package）: タイトルや説明を持つ論理的なまとまり。 | |
| - リソース（resource）: 実体（ファイル URL, API エンドポイントなど）。`format`, `mimetype`, `url` などの属性を持つ。 | |
| ### エンドポイント概要 | |
| - `GET /api/3/action/resource_search` | |
| - 主にリソース（resource）を直接検索する API。 | |
| - パラメータ: `query`（検索クエリ）, `offset`（開始位置）, `limit`（件数）。 | |
| - レスポンス: `result.count`（総件数の目安）, `result.results`（resource の配列）。 | |
| - 備考: サイト設定やインデックス状況によっては、`format:url` のような条件が効きづらい・ヒットが 0 件になることがある。 | |
| - `GET /api/3/action/package_search` | |
| - データセット（package）単位で全文検索する API。Solr ベースの高度なフィルタが利用可能。 | |
| - パラメータ: `q`（キーワード）, `fq`（フィルタクエリ）, `start`（開始位置）, `rows`（件数）。 | |
| - レスポンス: `result.count`（総件数）, `result.results`（package の配列, 各 package に `resources` を含む）。 | |
| - よく使うフィールド（fq）: `res_format`, `res_mimetype`, `res_name`, `res_url` などリソース由来のインデックス。 | |
| ### どちらを使うべき？ | |
| - まず `resource_search` を試すのが素直。ただし e-Gov では PDF 検索が 0 件になりがち。 | |
| - その場合は `package_search` に切り替え、`fq` で `res_format:PDF` や `res_mimetype:application/pdf` を指定するとヒットしやすい。 | |
| - 当リポジトリの `egov/dl.py` は `--mode auto`（デフォルト）で、`resource_search` → 0 件なら `package_search` に自動フォールバックします。 | |
| ### クエリ例 | |
| - resource_search 例: | |
| - `query = "format:PDF OR format:pdf OR url:pdf"` | |
| - ページング: `offset=0`, `limit=200`（以降 offset+=limit） | |
| - package_search 例: | |
| - `q = "pdf"`（キーワードざっくり） | |
| - `fq = "res_format:PDF OR res_mimetype:application/pdf"`（PDF リソースに絞る） | |
| - ページング: `start=0`, `rows=1000`（以降 start+=rows） | |
| ### スクリプトでの使い方（egov/dl.py） | |
| - 基本（自動フォールバック） | |
| - `uv run egov/dl.py -n 100 -o ./data/JpOCR-XL/egov/ --mode auto` | |
| - 先に `resource_search` を試し、最初のページが空なら `package_search` に切り替え。 | |
| - 直接 package_search を使う（推奨フィルタ付き） | |
| - `uv run egov/dl.py --mode package -q pdf --fq 'res_format:PDF OR res_mimetype:application/pdf' -n 100 -o ./data/JpOCR-XL/egov/ --scan-limit 20000 --batch 1000` | |
| - ダウンロードせず件数だけ数える（dry-run） | |
| - URL のみを出力して行数をカウント： | |
| - `uv run egov/dl.py --mode package -q pdf --fq 'res_format:PDF OR res_mimetype:application/pdf' --scan-limit 20000 --batch 1000 --dry-run | rg '^https?://' | wc -l` | |
| - `resource_search` で数える場合： | |
| - `uv run egov/dl.py --mode resource --scan-limit 20000 --batch 1000 --dry-run | rg '^https?://' | wc -l` | |
| ### オプション設計（抜粋） | |
| - `--mode {auto, resource, package}`: 検索戦略の切り替え（既定: `auto`）。 | |
| - `--fq`: package_search 用のフィルタクエリ（Solr 形式）。例: `res_format:PDF OR res_mimetype:application/pdf`。 | |
| - `--scan-limit`: スキャン上限（総走査件数の上限）。結果が少なければ引き上げる（例: 20000 など）。 | |
| - `--batch`: 1 リクエスト当たりの件数。`resource_search`/`package_search` どちらも 1000 以下が無難。 | |
| - `--dry-run`: ダウンロードせず候補 URL を列挙。 | |
| ### 実装上の注意 | |
| - PDF 判定: | |
| - HTTP ヘッダ `Content-Type` に `pdf` を含む、または先頭バイトが `%PDF-` であることを確認。 | |
| - ファイル名決定: | |
| - `Content-Disposition` → URL パス → フォールバックの順で決定し、重複回避に URL の短ハッシュを付与。 | |
| ### よくあるハマりポイント | |
| - `resource_search` が 0 件になる: | |
| - e-Gov のインデックス事情で `format:PDF` 等が拾えない場合がある。`package_search` + `fq` を使う。 | |
| - `format` が信頼できない: | |
| - `format` が空や異なる値でも PDF のことがある。`res_mimetype:application/pdf` を併用すると改善。 | |
| - 取得 URL が PDF でない: | |
| - HTML を返す中間ページやエラーページも混ざる。スクリプト側の PDF 判定でスキップされます（`[skip] not a PDF ...`）。 | |
| ### 参考 | |
| - CKAN API: <https://docs.ckan.org/en/latest/api/> | |
| - package_search の `fq` フィールド例（実装ごとに差異あり）: | |
| - `res_format`, `res_mimetype`, `res_url`, `res_name`, `organization`, `groups` など。 | |
| This dataset contains page-level renders and extracted (non-OCR) text from PDFs | |
| published on the e-Gov Open Data portal. | |
| - Source: https://data.e-gov.go.jp/ | |
| - Terms of Use: https://data.e-gov.go.jp/info/terms | |
| - License: CC-BY-4.0 (Attribution required) | |
| Notes: | |
| - Text is extracted via PDF text layer; pages without embedded text may be empty. | |
| - Images are rendered at 200 DPI using MuPDF. |