Document Models - Authorize Model Copy

參考

服務:: Azure AI Services

API 版本:: 2024-11-30

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

POST {endpoint}/documentintelligence/documentModels:authorizeCopy?api-version=2024-11-30

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string uri	Document Intelligence 服務端點。
api-version	query	True	string	要用於這項作業的 API 版本。

要求本文

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

回應

名稱	類型	Description
200 OK	ModelCopyAuthorization	要求已成功。
Other Status Codes	DocumentIntelligenceErrorResponse	未預期的錯誤回應。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: accessCode
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize
權杖 URL: https://login.microsoftonline.com/common/oauth2/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Authorize Copy of Document Model

範例要求

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:authorizeCopy?api-version=2024-11-30

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

範例回覆

狀態碼:: 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"
}

定義

名稱	Description
AuthorizeCopyRequest	要求本文以授權檔模型複製。
DocumentIntelligenceError	error 物件。
DocumentIntelligenceErrorResponse	錯誤回應物件。
DocumentIntelligenceInnerError	物件，包含有關錯誤的更特定資訊。
ModelCopyAuthorization	將檔案模型複製到指定的目標資源和modelId的授權。

AuthorizeCopyRequest

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

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

DocumentIntelligenceError

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	DocumentIntelligenceError[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	DocumentIntelligenceInnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

DocumentIntelligenceErrorResponse

錯誤回應物件。

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

DocumentIntelligenceInnerError

物件，包含有關錯誤的更特定資訊。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	DocumentIntelligenceInnerError	內部錯誤。
message	string	錯誤的人類可讀取表示法。

ModelCopyAuthorization

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

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

共用方式為