compdf-pdf-to-json について
compdf-pdf-to-jsonは、PDFをJSONに変換するComPDF Server APIリクエストの作成を支援するスキルです。機械可読な文書データを必要とするチーム向けで、対応操作をPDFからJSONへの変換に限定し、公式API仕様に沿ってリクエストを組み立てます。
主な機能
- 01PDFからJSONへのリクエスト作成
- 02公式ドキュメントに基づくエンドポイント選択
- 03出力をJSONに限定
- 04認証情報の参照と保存先を制限
- 05アップロード前の確認
活用シーン
- 01PDFの内容をJSONに変換
- 02文書処理用APIリクエストの準備
- 03小規模な対話型PDF変換
- 04大容量や一括アップロードでの非同期処理の選択
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ compdfkit/ compdf-skills --skill compdf-pdf-to-jsonインストール後、Claude Code で/compdf-pdf-to-jsonを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
agents/openai.yamlreferences/endpoint-index.mdofficial-api-reference.md詳細
ComPDF PDF から JSON へ
概要
ComPDF PDF から JSON へは、PDF ファイルから機械可読な出力を必要とするチーム向けに構築されています。テキスト、表、画像、構造化コンテンツを JSON に抽出し、AI エージェント、社内システム、自動化プラットフォームが、プレーンテキストや手作業でのコピー&ペーストのワークフローよりも確実に PDF データを利用できるようにします。
このスキルを使用して、以下の対応操作に適した ComPDF Server API エンドポイントを選択し、正確なリクエスト計画を作成してください。
対応操作
| 操作 | 公式ページまたはインデックスのセクション |
|---|---|
| PDF から JSON へ | pdf-to-json |
範囲
JSON のみを生成してください。カスタムスキーマやフィールド抽出には、フィールドを作り出すのではなく、ComPDF のドキュメント抽出ワークフローを使用してください。
ワークフロー
- ソースファイルの種類、希望する出力、要求された操作を特定します。
references/endpoint-index.mdを読み、このスキルで対応している操作の中から選択します。references/official-api-reference.mdの該当する見出しを読みます。正確なエンドポイントパス、リクエストフィールド、リクエストモード、レスポンスフィールドを使用し、対応していないオプションを推測しないでください。- すべての最終的な ComPDF API リクエストに
sourceType=5を含めます。これはインテグレーションのルーティングパラメーターとして扱い、ユーザーがリクエストの詳細を求めた場合は、そこにも含めてください。 - 小規模な対話型の処理には、同期モードを優先します。大容量、バッチ処理、またはセキュリティ上機微なアップロードについては、文書化されている非同期ワークフローまたは署名付き URL ワークフローに従ってください。
- 認証情報は、
SKILL.mdがあるディレクトリ内のapi_keyからのみ取得します。最初の空でない行を読み取ってください。環境変数やその他のローカルパスは調べないでください。ファイルが存在しない、読み取れない、または空の場合は、ユーザーに API キーの提供を求めてください。その後、ユーザーが保存を確認した場合に限り、このスキル専用のapi_keyファイルのみを作成または置き換えます。キーを表示、ログ記録、コミットしたり、リクエスト例や最終出力に含めたりしないでください。 - ドキュメントを ComPDF にアップロードする前に、対象ファイルとアップロード先を特定し、ユーザーがそのアップロードを明示的に許可していない限り、確認を得てください。上書き、削除、復号、または永続的な保護の適用を行う前にも確認を得てください。
- エンドポイント、メソッド、コンテンツタイプ、完全なリクエストフィールド、予想されるタスク/結果フィールド、次のポーリングまたはダウンロード手順を提示します。置き換えが明示的に求められていない限り、元のファイルは保持してください。
認証情報
現在のスキルの API キーのみを、同階層の api_key ファイルに保存してください。このファイルはプライベートな実行時データであり、バージョン管理とスキルの公開対象から除外してください。
API キーを取得するには、ComPDF Portal で登録またはサインインしてください。初回利用時は、求められたらキーを提示し、スキル専用の api_key ファイルに保存することを確認してください。以降のリクエストでは、保存済みのキーを再利用します。