OcrSampleDocument
顧客のフォームの情報を抽出する場合や対応付ける場合に、参照情報として使用するサンプルのドキュメントまたは文書型の詳細を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
OcrSampleDocument 型が、実際のサンプルドキュメントを表す必要はありません。また、同じ DocumentType のすべてのドキュメントを表す抽象ドキュメントにすることもできます。その場合、contentAsset と documentHeight 項目は null になります。
ファイルのサフィックスおよびディレクトリの場所
OcrSampleDocument コンポーネントのサフィックスは .ocrSampleDocument で、ocrSampleDocuments フォルダに保存されます。
バージョン
OcrTemplate コンポーネントは、API バージョン 52.0 以降で使用できます。
特別なアクセスルール
このメタデータ型を使用するには、Salesforce 組織で AWSTextract1000LimitAddOn ライセンスが必要です。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| contentAsset | string | OCR サンプルドキュメントアセットの ID。 |
| documentHeight | double | OCR サンプルドキュメントページの正規化された高さ。 |
| documentType | string | 必須。OCR サンプルドキュメントのデータ型。 |
| masterLabel | string | 必須。OCR サンプルドキュメントのラベル。 |
| ocrSampleDocumentFields | OcrSampleDocumentField[] | 値が抽出されて Salesforce オブジェクトの項目に対応付けられるフォームの項目の詳細。 |
| ocrSampleDocumentPages | OcrSampleDocumentPage[] | OCR サンプルドキュメントのページを定義する項目のコレクション。 |
値が抽出されて Salesforce オブジェクトの項目に対応付けられるフォームの項目の詳細を表します。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| fieldLabelMaxX | double | キーの境界ボックスの右端を表す正規化された座標。 |
| fieldLabelMaxY | double | キーの境界ボックスの下端を表す正規化された座標。 |
| fieldLabelMinX | double | キーの境界ボックスの左端を表す正規化された座標。 |
| fieldLabelMinY | double | キーの境界ボックスの上端を表す正規化された座標。 |
| keyContent | string | 必須。フォームの特定の領域にあるコンテンツ。OCR によって抽出された項目を表します。 |
| ocrSampleDocument | string | 必須。顧客フォームから情報を抽出および対応付ける際に、参照として使用される関連する OCR サンプルドキュメント。 |
| ocrSampleDocumentPage | string | キーを含む OCR サンプルドキュメントのページへの参照。 |
OCR サンプルドキュメントのページを定義する項目のコレクションを表します。この型は、OcrSampleDocument が実際のサンプルドキュメントであり、DocumentType を表す抽象的なドキュメントではない場合にのみ存在します。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| ocrSampleDocument | string | 必須。顧客フォームから情報を抽出および対応付ける際に、参照として使用される関連する OCR サンプルドキュメント。 |
| pageHeight | double | OCR サンプルドキュメントページの正規化された高さ。 |
| pageNumber | integer | 必須。関連付けられた OCR サンプルドキュメント内のページのページ番号。 |
宣言的なメタデータの定義のサンプル
OcrSampleDocument コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<OcrSampleDocument xmlns="http://soap.sforce.com/2006/04/metadata">
3 <contentAsset>asset_01jpeg</contentAsset>
4 <documentHeight>1.24</documentHeight>
5 <documentType>Form</documentType>
6 <masterLabel>Form</masterLabel>
7 <ocrSampleDocumentFields>
8 <fieldLabelMaxX>0.8</fieldLabelMaxX>
9 <fieldLabelMaxY>0.9</fieldLabelMaxY>
10 <fieldLabelMinX>0.7</fieldLabelMinX>
11 <fieldLabelMinY>0.5</fieldLabelMinY>
12 <keyContent>T</keyContent>
13 <ocrSampleDocument>Form</ocrSampleDocument>
14 <ocrSampleDocumentPage>1</ocrSampleDocumentPage>
15 </ocrSampleDocumentFields>
16 <ocrSampleDocumentFields>
17 <keyContent>Test_</keyContent>
18 <ocrSampleDocument>Form</ocrSampleDocument>
19 <ocrSampleDocumentPage>1</ocrSampleDocumentPage>
20 </ocrSampleDocumentFields>
21 <ocrSampleDocumentPages>
22 <ocrSampleDocument>Form</ocrSampleDocument>
23 <pageHeight>1.0</pageHeight>
24 <pageNumber>1</pageNumber>
25 </ocrSampleDocumentPages>
26 <ocrSampleDocumentPages>
27 <ocrSampleDocument>Form</ocrSampleDocument>
28 <pageNumber>2</pageNumber>
29 </ocrSampleDocumentPages>
30</OcrSampleDocument>前の定義を参照する package.xml の例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>*</members>
5 <name>DocumentType</name>
6 </types>
7 <types>
8 <members>*</members>
9 <name>ContentAsset</name>
10 </types>
11 <types>
12 <members>*</members>
13 <name>OcrSampleDocument</name>
14 </types>
15 <version>52.0</version>
16</Package>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。