Analyzer - Analyze Id Document

  • リファレンス
サービス:
Azure AI Services
API バージョン:
2.1

特定の ID ドキュメントからフィールド テキストとセマンティック値を抽出します。 入力ドキュメントは、サポートされているコンテンツ タイプ ('application/pdf'、'image/jpeg'、'image/png'、'image/tiff' または 'image/bmp' のいずれか) である必要があります。 または、'application/json' 型を使用して、分析するドキュメントの場所 (Uri) を指定します。

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze
省略可能なパラメーターを含む: 
POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze?includeTextDetails={includeTextDetails}&pages={pages}

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus2.api.cognitive.microsoft.com
includeTextDetails
 query

boolean

結果にテキスト行と要素参照を含めます。
pages
 query

string[]

複数ページのドキュメントのカスタム ページ番号 (PDF/TIFF)、OCR 結果を取得するページの数を入力します。 ページの範囲には、ハイフンを使用します。 各ページまたは範囲をコンマで区切ります。

要求ヘッダー

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

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

string

要求本文

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

名前 型 説明
source

string

ファイル ソース のパス。

応答

名前 型 説明
202 Accepted

要求は正常にキューに入れられます。

ヘッダー

Operation-Location: string
Other Status Codes

ErrorResponse

エラーに関する追加の詳細を含む、成功していない応答に付随する応答エンティティ。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Analyze ID

要求のサンプル

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze

応答のサンプル

状態コード:
202 
Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

定義

名前 説明
ErrorInformation
ErrorResponse
SourcePath

ソース データへの URI またはローカル パス。

ErrorInformation

名前 型 説明
code

string

message

string

ErrorResponse

名前 型 説明
error

ErrorInformation

SourcePath

ソース データへの URI またはローカル パス。

名前 型 説明
source

string

ファイル ソース のパス。