Aquaforest PDF

  • リファレンス

Aquaforest PDF コネクタには、Office 365 および Power Automate の分割、テキスト抽出、バーコード抽出、OCR 操作などのさまざまな PDF 操作を実行するアクションのグループが含まれます。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Aquaforest サポート
[URL] https://www.aquaforest.com/en/aquaforest-flow-doc.asp
メール support@aquaforest.com
Connector Metadata
発行者 Aquaforest Limited
Web サイト https://www.aquaforest.com/en/aquaforest-connector.asp
プライバシー ポリシー https://www.aquaforest.com/en/privacy policy.pdf
カテゴリ コンテンツとファイル; データ

Aquaforest PDF コネクタには、Office 365 および Flow の分割、テキスト抽出、バーコード抽出、OCR 操作などのさまざまな PDF 操作を実行するアクションのグループが含まれます。

前提条件

最初に、Aquaforest PDF API アカウントを作成する必要があります。 このアカウントは、Aquaforest PDF アクションと Aquaforest PDF API を管理するために使用されます。 サブスクリプションはこのアドレスにリンクされるため、アクティブな電子メール アドレスを使用してください。 既にアカウントを用意している場合、こちらからサインインします。

資格情報の入手方法

  1. 開発者ポータルにログインし、製品ページに移動し、サブスクライブする製品を選択します。

  2. サブスクライブ ボタンをクリックします

  3. サブスクリプション要求を確認する確認ボタンをクリックします

  4. プロファイル ページで API キーにアクセスできます

接続の作成

コネクタは、次の認証タイプをサポートしています:
既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 内容 必要
API キー securestring この API の API キー True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

OCR PDF または画像

画像 PDF またはスキャンした画像から検索可能な PDF を生成します。 詳細については、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。
PDF からテキストを取得する

テキストの場所と正規表現に基づいて PDF ファイルからテキストを取得します。 詳細については、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。
PDF からデータを取得する

このアクションは、キーと値のペアの形式で PDF ファイルから重要なデータを抽出します。
PDF プロパティを取得する

PDF ファイルに関する情報を取得します
テキストで PDF ページを抽出する

ユーザーが定義したテキストの一致に基づいて PDF ファイルを抽出します。 詳細については、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。
テキスト一致で PDF を分割する

