你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点（例如 https://.api.cognitiveservices.azure.com).
jobId	path	True	string	作业 ID。
projectName	path	True	string maxLength: 100	要使用的项目的名称。
api-version	query	True	string	客户端 API 版本。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string	语言服务资源的订阅密钥。

响应

名称	类型	说明
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"
}

定义

名称	说明
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

错误对象。

名称	类型	说明
code	ErrorCode	服务器定义的错误代码集之一。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

ErrorCode

枚举

人工可读错误代码。

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

ErrorResponse

Object

错误响应。

名称	类型	说明
error	Error	错误对象。

InnerErrorCode

枚举

人工可读错误代码。

值	说明
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。

名称	类型	说明
code	InnerErrorCode	服务器定义的错误代码集之一。
details	object	错误详细信息。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误信息。
target	string	错误目标。

JobStatus

枚举

作业状态。

值	说明
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded

TextAnalysisAuthoringExportProjectJobState

Object

表示导出作业的状态。

名称	类型	说明
createdDateTime	string (date-time)	作业的创建日期时间。
errors	Error[]	执行作业时遇到的错误。
expirationDateTime	string (date-time)	作业的到期日期时间。
jobId	string	作业 ID。
lastUpdatedDateTime	string (date-time)	更新作业的最后一个日期。
resultUrl	string	用于下载导出项目的 URL。
status	JobStatus	作业状态。
warnings	TextAnalysisAuthoringWarning[]	执行作业时遇到的警告。

TextAnalysisAuthoringWarning

Object

表示执行请求时遇到的警告。

名称	类型	说明
code	string	警告代码。
message	string	警告消息。