Text Analysis Authoring - Get Export Status

服務:

Azure AI Services

API 版本:

2022-05-01

取得匯出作業的狀態。 作業完成後，傳回專案元數據和資產。

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

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點 （例如，https://.api.cognitiveservices.azure.com).
jobId	path	True	string	作業標識碼。
projectName	path	True	string maxLength: 100	要使用的項目名稱。
api-version	query	True	string	用戶端 API 版本。

要求標頭

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

回應

名稱	類型	Description
200 OK	TextAnalysisAuthoringExportProjectJobState	長時間執行作業的狀態。
Other Status Codes	ErrorResponse	錯誤回應。

安全性

Ocp-Apim-Subscription-Key

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

類型: apiKey
位於: header

範例

Successful Get Export Status

範例要求

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2022-05-01

範例回覆

狀態碼:

200

{
  "resultUrl": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2022-05-01",
  "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000",
  "createdDateTime": "2022-04-18T15:23:07Z",
  "lastUpdatedDateTime": "2022-04-18T15:23:08Z",
  "expirationDateTime": "2022-04-25T15:23:07Z",
  "status": "succeeded"
}

定義

名稱	Description
Error	error 物件。
ErrorCode	人類可讀取的錯誤碼。
ErrorResponse	錯誤回應。
InnerErrorCode	人類可讀取的錯誤碼。
InnerErrorModel	物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
JobStatus	作業狀態。
TextAnalysisAuthoringExportProjectJobState	表示匯出作業的狀態。
TextAnalysisAuthoringWarning	表示執行要求時遇到的警告。

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

JobStatus

列舉型別

作業狀態。

值	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringExportProjectJobState

Object

表示匯出作業的狀態。

名稱	類型	Description
createdDateTime	string (date-time)	作業的建立日期時間。
errors	Error[]	執行作業時遇到的錯誤。
expirationDateTime	string (date-time)	作業的到期日時間。
jobId	string	作業標識碼。
lastUpdatedDateTime	string (date-time)	上次更新作業的日期時間。
resultUrl	string	要用來下載匯出專案的 URL。
status	JobStatus	作業狀態。
warnings	TextAnalysisAuthoringWarning[]	執行作業時遇到的警告。

TextAnalysisAuthoringWarning

Object

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

名稱	類型	Description
code	string	警告碼。
message	string	警告訊息。