Miscellaneous Operations - Get Document Model Compose Operation
操作情報を取得します。
GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentModelComposeOperation&api-version=2024-02-29-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string |
ドキュメント インテリジェンス サービス エンドポイント。 |
operation
|
path | True |
string |
操作 ID |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-request-id |
string uuid |
要求の不透明でグローバルに一意のクライアントによって生成された文字列識別子。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 Headers x-ms-client-request-id: string |
|
Other Status Codes |
予期しないエラー応答。 |
セキュリティ
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Token URL:
https://login.microsoftonline.com/common/oauth2/token
Scopes
名前 | 説明 |
---|---|
https://cognitiveservices.azure.com/.default |
例
Get Operation - Document Model Compose
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentModelComposeOperation&api-version=2024-02-29-preview
Sample Response
{
"operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
"status": "succeeded",
"percentCompleted": 100,
"createdDateTime": "2021-09-23T09:12:57Z",
"lastUpdatedDateTime": "2021-09-23T09:13:01Z",
"kind": "documentModelCompose",
"resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
"result": {
"modelId": "myCustomModel",
"description": "Custom model description",
"createdDateTime": "2021-09-23T09:13:01Z",
"apiVersion": "2024-02-29-preview"
}
}
定義
名前 | 説明 |
---|---|
Azure |
コンテンツをAzure Blob Storageします。 |
Azure |
Azure Blob Storage内のファイルの一覧。 |
Document |
カスタム ドキュメント モデルのビルド モード。 |
Document |
JSON スキーマ スタイル構文を使用したフィールド セマンティック スキーマの説明。 |
Document |
フィールド値のセマンティック データ型。 |
Document |
操作応答オブジェクトを取得します。 |
Document |
ドキュメント モデル情報。 |
Document |
ドキュメントの種類の情報。 |
Error |
error オブジェクト。 |
Error |
エラー応答オブジェクト。 |
Inner |
エラーに関するより具体的な情報を含むオブジェクト。 |
Operation |
操作の種類。 |
Operation |
操作の状態。 |
Warning |
error オブジェクト。 |
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 ファイルへのパス。 |
DocumentBuildMode
カスタム ドキュメント モデルのビルド モード。
名前 | 型 | 説明 |
---|---|---|
neural |
string |
多様なビジュアル テンプレートを使用してドキュメントをサポートします。 |
template |
string |
類似のビジュアル テンプレートを使用してドキュメントをターゲットに設定します。 |
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}) 形式に正規化された電話番号。 |
selectionGroup |
string |
選択した文字列値の配列。 |
selectionMark |
string |
フィールドは選択されていますか? |
signature |
string |
署名は存在しますか? |
string |
string |
プレーンテキスト。 |
time |
string |
ISO 8601 (hh:mm:ss) 形式に正規化された時間。 |
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 |
操作の状態。 notStarted、running、completed、または failed |
|
tags |
object |
ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。 |
DocumentModelDetails
ドキュメント モデル情報。
名前 | 型 | 説明 |
---|---|---|
apiVersion |
string |
このドキュメント モデルの作成に使用される API バージョン。 |
azureBlobFileListSource |
Azure Blob Storageトレーニング データを指定するファイル一覧です。 azureBlobSource または azureBlobFileListSource を指定する必要があります。 |
|
azureBlobSource |
トレーニング データAzure Blob Storage含む場所。 azureBlobSource または azureBlobFileListSource を指定する必要があります。 |
|
buildMode |
カスタム ドキュメント モデルのビルド モード。 |
|
createdDateTime |
string |
ドキュメント モデルが作成された日時 (UTC)。 |
description |
string |
ドキュメント モデルの説明。 |
docTypes |
<string,
Document |
サポートされているドキュメントの種類。 |
expirationDateTime |
string |
ドキュメント モデルの有効期限が切れる日時 (UTC)。 |
modelId |
string |
一意のドキュメント モデル名。 |
tags |
object |
ドキュメント モデルに関連付けられているキーと値のタグ属性の一覧。 |
warnings |
Warning[] |
モデルの構築中に発生した警告の一覧。 |
DocumentTypeDetails
ドキュメントの種類の情報。
名前 | 型 | 説明 |
---|---|---|
buildMode |
カスタム ドキュメント モデルのビルド モード。 |
|
description |
string |
ドキュメント モデルの説明。 |
fieldConfidence |
object |
各フィールドの推定信頼度。 |
fieldSchema |
<string,
Document |
JSON スキーマ スタイル構文を使用したドキュメント セマンティック スキーマの説明。 |
Error
error オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
details |
Error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含む オブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答オブジェクト。
名前 | 型 | 説明 |
---|---|---|
error |
エラー情報。 |
InnerError
エラーに関するより具体的な情報を含むオブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義のエラー コードのセットの 1 つ。 |
innererror |
内部エラー。 |
|
message |
string |
エラーの人間が判読できる表現。 |
OperationKind
操作の種類。
名前 | 型 | 説明 |
---|---|---|
documentClassifierBuild |
string |
新しいカスタム分類子モデルを構築します。 |
documentModelBuild |
string |
新しいカスタム ドキュメント モデルを構築します。 |
documentModelCompose |
string |
既存のモデルから新しいカスタム ドキュメント モデルを作成します。 |
documentModelCopyTo |
string |
既存のドキュメント モデルを別のリソース、リージョン、またはサブスクリプションにコピーします。 |
OperationStatus
操作の状態。
名前 | 型 | 説明 |
---|---|---|
canceled |
string |
操作が取り消されました。 |
completed |
string |
操作が完了しました。 |
failed |
string |
操作は失敗しました。 |
notStarted |
string |
操作はまだ開始されていません。 |
running |
string |
操作が進行中です。 |
succeeded |
string |
操作は成功しました。 |
Warning
error オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の警告コードのセットの 1 つ。 |
message |
string |
警告の人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |