Text Analysis Authoring - Get Deployment

服務:

Azure AI Services

API 版本:

2022-05-01

取得部署的詳細數據。

GET {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
200 OK	TextAnalysisAuthoringProjectDeployment	部署資訊。
Other Status Codes	ErrorResponse	錯誤回應。

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

範例

Successful Get Deployment

範例要求

HTTP

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

範例回覆

狀態碼:

200

{
  "deploymentName": "staging",
  "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
  "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z",
  "lastDeployedDateTime": "2022-04-18T15:53:04Z",
  "deploymentExpirationDate": "2023-10-28",
  "modelTrainingConfigVersion": "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。
TextAnalysisAuthoringProjectDeployment	表示專案部署。

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	錯誤目標。

TextAnalysisAuthoringProjectDeployment

Object

表示專案部署。

名稱	類型	Description
deploymentExpirationDate	string (date)	表示運行時間中的部署到期日。
deploymentName	string	表示部署名稱。
lastDeployedDateTime	string (date-time)	表示上次部署時間的部署。
lastTrainedDateTime	string (date-time)	表示上次定型的部署時間。
modelId	string	表示部署modelId。
modelTrainingConfigVersion	string	表示模型定型組態版本。