Javascriptを使用してPDFからテキストを抽出する

はじめに

以下のチュートリアルでは、ホストされたJPedalクラウドAPIを使用してPDFからテキストを抽出する方法を紹介します。独自のセルフホスト型JPedalマイクロサービスをセットアップすることもできます。

上記のサービスは通常のHTTPリクエストでアクセスできますが、このチュートリアルでは、REST API をシンプルなJavascriptラッパーで包んだオープンソースのJavascript IDRCloudClient を使用します。

前提条件

クライアントをプロジェクトに追加するには、idrcloudclient.jsファイルをプロジェクトに追加し、以下の行を含めてアクセスする必要があります：

<script src="path/to/idrcloudclient.js" type="text/javascript"></script>

コード例

以下は、PDFからテキストを抽出するための基本的なコード例です。設定オプションと高度な機能については、以下を参照してください。

var endpoint = 'https://my-self-hosted-service.com/' + IDRCloudClient.JPEDAL;
var parameters =  { 
    input: IDRCloudClient.UPLOAD,
    file: 'path/to/exampleFile.pdf',
    settings: '{"mode":"extractText","type":"plainText"}'
}

function progressListener(e) {
    console.log(JSON.stringify(e));
}

function failureListener(e) {
    console.log(e);
    console.log('Failed!');
}

function successListener(e) {
    console.log(JSON.stringify(e));
    console.log('Download URL: ' + e.downloadUrl);
}

IDRCloudClient.convert({
    endpoint: endpoint,
    parameters: parameters,
    
    // 以下は利用可能なリスナーです
    progress: progressListener,
    success: successListener,
    failure: failureListener
});

Javascriptクライアントを使用した例はこちらで確認できます。

コールバックURLに結果を返す

JPedal Microserviceは、抽出完了時に抽出のステータスを送信するコールバックURLを受け付けます。コールバックURLを使用することで、抽出が完了したかどうかを判断するためにサービスをポーリングする必要がなくなります。
コールバックURLは、以下のようにparameters変数に指定できます。

var parameters =  {
    input: IDRCloudClient.UPLOAD,
    callbackUrl: 'http://listener.url',
    file: 'path/to/exampleFile.pdf',
    settings: '{"mode":"extractText","type":"plainText"}'
}

設定オプション

JPedal APIは、抽出をカスタマイズするためのキーと値のペアの設定オプションを含む、文字列化されたJSONオブジェクトを受け付けます。設定はparameters配列に追加する必要があります。PDFからテキストを抽出するための設定オプションの完全なリストはこちらで確認できます。

settings: '{"key":"value","key":"value"}'

URLによるアップロード

ローカルファイルをアップロードする以外に、JPedal Microserviceがダウンロードして抽出を実行するURLを指定することもできます。これを行うには、parameters変数のinputとfileの値を以下のように置き換える必要があります。

input: IDRCloudClient.DOWNLOAD
url: 'http://exampleURL/exampleFile.pdf'

認証の使用

PDFからテキストを抽出するためにユーザー名とパスワードが必要な独自のJPedal Microserviceをデプロイしている場合は、各変換時にそれらを提供する必要があります。これらは、以下のようにconvertメソッドにusernameとpasswordという名前の2つの変数を渡すことで提供されます。

username: 'username',
password: 'password',

詳細情報

GitHubのIDRCloudClient
IDRCloudClientオンライン例
 JPedal Microservice API
JPedal Microserviceの使用方法