Analyzer - Get Analyze Invoice Result

リファレンス

サービス:: Azure AI Services

API バージョン:: 2.1

進行状況を追跡し、請求書分析操作の結果を取得します。

GET {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyzeResults/{resultId}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus2.api.cognitive.microsoft.com
resultId	path	True	string uuid	操作の結果識別子を分析します。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string

応答

名前	型	説明
200 OK	AnalyzeOperationResult	Success
Other Status Codes	ErrorResponse	エラーに関する追加の詳細を含む、成功していない応答に付随する応答エンティティ。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Get analyze receipt result

要求のサンプル

HTTP

GET {endpoint}/formrecognizer/v2.1/prebuilt/invoice/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

応答のサンプル

状態コード:: 200

{
  "status": "running",
  "createdDateTime": "2019-05-01T10:53:21Z",
  "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
  "analyzeResult": {
    "version": "v2.1",
    "readResults": [],
    "pageResults": [],
    "documentResults": [],
    "errors": []
  }
}

定義

名前	説明
AnalyzeOperationResult	キューに登録された分析操作の状態と結果。
AnalyzeResult	操作の結果を分析します。
Appearance	テキスト行の外観を表すオブジェクト。
DataTable	ページに含まれる抽出されたテーブルに関する情報。
DataTableCell	テーブル内の抽出されたセルに関する情報。
DocumentResult	入力ドキュメントに対応する抽出されたフィールドのセット。
ErrorInformation
ErrorResponse
FieldValue	認識されたフィールド値。
FieldValueType	フィールド値のセマンティックデータ型。
KeyValueElement	キーと値のペアで抽出されたキーまたは値に関する情報。
KeyValuePair	抽出されたキーと値のペアに関する情報。
KeyValueType	キー値要素のセマンティックデータ型。
LengthUnit	width、height、boundingBox プロパティで使用される単位。画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "inch" です。
OperationStatus	キューに登録された操作の状態。
PageResult	1 つのページから情報を抽出しました。
ReadResult	入力ドキュメント内のページから抽出されたテキスト。
SelectionMark	抽出された選択マークに関する情報。
Style	テキスト行のスタイルを表すオブジェクト。
TextLine	抽出されたテキスト行を表すオブジェクト。
TextStyle	手書きやその他を含むテキスト行スタイル名。
TextWord	単語を表すオブジェクト。

AnalyzeOperationResult

キューに登録された分析操作の状態と結果。

名前	型	説明
analyzeResult	AnalyzeResult	分析操作の結果。
createdDateTime	string	分析操作が送信された日時 (UTC)。
lastUpdatedDateTime	string	状態が最後に更新された日時 (UTC)。
status	OperationStatus	操作の状態。

AnalyzeResult

操作の結果を分析します。

名前	型	説明
documentResults	DocumentResult[]	入力から抽出されたドキュメントレベルの情報。
errors	ErrorInformation[]	分析操作中に報告されたエラーの一覧。
pageResults	PageResult[]	入力から抽出されたページレベルの情報。
readResults	ReadResult[]	入力から抽出されたテキスト。
version	string	この結果に使用されるスキーマのバージョン。

Appearance

テキスト行の外観を表すオブジェクト。

名前	型	説明
style	Style	テキスト行のスタイルを表すオブジェクト。

DataTable

ページに含まれる抽出されたテーブルに関する情報。

名前	型	説明
boundingBox	number[]	テーブルの境界ボックス。
cells	DataTableCell[]	テーブルに含まれるセルの一覧。
columns	integer	列の数。
rows	integer	行の数。

DataTableCell

テーブル内の抽出されたセルに関する情報。

名前	型	規定値	説明
boundingBox	number[]		セルの境界ボックス。
columnIndex	integer		セルの列インデックス。
columnSpan	integer	1	このセルがまたがる列の数。
confidence	number		信頼度の値。
elements	string[]		includeTextDetails を true に設定すると、このテーブルセルを構成するテキスト要素への参照の一覧が表示されます。
isFooter	boolean	False	現在のセルはフッターセルですか?
isHeader	boolean	False	現在のセルはヘッダーセルですか?
rowIndex	integer		セルの行インデックス。
rowSpan	integer	1	このセルがまたがる行の数。
text	string		セルのテキストコンテンツ。

DocumentResult

入力ドキュメントに対応する抽出されたフィールドのセット。

名前	型	説明
docType	string	ドキュメントの種類。
docTypeConfidence	number	予測されるドキュメントの種類の信頼度。
fields	<string, FieldValue>	名前付きフィールド値のディクショナリ。
modelId	string	モデル識別子。
pageRange	integer[]	文書が見つかった最初と最後のページ番号。

ErrorInformation

名前	型	説明
code	string
message	string

ErrorResponse

名前	型	説明
error	ErrorInformation

FieldValue

認識されたフィールド値。

名前	型	説明
boundingBox	number[]	必要に応じて、フィールド値の境界ボックス。
confidence	number	信頼度スコア。
elements	string[]	includeTextDetails が true に設定されている場合、このフィールドを構成するテキスト要素への参照の一覧。
page	integer	入力ドキュメント内の 1 から始まるページ番号。
text	string	抽出されたフィールドのテキストコンテンツ。
type	FieldValueType	フィールド値の型。
valueArray	FieldValue[]	フィールド値の配列。
valueCountryRegion	string	3 文字の国コード (ISO 3166-1 alpha-3)。
valueDate	string	日付の値。
valueInteger	integer	整数値。
valueNumber	number	浮動小数点値。
valueObject	<string, FieldValue>	名前付きフィールド値のディクショナリ。
valuePhoneNumber	string	電話番号の値。
valueSelectionMark	enum: selected unselected	選択マークの値。
valueString	string	文字列値。
valueTime	string	時刻値。

FieldValueType

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

名前	型	説明
array	string
countryRegion	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
string	string
time	string

KeyValueElement

キーと値のペアで抽出されたキーまたは値に関する情報。

名前	型	説明
boundingBox	number[]	キーまたは値の境界ボックス。
elements	string[]	includeTextDetails が true に設定されている場合、このキーまたは値を構成するテキスト要素への参照の一覧。
text	string	キーまたは値のテキストコンテンツ。
type	KeyValueType	キー値要素のセマンティックデータ型。

KeyValuePair

抽出されたキーと値のペアに関する情報。

名前	型	説明
confidence	number	信頼度の値。
key	KeyValueElement	キーと値のペアで抽出されたキーに関する情報。
label	string	キー/値ペアエントリのユーザー定義ラベル。
value	KeyValueElement	キーと値のペアで抽出された値に関する情報。

KeyValueType

キー値要素のセマンティックデータ型。

名前	型	説明
selectionMark	string
string	string

LengthUnit

width、height、boundingBox プロパティで使用される単位。画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "inch" です。

名前	型	説明
inch	string
pixel	string

OperationStatus

キューに登録された操作の状態。

名前	型	説明
failed	string
notStarted	string
running	string
succeeded	string

PageResult

1 つのページから情報を抽出しました。

名前	型	説明
clusterId	integer	クラスター識別子。
keyValuePairs	KeyValuePair[]	ページから抽出されたキーと値のペアの一覧。
page	integer	ページ番号。
tables	DataTable[]	ページから抽出されたデータテーブルの一覧。

ReadResult

入力ドキュメント内のページから抽出されたテキスト。

名前	型	説明
angle	number	時計回りの方向のテキストの一般的な向き(-180,180]の間の角度で測定されます。
height	number	画像/PDF の高さ (ピクセル/インチ単位)。
lines	TextLine[]	includeTextDetails が true に設定されている場合、認識されるテキスト行の一覧。返される行の最大数は 1 ページあたり 300 行です。行は上から下、左から右に並べ替えられますが、場合によっては近接性が高い優先順位で処理されます。並べ替え順序は、検出されたテキストによって異なるため、イメージ間で変更され、OCR バージョンが更新される可能性があります。したがって、ビジネスロジックは、順序ではなく実際の行の場所に基づいて構築する必要があります。
page	integer	入力ドキュメント内の 1 から始まるページ番号。
selectionMarks	SelectionMark[]	ページから抽出された選択マークの一覧。
unit	LengthUnit	width、height、boundingBox プロパティで使用される単位。画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "inch" です。
width	number	画像/PDF の幅をピクセル/インチ単位で指定します。

SelectionMark

抽出された選択マークに関する情報。

名前	型	説明
boundingBox	number[]	選択マークの境界ボックス。
confidence	number	信頼度の値。
state	enum: selected unselected	選択マークの状態。

Style

テキスト行のスタイルを表すオブジェクト。

名前	型	説明
confidence	number	テキストの線のスタイルの信頼度。
name	TextStyle	手書きやその他を含むテキスト行スタイル名。

TextLine

抽出されたテキスト行を表すオブジェクト。

名前	型	説明
appearance	Appearance	テキストの外観プロパティ。
boundingBox	number[]	抽出された線の境界ボックス。
text	string	行のテキストコンテンツ。
words	TextWord[]	テキスト行内の単語の一覧。

TextStyle

手書きやその他を含むテキスト行スタイル名。

名前	型	説明
handwriting	string
other	string

TextWord

単語を表すオブジェクト。

名前	型	説明
boundingBox	number[]	抽出された単語の境界ボックス。
confidence	number	信頼度の値。
text	string	単語のテキストコンテンツ。

次の方法で共有