OcrSampleDocument | メタデータ API 開発者ガイド

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

OcrSampleDocument 型が、実際のサンプルドキュメントを表す必要はありません。また、同じ DocumentType のすべてのドキュメントを表す抽象ドキュメントにすることもできます。その場合、contentAsset と documentHeight 項目は null になります。

ファイルのサフィックスおよびディレクトリの場所

OcrSampleDocument コンポーネントのサフィックスは .ocrSampleDocument で、ocrSampleDocuments フォルダーに保存されます。

バージョン

OcrTemplate コンポーネントは、API バージョン 52.0 以降で使用できます。

特別なアクセスルール

このメタデータ型を使用するには、Salesforce 組織で AWSTextract1000LimitAddOn ライセンスが必要です。

項目

項目名	項目の型	説明
applicationType	OcrApplicationTypeType (string 型の列挙)	OCR サンプルドキュメントを使用するアプリケーションの種別。可能な値は次のとおりです。 `EinsteinDocumentReader` `Industries`
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 オブジェクトの項目に対応付けられるフォームの項目の詳細を表します。

表 1. 項目
項目名	項目の型	説明
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 を表す抽象的なドキュメントではない場合にのみ存在します。

表 2. 項目
項目名	項目の型	説明
ocrSampleDocument	string	必須。顧客フォームから情報を抽出および対応付ける際に、参照として使用される関連する OCR サンプルドキュメント。
ocrSampleDocumentPageItems	OcrSampleDocument	関連付けられた OCR サンプルドキュメントページがあるページ項目のコレクション。API バージョン 56.0 以降で利用できます。
pageHeight	double	OCR サンプルドキュメントページの正規化された高さ。
pageNumber	integer	必須。関連付けられた OCR サンプルドキュメント内のページのページ番号。

OcrSampleDocumentPageItem

ページ項目の値を含んだサンプルドキュメントページの項目への外部キー参照を表します。

表 3. 項目
項目名	項目の型	説明
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` です。

宣言的なメタデータの定義のサンプル

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   ...<cellColumnNumber>1</cellColumnNumber>
9      <cellColumnSpanValue>1</cellColumnSpanValue>
10      <cellRowNumber>1</cellRowNumber>
11      <cellRowSpanValue>1</cellRowSpanValue>
12      <fieldLabelMaxX>0.5975854</fieldLabelMaxX>
13      <fieldLabelMaxY>0.46625894</fieldLabelMaxY>
14      <fieldLabelMinX>0.5065626</fieldLabelMinX>
15      <fieldLabelMinY>0.39605626</fieldLabelMinY>
16      <keyContent>Last Name</keyContent>
17     <ocrSampleDocument>image240</ocrSampleDocument>
18     <ocrSampleDocumentPage>1</ocrSampleDocumentPage>
19     <ocrSampleDocumentPageItem>
20         <hasHeader>false</hasHeader>
21         <sequenceNumber>1</sequenceNumber>
22         <title>Table1</title>
23         <type>TABLE</type>
24     </ocrSampleDocumentPageItem>
25   </ocrSampleDocumentFields>
26   <ocrSampleDocumentPages>
27      <ocrSampleDocument>Form</ocrSampleDocument>
28      <pageHeight>1.0</pageHeight>
29      <pageNumber>1</pageNumber>
30   </ocrSampleDocumentPages>
31   <ocrSampleDocumentPages>
32      <ocrSampleDocument>Form</ocrSampleDocument>
33      <pageNumber>2</pageNumber>
34   </ocrSampleDocumentPages>
35</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>60.0</version>
16</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。