Document Models - Authorize Model Copy

Service:

Azure AI Services

API Version:

2022-08-31

產生授權，以使用指定的modelId和選擇性描述，將檔模型複製到這個位置。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus2.api.cognitive.microsoft.com) 。
api-version	query	True	ApiVersion	要求的 API 版本。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

要求本文

名稱	必要	類型	Description
modelId	True	string	唯一的檔模型名稱。
description		string	檔模型描述。
tags		object	與檔模型相關聯的索引鍵/值標籤屬性清單。

回應

名稱	類型	Description
200 OK	CopyAuthorization	正常。
Other Status Codes	ErrorResponse	發生錯誤。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

範例

AuthorizeCopyDocumentModel

Sample Request

HTTP

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

{
  "modelId": "{targetModelId}",
  "description": "{targetModelDescription}"
}

Sample Response

Status code:

200

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

定義

名稱	Description
ApiVersion	API 版本。
AuthorizeCopyRequest	要求本文授權檔模型複本。
CopyAuthorization	將檔案模型複製到指定的目標資源和modelId的授權。
Error	錯誤資訊。
ErrorResponse	錯誤回應物件。
InnerError	詳細的錯誤。

ApiVersion

API 版本。

名稱	類型	Description
2022-08-31	string

AuthorizeCopyRequest

要求本文授權檔模型複本。

名稱	類型	Description
description	string	檔模型描述。
modelId	string	唯一的檔模型名稱。
tags	object	與檔模型相關聯的索引鍵/值標籤屬性清單。

CopyAuthorization

將檔案模型複製到指定的目標資源和modelId的授權。

名稱	類型	Description
accessToken	string	用來授權要求的令牌。
expirationDateTime	string	存取令牌到期的日期/時間。
targetModelId	string	目標檔模型的標識碼。
targetModelLocation	string	目標帳戶中複製檔模型的 URL。
targetResourceId	string	應複製檔模型的目標 Azure 資源識別碼。
targetResourceRegion	string	應複製檔模型的目標 Azure 資源位置。

Error

錯誤資訊。

名稱	類型	Description
code	string	錯誤碼。
details	Error[]	詳細錯誤清單。
innererror	InnerError	詳細的錯誤。
message	string	錯誤訊息。
target	string	錯誤的目標。

ErrorResponse

錯誤回應物件。

名稱	類型	Description
error	Error	錯誤資訊。

InnerError

詳細的錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	InnerError	詳細的錯誤。
message	string	錯誤訊息。