Document Models - Copy Model To

Service:

Azure AI Services

API Version:

2022-08-31

ドキュメント モデルをターゲット リソース、リージョン、および modelId にコピーします。

POST {endpoint}/formrecognizer/documentModels/{modelId}:copyTo?api-version=2022-08-31

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus2.api.cognitive.microsoft.com
modelId	path	True	string	一意のドキュメント モデル名。 Regex pattern: [a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}
api-version	query	True	ApiVersion	要求された API バージョン。

要求ヘッダー

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

要求本文

名前	必須	型	説明
accessToken	True	string	要求を承認するために使用されるトークン。
expirationDateTime	True	string	アクセス トークンの有効期限が切れる日付/時刻。
targetModelId	True	string	ターゲット ドキュメント モデルの識別子。
targetModelLocation	True	string	ターゲット アカウントでコピーしたドキュメント モデルの URL。
targetResourceId	True	string	ドキュメント モデルのコピー先となるターゲット Azure リソースの ID。
targetResourceRegion	True	string	ドキュメント モデルのコピー先となるターゲット Azure リソースの場所。

応答

名前	型	説明
202 Accepted		要求は正常にキューに入れられます。 Headers Operation-Location: string
Other Status Codes	ErrorResponse	エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

例

CopyDocumentModelTo

Sample Request

HTTP

POST {endpoint}/formrecognizer/documentModels/sourceModel:copyTo?api-version=2022-08-31

{
  "targetResourceId": "{targetResourceId}",
  "targetResourceRegion": "{targetResourceRegion}",
  "targetModelId": "targetModel",
  "targetModelLocation": "{targetEndpoint}/formrecognizer/documentModels/targetModel?api-version=2022-08-31",
  "accessToken": "{accessToken}",
  "expirationDateTime": "2021-09-23T09:12:54.552Z"
}

Sample Response

Status code:

202

Operation-Location: {endpoint}/formrecognizer/operations/{operationId}?api-version=2022-08-31

定義

名前	説明
ApiVersion	API バージョン。
CopyAuthorization	指定したターゲット リソースと modelId にドキュメント モデルをコピーするための承認。
Error	エラー情報。
ErrorResponse	エラー応答オブジェクト。
InnerError	詳細なエラー。

ApiVersion

API バージョン。

名前	型	説明
2022-08-31	string

CopyAuthorization

指定したターゲット リソースと modelId にドキュメント モデルをコピーするための承認。

名前	型	説明
accessToken	string	要求を承認するために使用されるトークン。
expirationDateTime	string	アクセス トークンの有効期限が切れる日付/時刻。
targetModelId	string	ターゲット ドキュメント モデルの識別子。
targetModelLocation	string	ターゲット アカウントでコピーしたドキュメント モデルの URL。
targetResourceId	string	ドキュメント モデルのコピー先となるターゲット Azure リソースの ID。
targetResourceRegion	string	ドキュメント モデルのコピー先となるターゲット Azure リソースの場所。

Error

エラー情報。

名前	型	説明
code	string	エラー コード。
details	Error[]	詳細なエラーの一覧。
innererror	InnerError	詳細なエラー。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

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

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

InnerError

詳細なエラー。

名前	型	説明
code	string	エラー コード。
innererror	InnerError	詳細なエラー。
message	string	エラー メッセージ。