Question Answering Projects - Get Delete Status

服务:

Azure AI Services

API 版本:

2023-04-01

获取 Project 删除作业的状态。

GET {Endpoint}/language/authoring/query-knowledgebases/projects/deletion-jobs/{jobId}?api-version=2023-04-01

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string (uri)	支持的认知服务终结点（例如，https://< resource-name.api.cognitiveservices.azure.com>）。
jobId	path	True	string	作业 ID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	QuestionAnsweringAuthoringProjectDeletionJobState	请求已成功。
Other Status Codes	ErrorResponse	意外错误响应。 标头 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Successful query

示例请求

HTTP

GET {Endpoint}/language/authoring/query-knowledgebases/projects/deletion-jobs/job1?api-version=2023-04-01

示例响应

状态代码:

200

{
  "createdDateTime": "2021-05-01T17:21:14Z",
  "errors": [],
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded"
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
Error	错误对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
jobStatus	作业状态。
QuestionAnsweringAuthoringProjectDeletionJobState	表示项目删除作业的状态。

Azure.Core.Foundations.Error

Object

错误对象。

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

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据 Azure REST API 准则 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

Error

Object

错误对象。

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

ErrorCode

枚举

人工可读错误代码。

值	说明
InvalidRequest	请求错误无效
InvalidArgument	参数错误无效
Unauthorized	未经授权的访问错误
Forbidden	禁止访问错误
NotFound	找不到错误
ProjectNotFound	项目找不到错误
OperationNotFound	找不到操作错误
AzureCognitiveSearchNotFound	Azure 认知搜索找不到错误
AzureCognitiveSearchIndexNotFound	Azure 认知搜索索引找不到错误
TooManyRequests	请求过多错误
AzureCognitiveSearchThrottling	Azure 认知搜索限制错误
AzureCognitiveSearchIndexLimitReached	Azure 认知搜索索引限制达到错误
InternalServerError	内部服务器错误
ServiceUnavailable	服务不可用错误
Timeout	超时错误
QuotaExceeded	超出配额错误
Conflict	冲突错误
Warning	警告错误

ErrorResponse

Object

错误响应。

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

InnerErrorCode

枚举

人工可读错误代码。

值	说明
InvalidRequest	请求错误无效
InvalidParameterValue	参数值错误无效
KnowledgeBaseNotFound	知识库找不到错误
AzureCognitiveSearchNotFound	Azure 认知搜索找不到错误
AzureCognitiveSearchThrottling	Azure 认知搜索限制错误
ExtractionFailure	提取失败错误
InvalidRequestBodyFormat	请求正文格式错误无效
EmptyRequest	空请求错误
MissingInputDocuments	缺少输入文档错误
InvalidDocument	文档错误无效
ModelVersionIncorrect	模型版本错误错误
InvalidDocumentBatch	文档批处理错误无效
UnsupportedLanguageCode	不支持的语言代码错误
InvalidCountryHint	国家/地区提示错误无效

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

枚举

作业状态。

值	说明
notStarted
running
succeeded
failed
cancelled
cancelling
partiallyCompleted

QuestionAnsweringAuthoringProjectDeletionJobState

Object

表示项目删除作业的状态。

名称	类型	说明
createdDateTime	string (date-time)	作业的创建日期时间。
errors	Azure.Core.Foundations.Error[]	执行作业时遇到的错误。
expirationDateTime	string (date-time)	作业的到期日期时间。
jobId	string	作业 ID。
lastUpdatedDateTime	string (date-time)	更新作业的上次日期。
status	jobStatus	作业状态。