Question Answering Projects - Get Delete Status

Служба:

Azure AI Services

Версия API:

2023-04-01

Возвращает состояние задания удаления проекта.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string (uri)	Поддерживаемая конечная точка Cognitive Services (например, https://< resource-name.api.cognitiveservices.azure.com>).
jobId	path	True	string	Идентификатор задания.
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
Flow: 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	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — 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

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — 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	Идентификатор задания.
lastUpdatedDateTime	string (date-time)	Дата последнего обновления задания.
status	jobStatus	Статус работы.