Miscellaneous - Get Operation
操作情報を取得します。
GET {endpoint}/formrecognizer/operations/{operationId}?api-version=2023-07-31
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string url |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus2.api.cognitive.microsoft.com |
operation
|
path | True |
string uuid |
一意の操作 ID。 正規表現パターン: |
api-version
|
query | True |
string |
要求された API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Azure Cognitive Services サブスクリプションの秘密キー。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK | OperationDetails: |
OK です。 |
Other Status Codes |
エラーが発生しました。 |
セキュリティ
Ocp-Apim-Subscription-Key
Azure Cognitive Services サブスクリプションの秘密キー。
型:
apiKey
/:
header
例
Get Operation
要求のサンプル
GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31
応答のサンプル
{
"operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4",
"status": "succeeded",
"percentCompleted": 100,
"createdDateTime": "2021-09-23T09:12:57Z",
"lastUpdatedDateTime": "2021-09-23T09:13:01Z",
"kind": "documentModelBuild",
"resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
"result": {
"modelId": "myCustomModel",
"description": "Custom model description",
"createdDateTime": "2021-09-23T09:13:01Z",
"apiVersion": "2023-07-31"
}
}
定義
名前 | 説明 |
---|---|
Azure |
コンテンツをAzure Blob Storageします。 |
Azure |
Azure Blob Storageのファイル一覧。 |
Classifier |
分類子ドキュメントの種類の情報。 |
Document |
カスタム ドキュメント モデルのビルド モード。 |
Document |
操作応答オブジェクトを取得します。 |
Document |
ドキュメント分類子情報。 |
Document |
JSON スキーマ スタイル構文を使用したフィールド セマンティック スキーマの説明。 |
Document |
フィールド値のセマンティック データ型。 |
Document |
操作応答オブジェクトを取得します。 |
Document |
操作応答オブジェクトを取得します。 |
Document |
操作応答オブジェクトを取得します。 |
Document |
ドキュメント モデル情報。 |
Document |
ドキュメントの種類の情報。 |
Error |
エラー情報。 |
Error |
エラー応答オブジェクト。 |
Inner |
詳細なエラー。 |
Operation |
操作の状態。 |
AzureBlobContentSource
コンテンツをAzure Blob Storageします。
名前 | 型 | 説明 |
---|---|---|
containerUrl |
string |
コンテナー URL をAzure Blob Storageします。 |
prefix |
string |
BLOB 名プレフィックス。 |
AzureBlobFileListContentSource
Azure Blob Storageのファイル一覧。
名前 | 型 | 説明 |
---|---|---|
containerUrl |
string |
コンテナー URL をAzure Blob Storageします。 |
fileList |
string |
トレーニング用のドキュメントのサブセットを指定するコンテナー内の JSONL ファイルへのパス。 |
ClassifierDocumentTypeDetails
分類子ドキュメントの種類の情報。
名前 | 型 | 説明 |
---|---|---|
azureBlobFileListSource |
分類子ドキュメントの種類のトレーニング データを指定するファイル一覧をAzure Blob Storageします。 azureBlobSource または azureBlobFileListSource を指定する必要があります。 |
|
azureBlobSource |
分類子ドキュメントの種類のトレーニング データを含む場所をAzure Blob Storageします。 azureBlobSource または azureBlobFileListSource を指定する必要があります。 |
DocumentBuildMode
カスタム ドキュメント モデルのビルド モード。
名前 | 型 | 説明 |
---|---|---|
neural |
string |
多様なビジュアル テンプレートを使用してドキュメントをサポートします。 |
template |
string |
類似のビジュアル テンプレートを使用してドキュメントをターゲットに設定します。 |
DocumentClassifierBuildOperationDetails
操作応答オブジェクトを取得します。
名前 | 型 | 説明 |
---|---|---|
apiVersion |
string |
この操作の作成に使用される API バージョン。 |
createdDateTime |
string |
操作が作成された日時 (UTC)。 |
error |
エラーが発生しました。 |
|
kind |
string:
document |
操作の種類。 |
lastUpdatedDateTime |
string |
状態が最後に更新された日時 (UTC)。 |
operationId |
string |
操作 ID |
percentCompleted |
integer |
操作の進行状況 (0 から 100)。 |
resourceLocation |
string |
この操作の対象となるリソースの URL。 |
result |
成功した場合の操作結果。 |
|
status |
操作の状態。 |
|
tags |
object |
ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。 |
DocumentClassifierDetails
ドキュメント分類子情報。
名前 | 型 | 説明 |
---|---|---|
apiVersion |
string |
このドキュメント分類子の作成に使用される API バージョン。 |
classifierId |
string |
一意のドキュメント分類子名。 |
createdDateTime |
string |
ドキュメント分類子が作成された日時 (UTC)。 |
description |
string |
分類子の説明を文書化します。 |
docTypes |
<string,
Classifier |
分類対象のドキュメントの種類の一覧。 |
expirationDateTime |
string |
ドキュメント分類子の有効期限が切れる日時 (UTC)。 |
DocumentFieldSchema
JSON スキーマ スタイル構文を使用したフィールド セマンティック スキーマの説明。
名前 | 型 | 説明 |
---|---|---|
description |
string |
フィールドの説明。 |
example |
string |
フィールドコンテンツの例。 |
items |
各配列要素のフィールド型スキーマ。 |
|
properties |
<string,
Document |
オブジェクト フィールドの名前付きサブフィールド。 |
type |
フィールド値のセマンティック データ型。 |
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}) 形式に正規化された電話番号。 |
selectionMark |
string |
フィールドは選択されていますか? |
signature |
string |
署名は存在しますか? |
string |
string |
プレーンテキスト。 |
time |
string |
ISO 8601 (hh:mm:ss) 形式に正規化された時間。 |
DocumentModelBuildOperationDetails
操作応答オブジェクトを取得します。
名前 | 型 | 説明 |
---|---|---|
apiVersion |
string |
この操作の作成に使用される API バージョン。 |
createdDateTime |
string |
操作が作成された日時 (UTC)。 |
error |
エラーが発生しました。 |
|
kind |
string:
document |
操作の種類。 |
lastUpdatedDateTime |
string |
状態が最後に更新された日時 (UTC)。 |
operationId |
string |
操作 ID |
percentCompleted |
integer |
操作の進行状況 (0 から 100)。 |
resourceLocation |
string |
この操作の対象となるリソースの URL。 |
result |
成功した場合の操作結果。 |
|
status |
操作の状態。 |
|
tags |
object |
ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。 |
DocumentModelComposeOperationDetails
操作応答オブジェクトを取得します。
名前 | 型 | 説明 |
---|---|---|
apiVersion |
string |
この操作の作成に使用される API バージョン。 |
createdDateTime |
string |
操作が作成された日時 (UTC)。 |
error |
エラーが発生しました。 |
|
kind |
string:
document |
操作の種類。 |
lastUpdatedDateTime |
string |
状態が最後に更新された日時 (UTC)。 |
operationId |
string |
操作 ID |
percentCompleted |
integer |
操作の進行状況 (0 から 100)。 |
resourceLocation |
string |
この操作の対象となるリソースの URL。 |
result |
成功した場合の操作結果。 |
|
status |
操作の状態。 |
|
tags |
object |
ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。 |
DocumentModelCopyToOperationDetails
操作応答オブジェクトを取得します。
名前 | 型 | 説明 |
---|---|---|
apiVersion |
string |
この操作の作成に使用される API バージョン。 |
createdDateTime |
string |
操作が作成された日時 (UTC)。 |
error |
エラーが発生しました。 |
|
kind |
string:
document |
操作の種類。 |
lastUpdatedDateTime |
string |
状態が最後に更新された日時 (UTC)。 |
operationId |
string |
操作 ID |
percentCompleted |
integer |
操作の進行状況 (0 から 100)。 |
resourceLocation |
string |
この操作の対象となるリソースの URL。 |
result |
成功した場合の操作結果。 |
|
status |
操作の状態。 |
|
tags |
object |
ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。 |
DocumentModelDetails
ドキュメント モデル情報。
名前 | 型 | 説明 |
---|---|---|
apiVersion |
string |
このドキュメント モデルの作成に使用される API バージョン。 |
createdDateTime |
string |
ドキュメント モデルが作成された日時 (UTC)。 |
description |
string |
ドキュメント モデルの説明。 |
docTypes |
<string,
Document |
サポートされているドキュメントの種類。 |
expirationDateTime |
string |
ドキュメント モデルの有効期限が切れる日時 (UTC)。 |
modelId |
string |
一意のドキュメント モデル名。 |
tags |
object |
ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。 |
DocumentTypeDetails
ドキュメントの種類の情報。
名前 | 型 | 説明 |
---|---|---|
buildMode |
カスタム ドキュメント モデルのビルド モード。 |
|
description |
string |
ドキュメント モデルの説明。 |
fieldConfidence |
object |
各フィールドの推定信頼度。 |
fieldSchema |
<string,
Document |
JSON スキーマ スタイル構文を使用したドキュメント セマンティック スキーマの説明。 |
Error
エラー情報。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
Error[] |
詳細なエラーの一覧。 |
innererror |
詳細なエラー。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答オブジェクト。
名前 | 型 | 説明 |
---|---|---|
error |
エラー情報。 |
InnerError
詳細なエラー。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
innererror |
詳細なエラー。 |
|
message |
string |
エラー メッセージ。 |
OperationStatus
操作の状態。
名前 | 型 | 説明 |
---|---|---|
canceled |
string |
操作が取り消されました。 |
failed |
string |
操作は失敗しました。 |
notStarted |
string |
操作はまだ開始されていません。 |
running |
string |
操作が進行中です。 |
succeeded |
string |
操作は成功しました。 |