Conversational Analysis Authoring - Get Import Status
取得匯入的狀態。
GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}?api-version=2022-05-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
支援的認知服務端點 (例如 https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
作業識別碼。 |
project
|
path | True |
string |
要使用的項目名稱。 |
api-version
|
query | True |
string |
用戶端 API 版本。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
語言服務資源的訂用帳戶金鑰。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
長時間執行作業的詳細數據。 |
|
Other Status Codes |
錯誤回應。 |
安全性
Ocp-Apim-Subscription-Key
語言服務資源的訂用帳戶金鑰。
類型:
apiKey
位於:
header
範例
Successful Get Import Status
範例要求
GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2022-05-01
範例回覆
{
"jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000",
"createdDateTime": "2022-04-18T15:17:20Z",
"lastUpdatedDateTime": "2022-04-18T15:17:22Z",
"expirationDateTime": "2022-04-25T15:17:20Z",
"status": "succeeded"
}
定義
名稱 | Description |
---|---|
Conversational |
表示匯入作業的狀態。 |
Conversational |
表示在執行要求時遇到的警告。 |
Error |
error 物件。 |
Error |
人類可讀取的錯誤碼。 |
Error |
錯誤回應。 |
Inner |
人類可讀取的錯誤碼。 |
Inner |
物件,包含錯誤的詳細資訊。 根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。 |
Job |
作業狀態。 |
ConversationalAnalysisAuthoringImportProjectJobState
表示匯入作業的狀態。
名稱 | 類型 | Description |
---|---|---|
createdDateTime |
string |
作業的建立日期時間。 |
errors |
Error[] |
執行作業時遇到的錯誤。 |
expirationDateTime |
string |
作業的到期日期時間。 |
jobId |
string |
作業識別碼。 |
lastUpdatedDateTime |
string |
上次更新作業的日期時間。 |
status |
作業狀態。 |
|
warnings |
執行作業時遇到的警告。 |
ConversationalAnalysisAuthoringWarning
表示在執行要求時遇到的警告。
名稱 | 類型 | Description |
---|---|---|
code |
string |
警告碼。 |
message |
string |
警告訊息。 |
Error
error 物件。
名稱 | 類型 | Description |
---|---|---|
code |
其中一組伺服器定義的錯誤碼。 |
|
details |
Error[] |
導致此錯誤之特定錯誤的詳細數據陣列。 |
innererror |
物件,包含比目前對象有關錯誤更具體的資訊。 |
|
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 物件。 |
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 |
其中一組伺服器定義的錯誤碼。 |
|
details |
object |
錯誤詳細數據。 |
innererror |
物件,包含比目前對象有關錯誤更具體的資訊。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
JobStatus
作業狀態。
名稱 | 類型 | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |