compdf-ocr について
スキャン PDF や画像の OCR リクエストを計画する、チームやエージェント向けの ComPDF スキルです。公式 API ドキュメントに沿って、テキスト抽出、検索可能 PDF の生成、対応言語を扱います。
主な機能
- 01PDF を編集可能または検索可能な PDF に変換
- 02PDF からテキストを抽出
- 03画像を OCR してテキスト化
- 04対応する OCR 言語の確認
- 05公式ドキュメントに基づく API リクエスト計画
活用シーン
- 01スキャン PDF から読み取り可能なテキストを抽出
- 02画像ファイル内の文字を認識
- 03アーカイブ用の検索可能 PDF を作成
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ compdfkit/ compdf-skills --skill compdf-ocrインストール後、Claude Code で/compdf-ocrを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
agents/openai.yamlreferences/endpoint-index.mdofficial-api-reference.md詳細
ComPDF OCR
概要
ComPDF OCR は、エージェントやチームが、スキャンした PDF、スクリーンショット、写真に撮ったファイル、その他の画像ベースのドキュメントからテキストを取り出せるようにします。PDF と画像ファイルの両方で OCR をサポートしているため、読み取り可能なテキストの抽出、構造化コンテンツの復元、分析、アーカイブ、ワークフローの自動化に使える検索可能な出力の作成を容易にします。
このスキルを使用して、以下のサポート対象の操作に適した公式 ComPDF Server API エンドポイントを選択し、正確なリクエスト計画を準備します。
サポート対象の操作
| 操作 | 公式ページまたはインデックスのセクション |
|---|---|
| PDF から編集可能/検索可能な PDF への変換 | pdf-to-editable-pdf-tool-guide |
| PDF のテキスト抽出 | pdf-to-txt |
| 画像 OCR によるテキスト抽出 | image-to-txt |
| OCR の言語値 | ocr-languages |
対象範囲
このスキルは、OCR および OCR から生成されるテキストや検索可能な PDF の出力に限定してください。その他の出力形式には、対応する変換スキルを使用してください。
ワークフロー
- 元ファイルの種類、希望する出力、依頼された操作を特定します。
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 ファイルへの保存を確認してください。以降のリクエストでは、保存済みのキーを再利用します。