OcrSampleDocument
OcrSampleDocument 型が、実際のサンプルドキュメントを表す必要はありません。また、同じ DocumentType のすべてのドキュメントを表す抽象ドキュメントにすることもできます。その場合、contentAsset と documentHeight 項目は null になります。
ファイルのサフィックスおよびディレクトリの場所
OcrSampleDocument コンポーネントのサフィックスは .ocrSampleDocument で、ocrSampleDocuments フォルダーに保存されます。
バージョン
OcrTemplate コンポーネントは、API バージョン 52.0 以降で使用できます。
特別なアクセスルール
このメタデータ型を使用するには、Salesforce 組織で AWSTextract1000LimitAddOn ライセンスが必要です。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| applicationType | OcrApplicationTypeType (string 型の列挙) | OCR サンプルドキュメントを使用するアプリケーションの種別。 可能な値は次のとおりです。
|
| contentAsset | string | OCR サンプルドキュメントアセットの ID。 この項目が null の場合、OcrSampleDocument は DocumentType を表す抽象ドキュメントです。 |
| documentHeight | double | OCR サンプルドキュメントページの正規化された高さ。 この項目が null の場合、OcrSampleDocument は DocumentType を表す抽象ドキュメントです。 |
| documentType | string | 必須。OCR サンプルドキュメントのデータ型。 |
| masterLabel | string | 必須。OCR サンプルドキュメントのラベル。 |
| ocrSampleDocumentFields | OcrSampleDocumentField[] | 値が抽出されて Salesforce オブジェクトの項目に対応付けられるフォームの項目の詳細。 |
| ocrSampleDocumentPages | OcrSampleDocumentPage[] | OCR サンプルドキュメントのページを定義する項目のコレクション。 |
OcrSampleDocumentField
値が抽出されて Salesforce オブジェクトの項目に対応付けられるフォームの項目の詳細を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| cellColumnNumber | int | この項目の値を保存しているセルがある項目内の列番号。API バージョン 56.0 以降で利用できます。 |
| cellColumnSpanValue | int | この項目の値を保存しているセルがまたがる列数。API バージョン 56.0 以降で利用できます。 |
| cellRowNumber | int | この項目の値を保存しているセルがある項目内の行番号。API バージョン 56.0 以降で利用できます。 |
| cellRowSpanValue | int | この項目の値を保存しているセルがまたがる行数。API バージョン 56.0 以降で利用できます。 |
| fieldLabelMaxX | double | キーの境界ボックスの右端を表す正規化された座標。 |
| fieldLabelMaxY | double | キーの境界ボックスの下端を表す正規化された座標。 |
| fieldLabelMinX | double | キーの境界ボックスの左端を表す正規化された座標。 |
| fieldLabelMinY | double | キーの境界ボックスの上端を表す正規化された座標。 |
| fieldValueName | string | 参照項目の値の名前。API バージョン 56.0 以降で利用できます。 |
| isAutoExtractedValue | boolean | キーが自動的に抽出されているか (true)、否か (false) を示します。API バージョン 57.0 以降で利用できます。 この項目は、自動抽出されたキーと手動抽出されたキーを区別するのに役立ちます。 |
| keyContent | string | フォームの特定の領域にあるコンテンツ。OCR によって抽出された項目を表します。 |
| ocrSampleDocument | string | 必須。顧客フォームから情報を抽出および対応付ける際に、参照として使用される関連する OCR サンプルドキュメント。 |
| ocrSampleDocumentPage | string | キーを含む OCR サンプルドキュメントのページへの参照。 この項目が null の場合、OcrSampleDocument は DocumentType を表す抽象ドキュメントです。 |
| ocrSampleDocumentPageItem | OcrTemplate | この項目の値を含んだサンプルドキュメントページの項目への参照。API バージョン 56.0 以降で利用できます。 |
OcrSampleDocumentPage
OCR サンプルドキュメントのページを定義する項目のコレクションを表します。この型は、OcrSampleDocument が実際のサンプルドキュメントであり、DocumentType を表す抽象的なドキュメントではない場合にのみ存在します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| ocrSampleDocument | string | 必須。顧客フォームから情報を抽出および対応付ける際に、参照として使用される関連する OCR サンプルドキュメン��。 |
| ocrSampleDocumentPageItems | OcrSampleDocument | 関連付けられた OCR サンプルドキュメントページがあるページ項目のコレクション。API バージョン 56.0 以降で利用できます。 |
| pageHeight | double | OCR サンプルドキュメントページの正規化された高さ。 |
| pageNumber | integer | 必須。関連付けられた OCR サンプルドキュメント内のページのページ番号。 |
OcrSampleDocumentPageItem
ページ項目の値を含んだサンプルドキュメントページの項目への外部キー参照を表します。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| hasHeader | boolean | OCR サンプルドキュメントページ項目にヘッダーがあるか (true)、否か (false) を示します。デフォルト値は false です。API バージョン 56.0 以降で利用できます。 |
| sequenceNumber | int | 必須。複数の項目がある OCR サンプルドキュメントページの項目の連番。API バージョン 56.0 以降で利用できます。 |
| title | string | OCR サンプルドキュメントページ項目のタイトル。API バージョン 56.0 以降で利用できます。 |
| type | ItemType (string 型の列挙) | 必須。OCR サンプルドキュメントページ項目の種別を指定します。API バージョン 56.0 以降で利用できます。 有効な値は TABLE です。 |