Miscellaneous Operations - Get Operation

サービス:

Azure AI Services

API バージョン:

2024-07-31-preview

操作情報を取得します。

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getOperation&api-version=2024-07-31-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string uri	ドキュメント インテリジェンス サービス エンドポイント。
operationId	path	True	string	操作 ID
api-version	query	True	string	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string uuid	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

応答

名前	型	説明
200 OK	OperationDetails: DocumentClassifierBuildOperationDetails DocumentClassifierCopyToOperationDetails DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	要求は成功しました。 ヘッダー x-ms-client-request-id: string
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 Operation

要求のサンプル

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getOperation&api-version=2024-07-31-preview

応答のサンプル

状態コード:

200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2024-07-31-preview"
  }
}

定義

名前	説明
AzureBlobContentSource	Azure Blob Storage のコンテンツ。
AzureBlobFileListContentSource	Azure Blob Storage のファイルの一覧。
ClassifierDocumentTypeDetails	分類子ドキュメントの種類の情報。
ContentSourceKind	コンテンツ ソースの種類。
DocumentAnalysisFeature	有効にするドキュメント分析機能。
DocumentBuildMode	カスタム ドキュメント モデルのビルド モード。
DocumentClassifierBuildOperationDetails	操作応答オブジェクトを取得します。
DocumentClassifierCopyToOperationDetails	操作応答オブジェクトを取得します。
DocumentClassifierDetails	分類子情報をドキュメント化します。
DocumentFieldSchema	JSON スキーマ スタイル構文を使用したフィールド セマンティック スキーマの説明。
DocumentFieldType	フィールド値のセマンティック データ型。
DocumentModelBuildOperationDetails	操作応答オブジェクトを取得します。
DocumentModelComposeOperationDetails	操作応答オブジェクトを取得します。
DocumentModelCopyToOperationDetails	操作応答オブジェクトを取得します。
DocumentModelDetails	ドキュメント モデル情報。
DocumentTypeDetails	ドキュメントの種類の情報。
Error	エラー オブジェクト。
ErrorResponse	エラー応答オブジェクト。
InnerError	エラーに関するより具体的な情報を含むオブジェクト。
OperationKind	操作の種類。
OperationStatus	操作の状態。
SplitMode	ファイル分割の動作。
Warning	エラー オブジェクト。

AzureBlobContentSource

Azure Blob Storage のコンテンツ。

名前	型	説明
containerUrl	string	Azure Blob Storage コンテナーの URL。
prefix	string	BLOB 名プレフィックス。

AzureBlobFileListContentSource

Azure Blob Storage のファイルの一覧。

名前	型	説明
containerUrl	string	Azure Blob Storage コンテナーの URL。
fileList	string	ドキュメントのサブセットを指定するコンテナー内の JSONL ファイルへのパス。

ClassifierDocumentTypeDetails

分類子ドキュメントの種類の情報。

名前	型	説明
azureBlobFileListSource	AzureBlobFileListContentSource	分類子ドキュメントの種類のトレーニング データを指定する Azure Blob Storage ファイルの一覧。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
azureBlobSource	AzureBlobContentSource	分類子ドキュメントの種類のトレーニング データを含む Azure Blob Storage の場所。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
sourceKind	ContentSourceKind	トレーニング データ ソースの種類。

ContentSourceKind

コンテンツ ソースの種類。

名前	型	説明
azureBlob	string	Azure Blob Storage コンテナー内のパス内のファイル。
azureBlobFileList	string	Azure Blob Storage コンテナー内の個々のファイルを指定するファイルの一覧。
base64	string	Base64 エンコードによって表されるコンテンツ。
url	string	特定の URL のコンテンツ。

DocumentAnalysisFeature

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

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

DocumentBuildMode

カスタム ドキュメント モデルのビルド モード。

名前	型	説明
generative	string	生成 AI 手法を使用して、すべての種類のドキュメントを有効にします。
neural	string	多様なビジュアル テンプレートを使用してドキュメントをサポートします。
template	string	類似のビジュアル テンプレートを使用してドキュメントをターゲットに設定します。

DocumentClassifierBuildOperationDetails

