メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

Document は、カスタム アクティビティ スクリプトで現在処理中の Document (その field、ページ、分類結果、ソース ファイル、エクスポート結果) を表します。
どの処理ステージが完了しているかによっては、一部のプロパティが空の値を返すことがあります。たとえば、いずれの Skill も適用される前に設定されるのは DocumentId と SourceFiles のみです。ResultClass は分類スキルの実行後に設定されます。Fields は抽出後に設定されます。

​
プロパティ

名前型アクセス説明
ClassConfidencesClassConfidenceModel[]読み取り専用各クラスの信頼度の値です。
DocumentIdstring読み取り専用一意のDocument識別子です。
DocumentSkillIdstring読み取り専用Documentに適用された Document skill の一意の識別子です。
DocumentSkillNamestring読み取り専用Documentに適用された Document skill の名前です。
FieldsField[]読み取り専用Document上で検出された field です。Document skill の実行後にのみ設定されます。
IsResultClassConfidentbool読み取り専用Documentのクラスが信頼できるものとして判定された場合は true です。
PagesPage[]読み取り専用Documentのページです。
ResultClassstring読み取り専用分類スキルによって割り当てられたクラスです。Documentが分類されていない場合は空です。
RuleErrorsRuleError[]読み取り専用field 抽出のバリデーションルールエラーです。
SourceFilesBinaryFile[]読み取り専用Documentのソースファイルです。前処理前の画像が含まれます。JPEG では、ソースのメタデータ (EXIF データを含む) が保持されます。
ExportsResultFiles読み取り/書き込みDocumentのエクスポート結果です。
RegistrationParametersRecord<string, Parameter>読み取り専用最初のページに対するソースファイルの登録パラメーターの辞書です。キーはパラメーター名、値は Parameter オブジェクトです。
ClassConfidences と IsResultClassConfident は、分類スキルが適用された場合にのみ設定されます。

​
メソッド

​
ToJsonString

string ToJsonString();
Documentデータを JSON 形式の文字列として返します。

​
GetField

Field GetField(string fieldName);
指定した名前の field に対応する Field オブジェクトを返します。

トランザクション

現在のトランザクションと、そのすべてのDocumentにアクセスできます。

Field

field の値とそのプロパティにアクセスできます。

ページ

画像サイズを含む、1 つのDocumentページのプロパティ。

BinaryFile

バイナリ形式のファイル データ — 通常は前処理前の元の画像です。

オブジェクト モデル

カスタム アクティビティのスクリプト用の完全な JavaScript オブジェクト リファレンス。

カスタム アクティビティ

スクリプト ロジックやサードパーティ連携で Skill を拡張します。