Text Analysis Authoring - Deploy Project

服務:

Azure AI Services

API 版本:

2022-05-01

建立新的部署，或取代現有的部署。

PUT {Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}?api-version=2022-05-01

URI 參數

名稱	位於	必要	類型	Description
deploymentName	path	True	string	要使用的專案特定部署名稱。
Endpoint	path	True	string	支援的認知服務端點 （例如，https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	要使用的項目名稱。
api-version	query	True	string	用戶端 API 版本。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string	語言服務資源的訂用帳戶金鑰。

要求本文

名稱	必要	類型	Description
trainedModelLabel	True	string	表示定型的模型標籤。

回應

名稱	類型	Description
202 Accepted		成功的呼叫結果，其中包含用來檢查作業狀態的 Operation-Location 標頭。 標題 operation-location: string
Other Status Codes	ErrorResponse	錯誤回應。

安全性

Ocp-Apim-Subscription-Key

語言服務資源的訂用帳戶金鑰。

類型: apiKey
位於: header

範例

Successful Deploy Project

範例要求

HTTP

PUT {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production?api-version=2022-05-01


{
  "trainedModelLabel": "model1"
}

範例回覆

狀態碼:

202

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-05-01

定義

名稱	Description
Error	error 物件。
ErrorCode	人類可讀取的錯誤碼。
ErrorResponse	錯誤回應。
InnerErrorCode	人類可讀取的錯誤碼。
InnerErrorModel	物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
TextAnalysisAuthoringCreateDeploymentOptions	表示建立或更新專案部署的選項。

Error

Object

error 物件。

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

ErrorCode

列舉型別

人類可讀取的錯誤碼。

值	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
error	Error	error 物件。

InnerErrorCode

列舉型別

人類可讀取的錯誤碼。

值	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	InnerErrorCode	其中一組伺服器定義的錯誤碼。
details	object	錯誤詳細數據。
innererror	InnerErrorModel	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤資訊。
target	string	錯誤目標。

TextAnalysisAuthoringCreateDeploymentOptions

Object

表示建立或更新專案部署的選項。

名稱	類型	Description
trainedModelLabel	string	表示定型的模型標籤。