共用方式為

Conversational Analysis Authoring - Get Deployment Status

  • 參考
服務:
Cognitive Services - Language
API 版本:
2022-05-01

取得現有部署作業的狀態。

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}?api-version=2022-05-01

URI 參數

名稱 位於 必要 類型 Description
deploymentName
 path True

string

要使用的專案特定部署名稱。
Endpoint
 path True

string

支援的認知服務端點 (例如 https://.api.cognitiveservices.azure.com).
jobId
 path True

string

作業識別碼。
projectName
 path True

string

要使用的項目名稱。
api-version
 query True

string

用戶端 API 版本。

要求標頭

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

string

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

回應

名稱 類型 Description
200 OK

ConversationalAnalysisAuthoringDeploymentJobState

部署作業結果。
Other Status Codes

ErrorResponse

錯誤回應。

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

範例

Successful Get Deployment Status

範例要求

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-05-01

範例回覆

狀態碼:
200 
{
  "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000",
  "createdDateTime": "2022-04-18T15:52:48Z",
  "lastUpdatedDateTime": "2022-04-18T15:53:04Z",
  "expirationDateTime": "2022-04-25T15:52:48Z",
  "status": "succeeded"
}

定義

名稱 Description
ConversationalAnalysisAuthoringDeploymentJobState

表示部署作業的狀態。
ConversationalAnalysisAuthoringWarning

表示在執行要求時遇到的警告。
Error

error 物件。
ErrorCode

人類可讀取的錯誤碼。
ErrorResponse

錯誤回應。
InnerErrorCode

人類可讀取的錯誤碼。
InnerErrorModel

物件，包含錯誤的詳細資訊。 根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
JobStatus

作業狀態。

ConversationalAnalysisAuthoringDeploymentJobState

表示部署作業的狀態。

名稱 類型 Description
createdDateTime

string

作業的建立日期時間。
errors

Error[]

執行作業時遇到的錯誤。
expirationDateTime

string

作業的到期日期時間。
jobId

string

作業識別碼。
lastUpdatedDateTime

string

上次更新作業的日期時間。
status

JobStatus

作業狀態。
warnings

ConversationalAnalysisAuthoringWarning[]

執行作業時遇到的警告。

ConversationalAnalysisAuthoringWarning

表示在執行要求時遇到的警告。

名稱 類型 Description
code

string

警告碼。
message

string

警告訊息。

Error

error 物件。

名稱 類型 Description
code

ErrorCode

其中一組伺服器定義的錯誤碼。
details

Error[]

導致此錯誤之特定錯誤的詳細數據陣列。
innererror

InnerErrorModel

物件，包含比目前對象有關錯誤更具體的資訊。
message

string

人類可讀取的錯誤表示法。
target

string

錯誤的目標。

ErrorCode

人類可讀取的錯誤碼。

名稱 類型 Description
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Conflict

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

QuotaExceeded

string

ServiceUnavailable

string

Timeout

string

TooManyRequests

string

Unauthorized

string

Warning

string

ErrorResponse

錯誤回應。

名稱 類型 Description
error

Error

error 物件。

InnerErrorCode

人類可讀取的錯誤碼。

名稱 類型 Description
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

InnerErrorModel

物件，包含錯誤的詳細資訊。 根據 Microsoft One 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

錯誤目標。

JobStatus

作業狀態。

名稱 類型 Description
cancelled

string

cancelling

string

failed

string

notStarted

string

partiallyCompleted

string

running

string

succeeded

string