操作応答オブジェクトを取得します。

名前	型	説明
apiVersion	string	この操作の作成に使用される API バージョン。
createdDateTime	string	操作が作成された日時 (UTC)。
error	Error	エラーが発生しました。
kind	string: documentClassifierBuild	操作の種類。
lastUpdatedDateTime	string	状態が最後に更新された日時 (UTC)。
operationId	string	操作 ID
percentCompleted	integer	操作の進行状況 (0 から 100)。
resourceLocation	string	この操作の対象となるリソースの URL。
result	DocumentClassifierDetails	成功した場合の操作の結果。
status	OperationStatus	操作の状態。 notStarted、running、completed、または failed
tags	object	ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。

DocumentClassifierCopyToOperationDetails

操作応答オブジェクトを取得します。

名前	型	説明
apiVersion	string	この操作の作成に使用される API バージョン。
createdDateTime	string	操作が作成された日時 (UTC)。
error	Error	エラーが発生しました。
kind	string: documentClassifierCopyTo	操作の種類。
lastUpdatedDateTime	string	状態が最後に更新された日時 (UTC)。
operationId	string	操作 ID
percentCompleted	integer	操作の進行状況 (0 から 100)。
resourceLocation	string	この操作の対象となるリソースの URL。
result	DocumentClassifierDetails	成功した場合の操作の結果。
status	OperationStatus	操作の状態。 notStarted、running、completed、または failed
tags	object	ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。

DocumentClassifierDetails

分類子情報をドキュメント化します。

名前	型	説明
apiVersion	string	このドキュメント分類子の作成に使用される API バージョン。
baseClassifierId	string	分類子がトレーニングされた上の基本 classifierId。
classifierId	string	一意のドキュメント分類子名。
createdDateTime	string	ドキュメント分類子が作成された日時 (UTC)。
description	string	分類子の説明を文書化します。
docTypes	<string,  ClassifierDocumentTypeDetails>	分類対象のドキュメントの種類の一覧。
expirationDateTime	string	ドキュメント分類子の有効期限が切れる日時 (UTC)。
warnings	Warning[]	分類子の構築中に発生した警告の一覧。

DocumentFieldSchema

JSON スキーマ スタイル構文を使用したフィールド セマンティック スキーマの説明。

名前	型	説明
description	string	フィールドの説明。
example	string	フィールドの内容の例。
items	DocumentFieldSchema	各配列要素のフィールド型スキーマ。
properties	<string,  DocumentFieldSchema>	オブジェクト フィールドの名前付きサブフィールド。
type	DocumentFieldType	フィールド値のセマンティック データ型。

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) 形式に正規化された時間。

DocumentModelBuildOperationDetails

操作応答オブジェクトを取得します。

名前	型	説明
apiVersion	string	この操作の作成に使用される API バージョン。
createdDateTime	string	操作が作成された日時 (UTC)。
error	Error	エラーが発生しました。
kind	string: documentModelBuild	操作の種類。
lastUpdatedDateTime	string	状態が最後に更新された日時 (UTC)。
operationId	string	操作 ID
percentCompleted	integer	操作の進行状況 (0 から 100)。
resourceLocation	string	この操作の対象となるリソースの URL。
result	DocumentModelDetails	成功した場合の操作の結果。
status	OperationStatus	操作の状態。 notStarted、running、completed、または failed
tags	object	ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。

DocumentModelComposeOperationDetails

操作応答オブジェクトを取得します。

名前	型	説明
apiVersion	string	この操作の作成に使用される API バージョン。
createdDateTime	string	操作が作成された日時 (UTC)。
error	Error	エラーが発生しました。
kind	string: documentModelCompose	操作の種類。
lastUpdatedDateTime	string	状態が最後に更新された日時 (UTC)。
operationId	string	操作 ID
percentCompleted	integer	操作の進行状況 (0 から 100)。
resourceLocation	string	この操作の対象となるリソースの URL。
result	DocumentModelDetails	成功した場合の操作の結果。
status	OperationStatus	操作の状態。 notStarted、running、completed、または failed
tags	object	ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。

DocumentModelCopyToOperationDetails

