Datasets:
|
Download code/scripts/README_ndl_api_candidates.md from kuramot6f/classical-ja-pretrain: direct link, hf CLI and curl.
- Browser
- Download file 3.52 kB
-
https://huggingface.co/datasets/kuramot6f/classical-ja-pretrain/resolve/main/code/scripts/README_ndl_api_candidates.md
- Command line
-
hf download hf://datasets/kuramot6f/classical-ja-pretrain/code/scripts/README_ndl_api_candidates.md
-
curl -L -o README_ndl_api_candidates.md https://huggingface.co/datasets/kuramot6f/classical-ja-pretrain/resolve/main/code/scripts/README_ndl_api_candidates.md
3.52 kB
| # API収録資料との照合 | |
| `ndl_api_candidates.py` は、既存の出版年等で絞ったPID一覧を検索APIへ100件ずつ渡し、収録が確認できたPIDだけを別ファイルに保存します。既存のダウンローダー・PID一覧・対象外キャッシュは変更しません。全収録資料の列挙は行わず、候補一覧との積集合を取ります。 | |
| 40,160件なら通常402リクエストです。ZIPを1件ずつ要求する前に、検索で候補を減らせます。出版年は入力一覧の抽出条件を引き継ぎます。APIの `publishyear` で年不明や複数年を再解釈しません。 | |
| まず少数で試す場合: | |
| ```bash | |
| python3 scripts/ndl_api_candidates.py \ | |
| --pids pids_before_1868.txt --limit 100 \ | |
| --output pids_api_sample.txt \ | |
| --records corpus/metadata/api_sample.jsonl | |
| ``` | |
| 全候補を照合する場合: | |
| ```bash | |
| python3 scripts/ndl_api_candidates.py --pids pids_before_1868.txt | |
| ``` | |
| 出力した一覧で取得する場合: | |
| ```bash | |
| python3 ndl_download.py download --pids pids_api_before_1868.txt -n 4 | |
| ``` | |
| API検索結果と取得日時は `corpus/metadata/api_candidate_cache/` にバッチ単位で保存します。同じ条件で再実行するとキャッシュを使って再開し、全バッチが成功してから出力を置き換えます。再照合には `--refresh` を指定します。実行を同じ出力・キャッシュ先で重複起動しないでください。 | |
| ## 制約と調査結果 | |
| - `f-id` の複数指定は[NDL公開ソースのBookService](https://github.com/ndl-lab/tugidigi-web/blob/master/src/main/java/jp/go/ndl/lab/back/service/BookService.java)で確認しました。2026-10-18の少数の実API照会では、753436と14491351を同時指定し、753436だけが返ることを確認しました。公式説明ページには記載されていないパラメータのため、将来の変更には追従が必要です。 | |
| - 収録確認は全文取得の成功保証ではありません。[BookController](https://github.com/ndl-lab/tugidigi-web/blob/master/src/main/java/jp/go/ndl/lab/back/api/BookController.java)では全文取得前に `PDMChecker` を呼び、その失敗時に `This PID is not allowed` を返します。[公開されている判定処理](https://github.com/ndl-lab/tugidigi-web/blob/master/src/main/java/jp/go/ndl/lab/common/utils/AccessIIIFEndpoints.java)ではIIIF manifestへの応答がHTTP 200かを調べており、通信障害でも失敗になります。公開ソースと稼働中サービスが完全に同じかは確認できていません。 | |
| - したがって、前の「API未収録が403の主因」という説明は推測です。今回の照合で未収録候補は除外できますが、403のすべてをなくせるとは限りません。`not_indexed` は検索結果に含まれなかった件数を表し、権利制限や永続的な取得不可の断定ではありません。 | |
| - [公式API説明](https://lab.ndl.go.jp/service/tsugidigi/apiinfo/)にも、書誌一覧とAPIの同期タイミング等により、全PIDの全文を取得できるとは限らない旨が記載されています。 | |
| - 既存の `unavailable` キャッシュは変更しません。収録確認済みのPIDでも、以前の403キャッシュを再確認したい場合はダウンローダーに `--retry-unavailable` を付けます。 | |
| オフラインテスト: | |
| ```bash | |
| python3 -m unittest discover -s scripts -p 'test_ndl_api_candidates.py' -v | |
| ``` | |