Document Models - Authorize Model Copy

リファレンス

Service:: Azure AI Services

API Version:: 2024-02-29-preview

指定された modelId と省略可能な説明を使用して、ドキュメントモデルをこの場所にコピーするための承認を生成します。

POST {endpoint}/documentintelligence/documentModels:authorizeCopy?api-version=2024-02-29-preview

URI パラメーター

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

要求本文

名前	必須	型	説明
modelId	True	string	一意のドキュメントモデル名。
description		string	ドキュメントモデルの説明。
tags		object	ドキュメントモデルに関連付けられているキーと値のタグ属性の一覧。

応答

名前	型	説明
200 OK	CopyAuthorization	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

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

例

Authorize Copy of Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:authorizeCopy?api-version=2024-02-29-preview

{
  "modelId": "targetModel",
  "description": "Target model description"
}

Sample Response

Status code:: 200

{
  "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
  "targetResourceRegion": "targetResourceRegion",
  "targetModelId": "targetModel",
  "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentModels/targetModel",
  "accessToken": "accessToken",
  "expirationDateTime": "2021-09-23T09:12:54.552Z"
}

定義

名前	説明
AuthorizeCopyRequest	ドキュメントモデルのコピーを承認するための要求本文。
CopyAuthorization	指定したターゲットリソースと modelId にドキュメントモデルをコピーするための承認。
Error	error オブジェクト。
ErrorResponse	エラー応答オブジェクト。
InnerError	エラーに関するより具体的な情報を含むオブジェクト。

AuthorizeCopyRequest

ドキュメントモデルのコピーを承認するための要求本文。

名前	型	説明
description	string	ドキュメントモデルの説明。
modelId	string	一意のドキュメントモデル名。
tags	object	ドキュメントモデルに関連付けられているキーと値のタグ属性の一覧。

CopyAuthorization

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

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

Error

error オブジェクト。

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

ErrorResponse

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

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

InnerError

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

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

Share via