Document Models - Analyze Document From Stream

サービス:

Azure AI Services

API バージョン:

2024-07-31-preview

ドキュメント モデルを使用してドキュメントを分析します。

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-07-31-preview

省略可能なパラメーターを含む:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-07-31-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}&output={output}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string uri	ドキュメント インテリジェンス サービス エンドポイント。
modelId	path	True	string	一意のドキュメント モデル名。 正規表現パターン: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	この操作に使用する API バージョン。
features	query		DocumentAnalysisFeature[]	オプションの分析機能の一覧。
locale	query		string	テキスト認識とドキュメント分析のロケール ヒント。 値には、言語コード (例: "en"、"fr") または BCP 47 言語タグ (例: "en-US") のみを含むことができます。
output	query		AnalyzeOutputOption[]	分析中に生成する追加の出力。
outputContentFormat	query		ContentFormat	分析結果の最上位コンテンツの形式。
pages	query		string	分析する 1 から始まるページ番号の一覧。 旧。 "1-3,5,7-9" 正規表現パターン: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	抽出する追加フィールドの一覧。 旧。 "NumberOfGuests,StoreNumber"
stringIndexType	query		StringIndexType	文字列のオフセットと長さを計算するために使用されるメソッド。

要求本文

Media Types: "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

名前	型	説明
input	string	入力コンテンツ。

応答

名前	型	説明
202 Accepted		要求は処理のために受け入れ済みですが、処理はまだ完了していません。 ヘッダー Operation-Location: string Retry-After: integer
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

例

Analyze Document from Url

要求のサンプル

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?api-version=2024-07-31-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

"{binaryFile}"

応答のサンプル

状態コード:

202

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

定義

名前	説明
AnalyzeOutputOption	分析中に生成する追加の出力。
ContentFormat	分析された結果のコンテンツの形式。
DocumentAnalysisFeature	有効にするドキュメント分析機能。
Error	エラー オブジェクト。
ErrorResponse	エラー応答オブジェクト。
InnerError	エラーに関するより具体的な情報を含むオブジェクト。
StringIndexType	文字列のオフセットと長さを計算するために使用されるメソッド。

AnalyzeOutputOption

分析中に生成する追加の出力。

名前	型	説明
figures	string	検出された図のトリミングされた画像を生成します。
pdf	string	検索可能な PDF 出力を生成します。

ContentFormat

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

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

DocumentAnalysisFeature

有効にするドキュメント分析機能。

名前	型	説明
barcodes	string	ドキュメント内のバーコードの検出を有効にします。
formulas	string	ドキュメント内の数式の検出を有効にします。
keyValuePairs	string	ドキュメント内の一般的なキー値ペア (フォーム フィールド) の検出を有効にします。
languages	string	テキスト コンテンツ言語の検出を有効にします。
ocrHighResolution	string	より高い解像度で OCR を実行して、細かい印刷でドキュメントを処理します。
queryFields	string	queryFields クエリ パラメーターを使用して、追加のフィールドの抽出を有効にします。
styleFont	string	さまざまなフォント スタイルの認識を有効にします。

Error

エラー オブジェクト。

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

ErrorResponse

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

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

InnerError

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

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

StringIndexType

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

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