ユーザーが定義したテキストの一致に基づいて PDF ファイルを分割します。 ドキュメントについては、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。 さらに、Aquaforest ゾーン抽出ツールは [https://www.aquaforest.com/en/zone/get-pdf-zone.html] でご確認いただけます。
バーコードで PDF を分割する

ユーザーが定義したバーコードの一致に基づいて PDF ファイルを分割します。 ドキュメントについては、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。 さらに、Aquaforest ゾーン抽出ツールは [https://www.aquaforest.com/en/zone/get-pdf-zone.html] でご確認いただけます。
バーコードで PDF ページを抽出する

ユーザーが定義したバーコードの一致に基づいて PDF ファイルを抽出します。 詳細については、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。
バーコード値を取得する

PDF からバーコードを取得します。 詳細については、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。
ページで PDF を分割する

ユーザーが定義した分割オプションに基づいて PDF ファイルを分割します。 ドキュメントについては、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。

OCR PDF または画像

操作 ID:
Ocr-file-to-pdf

画像 PDF またはスキャンした画像から検索可能な PDF を生成します。 詳細については、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。

パラメーター

名前 キー 必須 型 説明
AquaforestImageTimeout
 aquaforestImageTimeout integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
Author
 author string

出力 PDF ドキュメント プロパティでカスタム作成者を設定します。
自動回転
 autorotate boolean

画像の自動回転 – これにより、すべてのテキストが正常に方向付けられるようになります
2 値化
 binarize integer

この値は通常、テクニカル サポートからのガイダンスの下でのみ使用する必要があります。 カラー画像の処理方法を制御し、特定のしきい値で 2 値化を強制できます。 値 200は、通常テストで良好な結果をもたらすことが示されていますが、これは "一般的な" 顧客ドキュメントで確認する必要があります。 これを -1 に設定すると、テキストを任意の背景画像や色から区切ろうとする代替方法が使用されます。 これにより、新聞や雑誌のページなどの特定のドキュメントの OCR 結果を改善できます。
黒のピクセル制限
 blackPixelLimit float

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
空白ページのしきい値
 blankPageThreshold integer

これを使用して、ページが空白と見なされないようにするために画像に存在する必要がある "オンピクセル" の最小数を設定します。 -1 の値は、空白ページの検出をオフにします。
ボックス サイズ
 boxSize integer

このオプションは、テキストの周りのボックスが表示され、領域がグラフィックとして識別される可能性があるフォームに適しています。 このオプションは、OCR エンジンにより使用される画像の一時的コピーからボックスを削除します。 最終的な画像からはボックスは削除されません。 技術的には、このオプションは、最小領域 (ピクセル単位で、このプロパティにより定義される) で接続された要素を削除します。 このオプションは現在、2 色調画像にのみ適用されます。
ConvertToTiff
 convertToTiff boolean

PDF ドキュメントの各ページは TIFF 画像にラスタライズされます。
CreateProcess
 createProcess boolean

pinvoke を介してプロセスを起動する場合は、これを true に設定します。
作成日
 creationDate string

出力 PDF ドキュメント プロパティでカスタム作成日を設定します。 日付文字列は 'yyyy-MM-dd HH:mm:ss' の形式である必要があります。
傾き修正
 deskew boolean

画像の傾きを修正 (まっすぐに) します。
スペックル除去
 despeckle integer

これにより、指定された数値よりもピクセル単位の高さまたは幅が小さい、画像内の切断されたすべての要素が削除されます。 最大値は 9 で、既定値は 0 です。
DictionaryLookup
 dictionaryLookup integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
ドットマトリックス
 dotmatrix boolean

ドットマトリックス フォントの認識を向上させるには、これを true に設定します。 既定値は false です。 ドットマトリックス以外のフォントで true に設定すると、認識が低下する可能性があります。
デバッグ出力の有効化
 enableDebugOutput boolean

デバッグ出力を有効化します。
PDF の圧縮 (MRC)
 enableMrc boolean

これにより、混合ラスター圧縮が可能になり、カラー スキャンを含む PDF の出力サイズを大幅に削減できます。 このオプションは、ソースが PDF でない場合、または ConvertToTiff を使用している場合にのみ適していることに注意してください。
PDF/A 出力
 enablePDFAOutput boolean

PDF/A として出力するかどうか。
エラー モード
 errorMode integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
ソース ファイルのコンテンツ
 fileContent True byte

OCR へのファイルのコンテンツ
ソース ファイル名 (拡張子付き)
 fileNameWithExtension True string

拡張子付きのソース ファイル名、または拡張子のみ (先頭にピリオド付き '.')
フリップ検出
 flipDetect integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
グレースケール品質
 grayscaleQuality integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
経験則
 heuristics integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
Jbig2EncFlags
 jbig2EncFlags string

これらは、PDF 生成で使用される画像の JBIG2 バージョンを生成するために使用されるアプリケーションに渡されるフラグです (この圧縮が有効になっていると仮定した場合)。 このオプションは通常、テクニカル サポートからのガイダンスの下でのみ使用する必要があります。
言語
 language enum

以下のオプションのいずれかを選択すると、OCR 処理に使用する言語が設定されます。 既定の言語は英語です。
LibTiffSavePageAsBmp
 libTiffSavePageAsBmp boolean

画像が 1bpp で、LZW 圧縮である場合、事前処理によって画像の色が反転することがあります (黒から白、白から黒)。 これを回避するには、これを true に設定します。
最大の傾き修正度
 maxDeskew float

ページが傾き修正される最大角度。 このオプションは通常、テクニカル サポート (support@aquaforest.com) からのガイダンスの下でのみ使用する必要があります。
最小の傾き修正度
 minDeskewConfidence float

このオプションは通常、テクニカル サポート (support@aquaforest.com) からのガイダンスの下でのみ使用する必要があります。
変更日
 modifiedDate string

出力 PDF ドキュメント プロパティでカスタム変更日を設定します。 日付文字列は 'yyyy-MM-dd HH:mm:ss' の形式である必要があります。
モーフィング
 morph string

OCR の前に 2 値化された画像に適用されるポリモーフィック オプション。 空に設定すると、何も適用されません。 一般的なオプションには以下の一覧が含まれますが、その他のオプションについては support@aquaforest.com にお問い合わせください。
MrcBackgroundFactor
 mrcBackgroundFactor integer

画像の背景部分のサンプリング サイズ。 数値が大きいほど、平均化に使用される画像ブロックのサイズが大きくなり、それによりサイズの縮小と、品質も低下します。 既定値は 3
MrcForegroundFactor
 mrcForegroundFactor integer

画像の前景部分のサンプリング サイズ。 数値が大きいほど、平均化に使用される画像ブロックのサイズが大きくなり、それによりサイズの縮小と、品質も低下します。 既定値は 3
MrcQuality
 mrcQuality integer

背景画像と前景画像の保存に使用する JPEG 品質設定 (割合の値 1 〜 100)。 既定値は 75
MrcTimeout
 mrcTimeout integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
NoPictures
 noPictures boolean

既定では、ドキュメントの領域がグラフィック領域として識別されている場合、その領域では OCR 処理は実行されません。 ただし、特定のドキュメントには、"グラフィック" または "写真" 領域として識別される領域またはボックスが含まれる場合がありますが、実際には有用なテキストが含まれています。 NoPictures を True に設定すると、写真として識別される領域が無視され、False に設定すると、写真として識別される領域の OCR が強制されます。
OcrProcessSetupTimeout
 ocrProcessSetupTimeout integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
OcrTimeout
 ocrTimeout integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
Password
 password string

ソース PDF ファイルとして開くパスワード
PdfToImageBpp
 pdfToImageBpp enum

エンジン 1 を使用するときにラスタライズされた PDF ページに使用するピクセルあたりのビット数。 これは、ConvertToTiff を使用して処理されるドキュメントにのみ適用されます。 このプロパティの既定値は、PDF ページから取得されます。
PdfToImageCompression
 pdfToImageCompression enum

ソース PDF ファイルの各ページから抽出またはラスタライズされた画像に設定する圧縮。 これらの画像は、検索可能な PDF を作成するために OCRed になります。 このプロパティの既定値は、ソース PDF ファイルの各ページから取得されます。
PdfToImageDpi
 pdfToImageDpi enum

ソース PDF ファイルの各ページからラスタライズされた画像に設定する DPI。 これらの画像は、検索可能な PDF を作成するために OCRed になります。 このプロパティの既定値は、ソース PDF ファイルの各ページから取得されます。
PdfToImageForceVectorCheck
 pdfToImageForceVectorCheck boolean

この設定は、ベクトル オブジェクト (CAD 描画など) を含むドキュメントを処理する場合に役立ちます。 既定では、ベクトル オブジェクトのみを含むページがラスタライズされます。 画像はなくても、ベクトル オブジェクトと電子テキストが含まれているページは、ラスタライズからスキップされます。 ただし、ベクトル オブジェクト (CAD 描画) を含むページがあり、そのタイトルが電子テキストである場合があります。 このようなページを強制的にラスタライズするには、このプロパティを true に設定します。
PdfToImageIncludeText
 pdfToImageIncludeText boolean

False に設定すると、PDF から抽出されたページ画像に実際のテキスト (つまり、スキャンされた画像の一部であるテキストではなく電子的に生成されたもの) の変換がレンダリングされなくなります。 これは、テキストがすでに検索可能であり、通常は OCR を必要としないためです。 ただし、この実際のテキストで OCR が必要な場合は、値を True に設定できます。
PdfToImageMaxRes
 pdfToImageMaxRes integer

ラスタライズされた画像の最大解像度。 PDF ページから取得した解像度がこの値より大きい場合、この値に設定されます。 このプロパティの既定値は 600 です。
PdfToImageMinRes
 pdfToImageMinRes integer

ラスタライズされた画像の最小解像度。 PDF ページから取得した解像度がこの値より小さい場合、この値に設定されます。 このプロパティの既定値は 200 です。
PDF/A バージョン
 pdfaVersion enum

PDF/A バージョン。
PipeClientConnectionTimeout
 pipeClientConnectionTimeout integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
RemoveBlankPage
 removeBlankPage boolean

BlankPageThreshold が -1 より大きく、ConvertToTiff が true の場合、空白ページを削除します。
RemoveLines
 removeLines boolean

認識しやすいように画像から線を削除します。
RestartEngineEvery
 restartEngineEvery integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
ブックマークの保持
 retainBookmarks boolean

ConvertToTiff の使用時に、出力のソース ファイルから任意のブックマークを保持します。
作成日の保持
 retainCreationDate boolean

ソース ファイルの作成日を、出力 PDF ドキュメント プロパティに保持します。
メタデータの保持
 retainMetadata boolean

ConvertToTiff の使用時に、出力のソース ファイルから任意のメタデータを保持します。
変更日の保持
 retainModifiedDate boolean

ソース ファイルの変更日を、出力 PDF ドキュメント プロパティに保持します。
視聴者の基本設定の保持
 retainViewerPreferences boolean

ConvertToTiff の使用時に、出力のソース ファイルから任意の PDF 視聴者の基本設定、ページ モード、およびページ レイアウトを保持します。
SavePredespeckle
 savePredespeckle boolean

これにより、出力 PDF の元の画像 (つまり、事前処理を適用する前) が使用されます。
テーブル
 tables boolean

このオプションを true に設定すると、テーブルのセル内で OCR を試行します。
TextLayerFilterHeight
 textLayerFilterHeight integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
TextLayerFilterHeightInverted
 textLayerFilterHeightInverted integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
TextLayerFilterPercentage
 textLayerFilterPercentage float

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
TextLayerFilterPercentageInverted
 textLayerFilterPercentageInverted float

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
TextLayerFilterRatio
 textLayerFilterRatio float

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
TextLayerFilterRatioInverted
 textLayerFilterRatioInverted float

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
TextLayerFilterWidth
 textLayerFilterWidth integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
TextLayerFilterWidthInverted
 textLayerFilterWidthInverted integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
TextLayerMaxBoxes
 textLayerMaxBoxes integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
整理モード
 tidyUpMode integer

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。
PDF/A の検証​​
 validatePDFA boolean

変換後に PDF/A ドキュメントを検証するかどうか
単語一致のしきい値
 wordMatchThreshold float

このプロパティの使用に関するガイダンスについては、テクニカルサポート (support@aquaforest.com) にお問い合わせください。

戻り値

OCR 操作の応答データ

Body
ocr_response

PDF からテキストを取得する

操作 ID:
Get-text-value

テキストの場所と正規表現に基づいて PDF ファイルからテキストを取得します。 詳細については、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。

パラメーター

名前 キー 必須 型 説明
ファイル コンテンツ
 fileContent True byte

ソース ファイルのコンテンツ
テキスト一致テンプレートなし
 noTextTemplate True string

一致するものが検出されなかった場合に返されるテキストのテンプレート
ページ区切り記号
 pageSeparator string

ページ分割がどこにあるかが分かるように、ページ区切り記号を指定します。
ページ
 pagerange string

テキストを抽出するページ範囲を指定します。これは、単一のページ番号 (1)、コンマで区切られた複数のページ番号 (1,2,3)、ページ範囲 (1-4) またはこれらの組み合わせ (1,2,4-7) になります。
ファイル名
 sourceFileName True string

ソース ファイル名
テキスト結果のテンプレート
 textResultTemplate True string

一致するものが検出された場合に返されるテキストのテンプレート
価値
 expression array of string

上のプロパティで使用する値を 1 つ以上ここに入力してください。上に示すルールに一致する最初のテキスト値が返されます。
場所
 location True string

ページの領域 - Zonal ツールを使用して座標を取得します: [https://www.aquaforest.com/en/zone/get-pdf-zone.html]
ページ (非推奨)
 pagenumber integer

このプロパティは非推奨です。ページ プロパティを使用することをお勧めします。 ページ プロパティはすべてのゾーンに適用され、処理するページを選択できます。
Select
 position string

これを使用して、抽出するテキストをさらに絞り込み、要件に一致するオプションを選択します
パターン
 regex string

ここで正規表現が提供されている場合、抽出されたテキストをそれに一致させ、一致を返します。

戻り値

本文​​
ApiGetTextValueJsonResponse

PDF からデータを取得する

操作 ID:
Get-data-from-pdf

このアクションは、キーと値のペアの形式で PDF ファイルから重要なデータを抽出します。

パラメーター

名前 キー 必須 型 説明
件名
 settingName True string

設定の名前をここで入力します
値
 settingValue True string

設定の値をここで入力します。
信頼度スコア
 confidenceScore number

信頼度スコアを高く設定して、信頼度の低い値を除外します。 0 から 1 までの任意の値を設定できます。 0.5 から始めることをお勧めします
変換日
 dateAsISO string

日付値を返す形式を選択します
予想キー
 expectedKeys string

JSON を解析せずに後のアクションで値を使用できるようにするには、行ごとに 1 つのキー名を指定します。
ファイル コンテンツ
 fileContent True byte

ソース ファイルのコンテンツ
ページ制限
 pageLimit integer

処理するページの最大数
ページ範囲
 pageRange string

処理するページ番号の文字列表現。 例: 1,3-4
ストリップ通貨の記号
 stripCurrencySymbol boolean

通貨値を返す前に記号と文字列を削除する場合は、これを true に設定します
同義語の一致
 synonym boolean

予想キーの同義語であるすべてのキーを返す場合は、これを true に設定します。
同義語の辞書
 synonymDictionary string

“エントリ” オブジェクトの JSON 配列を指定できます。各オブジェクトには、配列内の同義語の一覧が含まれます。 たとえば、“Invoice No” と “Invoice Number” (大文字と小文字を区別しない) を同じキーとして解釈する場合は、次の JSON を使用します: [{'entry': [ 'Invoice No', 'invoice number' ]}]
トリミング記号
 trimSymbols boolean

予期キーと一致させる前に、検出されたキーからすべての先頭と末尾にある記号を削除する場合は、これを true に設定します。

戻り値

この操作の出力は状況に応じて変わります。

PDF プロパティを取得する

操作 ID:
Get-pdf-information

PDF ファイルに関する情報を取得します

パラメーター

名前 キー 必須 型 説明
ファイル コンテンツ
 fileContent True byte

ソース ファイルのコンテンツ
ページ制限
 pageLimit integer

処理されるページの最大数。これは、ページに非表示のテキストが含まれているかどうか、または PDF が検索可能かどうかを確認するためにのみ使用されます

戻り値

本文​​
GetPDFInfoResponse

テキストで PDF ページを抽出する

操作 ID:
Extract-by-text

ユーザーが定義したテキストの一致に基づいて PDF ファイルを抽出します。 詳細については、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。

パラメーター

名前 キー 必須 型 説明
ファイル コンテンツ
 fileContent True byte

ソース ファイルのコンテンツ
ファイル名テンプレート
 fileNameTemplate True string

テキストの一致が検出された場合の、出力ファイルのテンプレート
テンプレート ファイルなし
 noTextFileName True string

テキストの一致が検出されなかった場合の、出力ファイルのテンプレート
File Name
 sourceFileName True string

ソース ファイル名
価値
 expression array of string

上のプロパティで使用する値を 1 つ以上ここに入力してください。上に示すルールに一致する最初のテキスト値が返されます。
場所
 location True string

ページの領域 - Zonal ツールを使用して座標を取得します: [https://www.aquaforest.com/en/zone/get-pdf-zone.html]
Select
 position string

これを使用して、抽出するテキストをさらに絞り込み、要件に一致するオプションを選択します
パターン
 regex string

ここで正規表現が提供されている場合、抽出されたテキストをそれに一致させ、一致を返します。

戻り値

本文​​
ApiExtractPost200ApplicationJsonResponse

テキスト一致で PDF を分割する

操作 ID:
Split-by-text

ユーザーが定義したテキストの一致に基づいて PDF ファイルを分割します。 ドキュメントについては、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。 さらに、Aquaforest ゾーン抽出ツールは [https://www.aquaforest.com/en/zone/get-pdf-zone.html] でご確認いただけます。

パラメーター

名前 キー 必須 型 説明
ファイル コンテンツ
 fileContent True byte

ソース ファイルのコンテンツ
ファイル名テンプレート
 fileNameTemplate True string

テキストの一致が検出された場合の、出力ファイルのテンプレート
一致が検出されないページ
 noMatch string

上記で選択した分割オプションによっては、一部のページに抽出されたテキスト値がありません。 これらのページを処理するかを選択します。
テンプレート ファイルなし
 noTextFileName True string

テキストの一致が検出されなかった場合の、出力ファイルのテンプレート
ファイル名
 sourceFileName True string

ソース ファイル名
出力ファイル オプション
 splitOption string

分割操作からの出力ファイルで、バーコードのあるページの場所を選択します。
価値
 expression array of string

上のプロパティで使用する値を 1 つ以上ここに入力してください。上に示すルールに一致する最初のテキスト値が返されます。
場所
 location True string

ページの領域 - Zonal ツールを使用して座標を取得します: [https://www.aquaforest.com/en/zone/get-pdf-zone.html]
Select
 position string

これを使用して、抽出するテキストをさらに絞り込み、要件に一致するオプションを選択します
パターン
 regex string

ここで正規表現が提供されている場合、抽出されたテキストをそれに一致させ、一致を返します。

戻り値

本文​​
ApiSplitPost200ApplicationJsonResponse

バーコードで PDF を分割する

操作 ID:
Split-by-barcode

ユーザーが定義したバーコードの一致に基づいて PDF ファイルを分割します。 ドキュメントについては、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。 さらに、Aquaforest ゾーン抽出ツールは [https://www.aquaforest.com/en/zone/get-pdf-zone.html] でご確認いただけます。

パラメーター

名前 キー 必須 型 説明
ファイル コンテンツ
 fileContent True byte

ソース ファイルのコンテンツ
ファイル名テンプレート
 fileNameTemplate True string

バーコードが検出された場合の、出力ファイルのテンプレート
一致が検出されないページ
 noMatch string

上記で選択した分割オプションによっては、一部のページにバーコード値がありません。 これらのページを処理するかを選択します。
バーコード一致テンプレートなし
 noTextFileName True string

バーコードが検出されなかった場合の、出力ファイルのテンプレート
ファイル名
 sourceFileName True string

ソース ファイル名
出力ファイル オプション
 splitOption string

これを使用して、抽出するテキストをさらに絞り込み、要件に一致するオプションを選択します
タイプ
 barcodeFormats array of string

識別するバーコードの種類を指定
場所
 location True string

ページの領域 - Zonal ツールを使用して座標を取得します: [https://www.aquaforest.com/en/zone/get-pdf-zone.html]
パターン
 regex string

ここで正規表現が提供されている場合、抽出されたバーコードをそれに一致させ、一致を返します。

戻り値

本文​​
ApiSplitPost200ApplicationJsonResponse

バーコードで PDF ページを抽出する

操作 ID:
Extract-by-barcode

ユーザーが定義したバーコードの一致に基づいて PDF ファイルを抽出します。 詳細については、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。

パラメーター

名前 キー 必須 型 説明
ファイル コンテンツ
 fileContent True byte

ソース ファイルのコンテンツ
ファイル名テンプレート
 fileNameTemplate True string

バーコードが検出された場合の、出力ファイルのテンプレート
テンプレート ファイルなし
 noTextFileName True string

バーコードが検出されなかった場合の、出力ファイルのテンプレート
File Name
 sourceFileName True string

ソース ファイル名
タイプ
 barcodeFormats array of string

識別するバーコードの種類を指定
場所
 location True string

ページの領域 - Zonal ツールを使用して座標を取得します: [https://www.aquaforest.com/en/zone/get-pdf-zone.html]
パターン
 regex string

ここで正規表現が提供されている場合、抽出されたバーコードをそれに一致させ、一致を返します。

戻り値

本文​​
ApiExtractPost200ApplicationJsonResponse

バーコード値を取得する

操作 ID:
Get-barcode-value

PDF からバーコードを取得します。 詳細については、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。

パラメーター

名前 キー 必須 型 説明
バーコード結果のテンプレート
 barcodeResultTemplate True string

バーコードが検出された場合の、出力テキスト結果のテンプレート
ファイル コンテンツ
 fileContent True byte

ソース ファイルのコンテンツ
バーコード テンプレートなし
 noBarcodeTemplate True string

バーコードが検出されなかった場合の、出力テキスト結果のテンプレート
ページ区切り記号
 pageSeparator string

ページ分割がどこにあるかが分かるように、ページ区切り記号を指定します。
ページ
 pagerange string

テキストを抽出するページ範囲を指定します。これは、単一のページ番号 (1)、コンマで区切られた複数のページ番号 (1,2,3)、ページ範囲 (1-4) またはこれらの組み合わせ (1,2,4-7) になります。
File Name
 sourceFileName True string

ソース ファイル名
タイプ
 barcodeFormats array of string

識別するバーコードの種類を指定
場所
 location True string

ページの領域 - Zonal ツールを使用して座標を取得します: [https://www.aquaforest.com/en/zone/get-pdf-zone.html]
ページ (非推奨)
 pagenumber integer

このプロパティは非推奨です。ページ プロパティを使用することをお勧めします。 ページ プロパティはすべてのゾーンに適用され、処理するページを選択できます。
パターン
 regex string

ここで正規表現が提供されている場合、抽出されたテキストをそれに一致させ、一致を返します。

戻り値

本文​​
ApiRenameByBarcodePost200ApplicationJsonResponse

ページで PDF を分割する

操作 ID:
Split-by-page-range

ユーザーが定義した分割オプションに基づいて PDF ファイルを分割します。 ドキュメントについては、[https://www.aquaforest.com/en/aquaforest-flow-doc.asp] を参照してください。

パラメーター

名前 キー 必須 型 説明
ファイル コンテンツ
 fileContent True byte

ソース ファイルのコンテンツ。
出力ファイル名
 fileNameTemplate True string

％UNIQUEn (1 から始まり、ゼロが n 桁に埋め込まれる一意の番号) と %FILENAME (拡張子なしの元のファイル名) を含めることができる対象ファイル テンプレート。
ファイル名
 sourceFileName True string

ソース ファイルの名前。
分割の種類
 splitOption True string

各ファイルに使用する分割操作を選択します。
ページ範囲
 pageRange string

オリジナルから抽出されるページを定義する、コンマで区切られたページ範囲のセット。
繰り返し間隔
 repeatEvery integer

ドキュメント内のページ範囲の各セット ページにページ範囲を適用します。 たとえば、ページ範囲に 2 〜 4 が指定され、繰り返し範囲として 4 が指定されている場合、範囲は 4 ページごとに再適用されます。
ブックマークの保持
 retainBookmarks boolean

生成されたファイルには、元のファイルからのブックマークが含まれます。
メタデータの保持
 retainMetadata boolean

生成されたファイルには、元のファイルのメタデータ (作成者やタイトルなど) が含まれます。

戻り値

本文​​
ApiSplitPost200ApplicationJsonResponse

定義

ApiExtractPost200ApplicationJsonResponse

名前 パス 型 説明
エラー
 ErrorMessage string

「正常に完了」の値が false の場合、エラー メッセージが返されます
正常に完了
 IsSuccessful boolean

これは少なくとも 1 つのページが抽出された場合、true を返します
ライセンス情報
 LicenceInfo string

API サブスクリプション キーに関する情報
出力ファイルの抽出
 SplittedFile array of object

抽出されたファイルの配列
(ファイル コンテンツ)
 SplittedFile.SplitFileContent byte

ファイル コンテンツを表す base64 文字列
(ファイル名)
 SplittedFile.SplitFileName string

生成されたファイル名を含む文字列
(ページ番号)
 SplittedFile.pageNumber string

抽出が行われたページ番号を含むページ範囲

ApiGetTextValueJsonResponse

名前 パス 型 説明
エラー メッセージ
 ErrorMessage string

「正常に完了」の値が false の場合、エラー メッセージが返されます
正常に完了
 IsSuccessful boolean

テキストが正常に一致した場合
ライセンス情報
 LicenceInfo string

API サブスクリプション キーに関する情報
テキストの結果
 TextResult string

抽出されたテキストを指定されたテキスト結果テンプレートに適用することで生成された文字列。 ページ数が 1 より大きい場合は、ページ区切り記号を使用してすべてのページが連結されることに注意してください。
結果​​
 TextResults array of object

ページの一覧と抽出されたテキスト値を含む配列
(ページ番号)
 TextResults.pageNumber string

テキストが検出されたページ
(ページ テキスト)
 TextResults.valueExtracted string

抽出されたテキストを指定されたテキスト結果テンプレートに適用することで生成された文字列。
(ゾーン値)
 TextResults.zoneValues array of string

各ゾーンから抽出されたテキストを含む配列。

ApiRenameByBarcodePost200ApplicationJsonResponse

名前 パス 型 説明
バーコード
 BarcodeResult string

抽出されたテキストを指定されたバーコード結果テンプレートに適用することで生成された文字列。 ページ数が 1 より大きい場合は、ページ区切り記号を使用してすべてのページが連結されることに注意してください。
結果​​
 BarcodeResults array of object

ページの一覧と抽出されたバーコード値を含む配列
(ページ番号)
 BarcodeResults.pageNumber string

バーコードが検出されたページ
(ページ バーコード)
 BarcodeResults.valueExtracted string

抽出されたバーコード値を指定されたバーコード結果テンプレートに適用することで生成された文字列。
(ゾーン値)
 BarcodeResults.zoneValues array of string

各ゾーンから抽出されたバーコードを含む配列。
エラー メッセージ
 ErrorMessage string

「正常に完了」の値が false の場合、エラー メッセージが返されます
正常に完了
 IsSuccessful boolean

バーコードが検出された場合
ライセンス情報
 LicenceInfo string

API サブスクリプション キーに関する情報

ApiSplitPost200ApplicationJsonResponse

名前 パス 型 説明
エラー メッセージ
 ErrorMessage string

「正常に完了」の値が false の場合、エラー メッセージが返されます
正常に完了
 IsSuccessful boolean

これは少なくとも 1 つの分割ページが一致した場合、true を返します。
ライセンス情報
 LicenceInfo string

API サブスクリプション キーに関する情報
出力ファイルの分割
 SplittedFile array of object

生成されたファイル名やページ番号などの詳細と共に、分割された各ファイルを含む配列。
(ファイル コンテンツ)
 SplittedFile.SplitFileContent byte

ファイル コンテンツを表す base64 文字列
(ファイル名)
 SplittedFile.SplitFileName string

生成されたファイル名を含む文字列
(ページ範囲)
 SplittedFile.pageNumber string

分割操作のページ番号を含むページ範囲

GetPDFInfoResponse

名前 パス 型 説明
アセンブリの許可
 AllowAssembly boolean

ページの回転、挿入、または削除を許可します。
低解像度での印刷を許可
 AllowDegradedPrinting boolean

低品質の印刷を許可します。
抽出コンテンツの許可
 AllowExtractContents boolean

テキストとグラフィックの抽出を許可します。
アクセシビリティ用の抽出の許可
 AllowExtractForAccessibility boolean

アクセシビリティをサポートするテキストとグラフィックの抽出を許可します。
フォーム入力の許可
 AllowFillInForm boolean

フォーム フィールドへの入力を許可します。
注釈変更の許可
 AllowModifyAnnotations boolean

注釈の変更を許可します。
コンテンツ変更の許可
 AllowModifyContents boolean

コンテンツの変更を許可します。
印刷の許可
 AllowPrinting boolean

高品質の印刷を許可します。
作成者
 Author string

ドキュメントの作成者。
作成日
 CreationDate string

これは PDF が作成された日時です。
作成者
 Creator string

元のアプリケーションまたはライブラリ。
エラー メッセージ
 ErrorMessage string

「正常に完了」の値が false の場合、エラー メッセージが返されます
ファイル サイズ (バイト数)
 FileSize number

バイト単位で表すファイルのサイズ
非表示テキストあり
 HasHiddenText boolean

PDF ファイルに OCR レイヤーがある場合、これは true を返します。
暗号化済
 IsEncrypted boolean

このドキュメントが暗号化されているかどうかで、これは true を返します。
検索可能
 IsSearchable boolean

PDF ファイル検索可能な場合、これは true を返します。
正常に完了
 IsSuccessful boolean

アクションが正常に完了した場合、true を返します。
キーワード
 Keywords string

キーワードはコンマで区切られます。
ライセンス情報
 LicenceInfo string

サブスクリプション売上予算の Json の概要。
変更日
 ModifiedDate string

このプロパティは PDF が最後に修正された日時を表します
ページ数
 NumberofPages integer

PDF ファイルのページ数。
PDF のバージョン
 PDFversion number

ドキュメントが構築された PDF 仕様のバージョン。
プロデューサー
 Producer string

PDF を作成した製品。 初期には、PDF ユーザーは Microsoft Word のようなクリエーター アプリケーションを使用してドキュメントを書き込み、それを PostScript ファイルに印刷しました。プロデューサーとは、PostScript ファイルを PDF に変換するアプリケーションである AcrobatDistiller でした。 現在では、クリエーターとプロデューサーは大抵同じであるか、1 つのフィールドが空白のままになっています。
情報カテゴリ
 Subject string

ドキュメントの内容。
敬称
 Title string

ドキュメントのタイトル。
トラップ済
 Trapped string

このプロパティは、ドキュメントがトラップされたかどうかを示すブール値です。 トラッピングは、潜在的な登録エラーを目立たなくするため、色の境界に色領域を導入するプリプレス プロセスです。
XMP メタデータ
 XmpMetadata string

Extensible Metadata Platform (XMP) は、デジタル ドキュメントおよびデータ セット用の標準化されたカスタム メタデータの作成、処理、交換を行うために、元々 Adobe Systems Inc. によって作成された ISO 標準です。

ocr_response

OCR 操作の応答データ

名前 パス 型 説明
エラー メッセージ
 ErrorMessage string

「正常に完了」の値が false の場合、エラー メッセージが返されます
正常に完了
 IsSuccessful boolean

OCR が正常に完了した場合、true を返します。
ライセンス情報
 LicenceInfo string

API サブスクリプション キーに関する情報
ログ ファイル コンテンツ
 LogFileContent byte

操作のログ コンテンツ
処理されたファイル コンテンツ
 OutputFileContent byte

Aquaforest PDF コンバーターによって生成されたファイル。