操作応答オブジェクトを取得します。

名前	型	説明
apiVersion	string	この操作の作成に使用される API バージョン。
createdDateTime	string	操作が作成された日時 (UTC)。
error	Error	エラーが発生しました。
kind	string: documentModelCopyTo	操作の種類。
lastUpdatedDateTime	string	状態が最後に更新された日時 (UTC)。
operationId	string	操作 ID
percentCompleted	integer	操作の進行状況 (0 から 100)。
resourceLocation	string	この操作の対象となるリソースの URL。
result	DocumentModelDetails	成功した場合の操作の結果。
status	OperationStatus	操作の状態。 notStarted、running、completed、または failed
tags	object	ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。

DocumentModelDetails

ドキュメント モデル情報。

名前	型	規定値	説明
apiVersion	string		このドキュメント モデルの作成に使用される API バージョン。
azureBlobFileListSource	AzureBlobFileListContentSource		トレーニング データを指定する Azure Blob Storage ファイルの一覧。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
azureBlobSource	AzureBlobContentSource		トレーニング データを含む Azure Blob Storage の場所。 azureBlobSource または azureBlobFileListSource を指定する必要があります。
buildMode	DocumentBuildMode		カスタム ドキュメント モデルのビルド モード。
classifierId	string		構成済みモデルの場合、入力ファイルを分割して分類するカスタム分類子。
createdDateTime	string		ドキュメント モデルが作成された日時 (UTC)。
description	string		ドキュメント モデルの説明。
docTypes	<string,  DocumentTypeDetails>		サポートされているドキュメントの種類。
expirationDateTime	string		ドキュメント モデルの有効期限が切れる日時 (UTC)。
modelId	string		一意のドキュメント モデル名。
split	SplitMode	none	構成済みモデルの場合、ファイル分割の動作。
tags	object		ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。
trainingHours	number		モデル トレーニングに使用された V100 相当の GPU 時間の数。
warnings	Warning[]		モデルの構築中に発生した警告の一覧。

DocumentTypeDetails

ドキュメントの種類の情報。

名前	型	説明
buildMode	DocumentBuildMode	カスタム ドキュメント モデルのビルド モード。
confidenceThreshold	number	docType の信頼度がしきい値を超えている場合にのみ、分析を実行します。
description	string	ドキュメント モデルの説明。
features	DocumentAnalysisFeature[]	オプションの分析機能の一覧。
fieldConfidence	object	各フィールドの推定信頼度。
fieldSchema	<string,  DocumentFieldSchema>	JSON スキーマ スタイル構文を使用したドキュメント セマンティック スキーマの説明。
maxDocumentsToAnalyze	integer	分析する指定した種類のドキュメントの最大数。 Default=all。
modelId	string	指定した型のドキュメントの分析に使用するドキュメント モデル。
queryFields	string[]	抽出する追加フィールドの一覧。 旧。 "NumberOfGuests,StoreNumber"

Error

エラー オブジェクト。

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

ErrorResponse

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

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

InnerError

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

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

OperationKind

操作の種類。

名前	型	説明
documentClassifierBuild	string	新しいカスタム分類子モデルを構築します。
documentClassifierCopyTo	string	既存のドキュメント分類子を別のリソース、リージョン、またはサブスクリプションにコピーします。
documentModelBuild	string	新しいカスタム ドキュメント モデルを構築します。
documentModelCompose	string	既存のモデルから新しいカスタム ドキュメント モデルを作成します。
documentModelCopyTo	string	既存のドキュメント モデルを別のリソース、リージョン、またはサブスクリプションにコピーします。

OperationStatus

操作の状態。

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

SplitMode

ファイル分割の動作。

名前	型	説明
auto	string	ファイルをドキュメントに自動的に分割します。
none	string	ファイル全体を 1 つのドキュメントとして扱います。
perPage	string	ファイル内の各ページを個別のドキュメントとして扱います。

Warning

エラー オブジェクト。

名前	型	説明
code	string	サーバー定義の警告コードのセットの 1 つ。
message	string	警告の人間が判読できる表現。
target	string	エラーのターゲット。