Document Classifiers - Get Classify Result

リファレンス

サービス:: Azure AI Services

API バージョン:: 2024-07-31-preview

ドキュメント分類子の結果を取得します。

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-07-31-preview

URI パラメーター

名前	/	必須	型	説明
classifierId	path	True	string	一意のドキュメント分類子名。正規表現パターン: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
endpoint	path	True	string uri	ドキュメントインテリジェンスサービスエンドポイント。
resultId	path	True	string uuid	分析操作の結果 ID。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	AnalyzeResultOperation	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Get Classify Document Result

要求のサンプル

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview

応答のサンプル

状態コード:: 200

{
  "status": "succeeded",
  "createdDateTime": "2021-09-24T13:00:46Z",
  "lastUpdatedDateTime": "2021-09-24T13:00:49Z",
  "analyzeResult": {
    "apiVersion": "2024-07-31-preview",
    "modelId": "myClassifier",
    "stringIndexType": "textElements",
    "contentFormat": "text",
    "content": "",
    "pages": [
      {
        "pageNumber": 1,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 2,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 3,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      }
    ],
    "documents": [
      {
        "docType": "formA",
        "boundingRegions": [
          {
            "pageNumber": 1,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          },
          {
            "pageNumber": 2,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      },
      {
        "docType": "formB",
        "boundingRegions": [
          {
            "pageNumber": 3,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      }
    ]
  }
}

定義

名前	説明
AddressValue	アドレスフィールドの値。
AnalyzeResult	ドキュメント分析結果。
AnalyzeResultOperation	分析操作の状態と結果。
BoundingRegion	入力の特定のページでの多角形の境界。
ContentFormat	分析された結果のコンテンツの形式。
CurrencyValue	通貨フィールドの値。
Document	ドキュメントの場所とセマンティックコンテンツを記述するオブジェクト。
DocumentBarcode	バーコードオブジェクト。
DocumentBarcodeKind	バーコードの種類。
DocumentCaption	テーブルまたは図を記述するキャプションオブジェクト。
DocumentField	フィールド値の内容と位置を表すオブジェクト。
DocumentFieldType	フィールド値のセマンティックデータ型。
DocumentFigure	文書内の図形を表すオブジェクト。
DocumentFootnote	表または図を記述する脚注オブジェクト。
DocumentFormula	数式オブジェクト。
DocumentFormulaKind	数式の種類。
DocumentKeyValueElement	キーと値のペアのフィールドキーまたは値を表すオブジェクト。
DocumentKeyValuePair	個別のフィールドラベル (キー) とフィールド値 (空の場合があります) を持つフォームフィールドを表すオブジェクト。
DocumentLanguage	特定のテキストスパンで検出された言語を表すオブジェクト。
DocumentLine	単語や選択マークなどのコンテンツ要素の隣接するシーケンスで構成されるコンテンツ行オブジェクト。
DocumentPage	入力からページから抽出されたコンテンツ要素とレイアウト要素。
DocumentParagraph	一般的に、一般的な配置と間隔を持つ連続した行で構成される段落オブジェクト。
DocumentSection	ドキュメント内のセクションを表すオブジェクト。
DocumentSelectionMark	チェックボックス、ラジオボタン、および選択範囲を示すその他の要素を表す選択マークオブジェクト。
DocumentSelectionMarkState	選択マークの状態。
DocumentSignatureType	署名の存在。
DocumentSpan	オフセットと長さとして指定された、連結されたコンテンツプロパティの連続した領域。
DocumentStyle	観察されたテキストスタイルを表すオブジェクト。
DocumentTable	四角形のレイアウトに配置されたテーブルセルで構成されるテーブルオブジェクト。
DocumentTableCell	テーブルセルの場所と内容を表すオブジェクト。
DocumentTableCellKind	[テーブル] セルの種類。
DocumentWord	連続する文字シーケンスで構成される単語オブジェクト。中国語、日本語、韓国語などのスペース区切り以外の言語の場合、各文字は独自の単語として表されます。
Error	エラーオブジェクト。
ErrorResponse	エラー応答オブジェクト。
FontStyle	フォントスタイル。
FontWeight	フォントの太さ。
InnerError	エラーに関するより具体的な情報を含むオブジェクト。
LengthUnit	幅、高さ、および多角形のプロパティで使用される単位。画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "inch" です。
OperationStatus	操作の状態。
ParagraphRole	段落のセマンティックロール。
StringIndexType	文字列のオフセットと長さを計算するために使用されるメソッド。
Warning	エラーオブジェクト。

AddressValue

アドレスフィールドの値。

名前	型	説明
city	string	都市、町、村などの名前。
cityDistrict	string	ニューヨーク市のブルックリンやロンドンのウェストミンスター市など、都市内の地区または自治区。
countryRegion	string	国/地域。
house	string	ビルド名 (ワールドトレードセンターなど)。
houseNumber	string	住宅番号または建物番号。
level	string	フロア番号 (3F など)。
poBox	string	オフィスボックス番号を転記します。
postalCode	string	メールの並べ替えに使用する郵便番号。
road	string	番地。
state	string	第 1 レベルの管理部門。
stateDistrict	string	特定のロケールで使用される第 2 レベルの管理部門。
streetAddress	string	市区町村、都道府県、国番号、郵便番号を除く、番地レベルの住所。
suburb	string	中華街のような非公式の近所の名前。
unit	string	アパートまたはオフィス番号

AnalyzeResult

ドキュメント分析結果。

名前	型	説明
apiVersion	string	この結果を生成するために使用される API バージョン。
content	string	すべてのテキスト要素とビジュアル要素の文字列表現を読み取り順に連結します。
contentFormat	ContentFormat	分析結果の最上位コンテンツの形式。
documents	Document[]	抽出されたドキュメント。
figures	DocumentFigure[]	抽出された図。
keyValuePairs	DocumentKeyValuePair[]	抽出されたキーと値のペア。
languages	DocumentLanguage[]	検出された言語。
modelId	string	この結果を生成するために使用されるドキュメントモデル ID。
pages	DocumentPage[]	分析されたページ。
paragraphs	DocumentParagraph[]	抽出された段落。
sections	DocumentSection[]	抽出されたセクション。
stringIndexType	StringIndexType	文字列のオフセットと長さを計算するために使用されるメソッド。
styles	DocumentStyle[]	抽出されたフォントスタイル。
tables	DocumentTable[]	抽出されたテーブル。
warnings	Warning[]	発生した警告の一覧。

AnalyzeResultOperation

分析操作の状態と結果。

名前	型	説明
analyzeResult	AnalyzeResult	ドキュメント分析結果。
createdDateTime	string	分析操作が送信された日時 (UTC)。
error	Error	ドキュメント分析中にエラーが発生しました。
lastUpdatedDateTime	string	状態が最後に更新された日時 (UTC)。
status	OperationStatus	操作の状態。 notStarted、running、succeeded、または failed

BoundingRegion

入力の特定のページでの多角形の境界。

名前	型	説明
pageNumber	integer	境界領域を含む 1 から始まるページ番号。
polygon	number[]	ページ上の多角形の境界、または指定されていない場合はページ全体。ページの左上を基準にして指定された座標。この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。

ContentFormat

分析された結果のコンテンツの形式。

名前	型	説明
markdown	string	セクション見出し、テーブルなどを含むドキュメントコンテンツのマークダウン表現。
text	string	書式を設定せずにドキュメントコンテンツをプレーンテキストで表現します。

CurrencyValue

通貨フィールドの値。

名前	型	説明
amount	number	通貨金額。
currencyCode	string	解決済みの通貨コード (ISO 4217) がある場合。
currencySymbol	string	通貨記号ラベル (存在する場合)。

Document

ドキュメントの場所とセマンティックコンテンツを記述するオブジェクト。

名前	型	説明
boundingRegions	BoundingRegion[]	ドキュメントをカバーする境界領域。
confidence	number	ドキュメントを正しく抽出する信頼度。
docType	string	ドキュメントの種類。
fields	<string, DocumentField>	名前付きフィールド値のディクショナリ。
spans	DocumentSpan[]	読み取り順序で連結されたコンテンツ内のドキュメントの場所。

DocumentBarcode

バーコードオブジェクト。

名前	型	説明
confidence	number	バーコードを正しく抽出する信頼度。
kind	DocumentBarcodeKind	バーコードの種類。
polygon	number[]	バーコードの境界ポリゴン。ページの左上を基準に座標を指定します。この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
span	DocumentSpan	読み取り順序で連結されたコンテンツ内のバーコードの場所。
value	string	バーコード値。

DocumentBarcodeKind

バーコードの種類。

名前	型	説明
Aztec	string	ISO/IEC 24778:2008 で定義されている Aztec コード。
Codabar	string	ANSI/AIM BC3-1995 で定義されている Codabar バーコード。
Code128	string	ISO/IEC 15417:2007 で定義されているコード 128 バーコード。
Code39	string	ISO/IEC 16388:2007 で定義されているコード 39 バーコード。
Code93	string	ANSI/AIM BC5-1995 で定義されているコード 93 バーコード。
DataBar	string	GS1 DataBar バーコード。
DataBarExpanded	string	GS1 DataBar 拡張バーコード。
DataMatrix	string	ISO/IEC 16022:2006 で定義されているデータマトリックスコード。
EAN13	string	GS1 13 桁の国際商品番号 (ヨーロッパの記事番号)。
EAN8	string	GS1 8 桁の国際商品番号 (ヨーロッパの記事番号)。
ITF	string	ANSI/AIM BC2-1995 で定義されている 5 バーコードのインターリーブ 2。
MaxiCode	string	ISO/IEC 16023:2000 で定義されている MaxiCode。
MicroQRCode	string	ISO/IEC 23941:2022 で定義されているマイクロ QR コード。
PDF417	string	ISO 15438 で定義されている PDF417。
QRCode	string	ISO/IEC 18004:2015 で定義されている QR コード。
UPCA	string	GS1 12 桁のユニバーサル製品コード。
UPCE	string	GS1 6 桁のユニバーサル製品コード。

DocumentCaption

テーブルまたは図を記述するキャプションオブジェクト。

名前	型	説明
boundingRegions	BoundingRegion[]	キャプションをカバーする境界領域。
content	string	キャプションの内容。
elements	string[]	キャプションの子要素。
spans	DocumentSpan[]	読み取り順序で連結されたコンテンツ内のキャプションの場所。

DocumentField

フィールド値の内容と位置を表すオブジェクト。

名前	型	説明
boundingRegions	BoundingRegion[]	フィールドをカバーする境界領域。
confidence	number	フィールドを正しく抽出する信頼度。
content	string	フィールドの内容。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内のフィールドの場所。
type	DocumentFieldType	フィールド値のデータ型。
valueAddress	AddressValue	アドレス値。
valueArray	DocumentField[]	フィールド値の配列。
valueBoolean	boolean	ブール値。
valueCountryRegion	string	3 文字の国コード値 (ISO 3166-1 alpha-3)。
valueCurrency	CurrencyValue	通貨値。
valueDate	string	YYYY-MM-DD 形式の日付値 (ISO 8601)。
valueInteger	integer	整数値。
valueNumber	number	浮動小数点値。
valueObject	<string, DocumentField>	名前付きフィールド値のディクショナリ。
valuePhoneNumber	string	E.164 形式の電話番号の値 (例: +19876543210)。
valueSelectionGroup	string[]	選択グループの値。
valueSelectionMark	DocumentSelectionMarkState	選択マークの値。
valueSignature	DocumentSignatureType	署名の存在。
valueString	string	文字列値。
valueTime	string	hh:mm:ss 形式の時刻値 (ISO 8601)。

DocumentFieldType

フィールド値のセマンティックデータ型。

名前	型	説明
address	string	解析されたアドレス。
array	string	同じ型のサブフィールドの一覧。
boolean	string	true または false に正規化されたブール値。
countryRegion	string	ISO 3166-1 alpha-3 形式 (米国など) に正規化された国/地域。
currency	string	オプションの通貨記号と単位を含む通貨金額。
date	string	ISO 8601 (YYYY-MM-DD) 形式に正規化された日付。
integer	string	64 ビット符号付き整数に正規化された整数。
number	string	倍精度浮動小数点に正規化された浮動小数点数。
object	string	潜在的に異なる型のサブフィールドの名前付きリスト。
phoneNumber	string	E.164 (+{CountryCode}{SubscriberNumber}) 形式に正規化された電話番号。
selectionGroup	string	選択した文字列値の配列。
selectionMark	string	フィールドは選択されていますか?
signature	string	署名は存在しますか?
string	string	プレーンテキスト。
time	string	ISO 8601 (hh:mm:ss) 形式に正規化された時間。

DocumentFigure

文書内の図形を表すオブジェクト。

名前	型	説明
boundingRegions	BoundingRegion[]	図をカバーする境界領域。
caption	DocumentCaption	図に関連付けられているキャプション。
elements	string[]	図表番号または脚注を除く、図の子要素。
footnotes	DocumentFootnote[]	図に関連付けられている脚注の一覧。
id	string	図 ID。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内の図の位置。

DocumentFootnote

表または図を記述する脚注オブジェクト。

名前	型	説明
boundingRegions	BoundingRegion[]	脚注をカバーする境界領域。
content	string	脚注の内容。
elements	string[]	脚注の子要素。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内の脚注の場所。

DocumentFormula

数式オブジェクト。

名前	型	説明
confidence	number	数式を正しく抽出する信頼度。
kind	DocumentFormulaKind	数式の種類。
polygon	number[]	ページの左上を基準にして座標を指定した数式の境界ポリゴン。この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
span	DocumentSpan	読み取り順序の連結されたコンテンツ内の数式の場所。
value	string	式を記述する LaTex 式。

DocumentFormulaKind

数式の種類。

名前	型	説明
display	string	行全体を占有する表示モードの数式。
inline	string	段落のコンテンツ内に埋め込まれた数式。

DocumentKeyValueElement

キーと値のペアのフィールドキーまたは値を表すオブジェクト。

名前	型	説明
boundingRegions	BoundingRegion[]	キーと値の要素をカバーする境界領域。
content	string	読み取り順序でキーと値の要素の連結されたコンテンツ。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内のキーと値の要素の場所。

DocumentKeyValuePair

個別のフィールドラベル (キー) とフィールド値 (空の場合があります) を持つフォームフィールドを表すオブジェクト。

名前	型	説明
confidence	number	キーと値のペアを正しく抽出する信頼度。
key	DocumentKeyValueElement	キーと値のペアのフィールドラベル。
value	DocumentKeyValueElement	キーと値のペアのフィールド値。

DocumentLanguage

特定のテキストスパンで検出された言語を表すオブジェクト。

名前	型	説明
confidence	number	言語を正しく識別する信頼度。
locale	string	検出された言語。値には、ISO 639-1 言語コード (例: "en"、"fr") または BCP 47 言語タグ (例: "zh-Hans") を指定できます。
spans	DocumentSpan[]	言語が適用される連結コンテンツ内のテキスト要素の場所。

DocumentLine

単語や選択マークなどのコンテンツ要素の隣接するシーケンスで構成されるコンテンツ行オブジェクト。

名前	型	説明
content	string	読み取り順序で含まれる要素の連結されたコンテンツ。
polygon	number[]	ページの左上を基準に座標を指定した、線の境界ポリゴン。この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内の行の場所。

DocumentPage

入力からページから抽出されたコンテンツ要素とレイアウト要素。

名前	型	説明
angle	number	時計回りの方向のコンテンツの一般的な向き。(-180, 180] の間の度数で測定されます。
barcodes	DocumentBarcode[]	ページから抽出されたバーコード。
formulas	DocumentFormula[]	ページから抽出された数式。
height	number	画像/PDF の高さ (ピクセル/インチ単位)。
lines	DocumentLine[]	ページから抽出された行。テキスト要素とビジュアル要素の両方を含む可能性があります。
pageNumber	integer	入力ドキュメント内の 1 から始まるページ番号。
selectionMarks	DocumentSelectionMark[]	ページから抽出された選択マーク。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内のページの場所。
unit	LengthUnit	幅、高さ、および多角形のプロパティで使用される単位。画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "inch" です。
width	number	イメージ/PDF の幅 (ピクセル/インチ単位)。
words	DocumentWord[]	ページから抽出された単語。

DocumentParagraph

一般的に、一般的な配置と間隔を持つ連続した行で構成される段落オブジェクト。

名前	型	説明
boundingRegions	BoundingRegion[]	段落をカバーする境界領域。
content	string	読み取り順に段落の連結されたコンテンツ。
role	ParagraphRole	段落のセマンティックロール。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内の段落の場所。

DocumentSection

ドキュメント内のセクションを表すオブジェクト。

名前	型	説明
elements	string[]	セクションの子要素。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内のセクションの場所。

DocumentSelectionMark

チェックボックス、ラジオボタン、および選択範囲を示すその他の要素を表す選択マークオブジェクト。

名前	型	説明
confidence	number	選択マークを正しく抽出する信頼度。
polygon	number[]	選択マークの境界ポリゴン。ページの左上を基準に座標を指定します。この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
span	DocumentSpan	読み取り順序の連結されたコンテンツ内の選択マークの位置。
state	DocumentSelectionMarkState	選択マークの状態。

DocumentSelectionMarkState

選択マークの状態。

名前	型	説明
selected	string	選択マークが選択され、多くの場合、選択マーク内のチェック ✓ またはクロス X で示されます。
unselected	string	選択マークは選択されていません。

DocumentSignatureType

署名の存在。

名前	型	説明
signed	string	署名が検出されました。
unsigned	string	署名は検出されません。

DocumentSpan

オフセットと長さとして指定された、連結されたコンテンツプロパティの連続した領域。

名前	型	説明
length	integer	スパンで表されるコンテンツ内の文字数。
offset	integer	スパンで表されるコンテンツの 0 から始まるインデックス。

DocumentStyle

観察されたテキストスタイルを表すオブジェクト。

名前	型	説明
backgroundColor	string	背景色 #rrggbb 16 進数の形式で表示されます。.
color	string	前景色 (#rrggbb 16 進形式)。
confidence	number	スタイルを正しく識別する信頼度。
fontStyle	FontStyle	フォントスタイル。
fontWeight	FontWeight	フォントの太さ。
isHandwritten	boolean	コンテンツは手書きですか?
similarFontFamily	string	サポートされている一連のフォントファミリの中から視覚的に最も似たフォントで、CSS 規則 (例: "Arial, sans-serif") に従ってフォールバックフォントを使用します。
spans	DocumentSpan[]	スタイルが適用される連結コンテンツ内のテキスト要素の場所。

DocumentTable

四角形のレイアウトに配置されたテーブルセルで構成されるテーブルオブジェクト。

名前	型	説明
boundingRegions	BoundingRegion[]	テーブルをカバーする境界領域。
caption	DocumentCaption	テーブルに関連付けられているキャプション。
cells	DocumentTableCell[]	テーブル内に含まれるセル。
columnCount	integer	テーブル内の列の数。
footnotes	DocumentFootnote[]	テーブルに関連付けられている脚注の一覧。
rowCount	integer	テーブル内の行数。
spans	DocumentSpan[]	読み取り順序の連結されたコンテンツ内のテーブルの場所。

DocumentTableCell

テーブルセルの場所と内容を表すオブジェクト。

名前	型	規定値	説明
boundingRegions	BoundingRegion[]		テーブルセルをカバーする境界領域。
columnIndex	integer		セルの列インデックス。
columnSpan	integer	1	このセルがまたがる列の数。
content	string		表のセルの内容を読み取り順に連結しました。
elements	string[]		テーブルセルの子要素。
kind	DocumentTableCellKind	content	[テーブル] セルの種類。
rowIndex	integer		セルの行インデックス。
rowSpan	integer	1	このセルがまたがる行の数。
spans	DocumentSpan[]		読み取り順序の連結されたコンテンツ内のテーブルセルの場所。

DocumentTableCellKind

[テーブル] セルの種類。

名前	型	説明
columnHeader	string	列の内容について説明します。
content	string	メインのコンテンツ/データを格納します。
description	string	テーブル内の (一部の) コンテンツについて説明します。
rowHeader	string	行の内容について説明します。
stubHead	string	通常、テーブルの左上隅にある行ヘッダーについて説明します。

DocumentWord

連続する文字シーケンスで構成される単語オブジェクト。中国語、日本語、韓国語などのスペース区切り以外の言語の場合、各文字は独自の単語として表されます。

名前	型	説明
confidence	number	単語を正しく抽出する信頼度。
content	string	単語のテキストコンテンツ。
polygon	number[]	ページの左上を基準にして座標を指定した、単語の境界ポリゴン。この数値は、要素の向きを基準にして、左から時計回りに (-180 度を含む) 多角形の頂点の x、y 値を表します。
span	DocumentSpan	読み取り順序で連結されたコンテンツ内の単語の場所。

Error

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

ErrorResponse

エラー応答オブジェクト。

名前	型	説明
error	Error	エラー情報。

FontStyle

フォントスタイル。

名前	型	説明
italic	string	文字は視覚的に右に斜め表示されます。
normal	string	文字は通常どおりに表されます。

FontWeight

フォントの太さ。

名前	型	説明
bold	string	文字は太いストロークで表されます。
normal	string	文字は通常どおりに表されます。

InnerError

エラーに関するより具体的な情報を含むオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
innererror	InnerError	内部エラー。
message	string	エラーの人間が判読できる表現。

LengthUnit

幅、高さ、および多角形のプロパティで使用される単位。画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "inch" です。

名前	型	説明
inch	string	PDF ファイルの長さ単位。
pixel	string	イメージファイルの長さ単位。

OperationStatus

操作の状態。

名前	型	説明
canceled	string	操作が取り消されました。
completed	string	操作が完了しました。
failed	string	操作が失敗しました。
notStarted	string	操作はまだ開始されていません。
running	string	操作が進行中です。
succeeded	string	操作は成功しました。

ParagraphRole

段落のセマンティックロール。

名前	型	説明
footnote	string	通常、ノートはページのメインコンテンツの後に配置されます。
formulaBlock	string	多くの場合、共通の配置を持つ数式のブロック。
pageFooter	string	ページの下端付近のテキスト。
pageHeader	string	ページの上端付近のテキスト。
pageNumber	string	ページ番号。
sectionHeading	string	ドキュメントのセクションを説明するサブ見出し。
title	string	ドキュメント全体を説明する最上位レベルのタイトル。

StringIndexType

文字列のオフセットと長さを計算するために使用されるメソッド。

名前	型	説明
textElements	string	Unicode 8.0.0 で定義されている、ユーザーが認識する表示文字 (grapheme クラスター)。
unicodeCodePoint	string	1 つの Unicode コードポイントで表される文字単位。 Python 3 で使用されます。
utf16CodeUnit	string	16 ビット Unicode コード単位で表される文字単位。 JavaScript、Java、および .NET によって使用されます。

Warning