Поделиться через


Conversational Analysis Authoring - Get Project Deletion Status

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

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}?api-version=2023-04-01

Параметры URI

Имя В Обязательно Тип Описание
Endpoint
path True

string

Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).

jobId
path True

string

Идентификатор задания.

api-version
query True

string

Версия API клиента.

Ответы

Имя Тип Описание
200 OK

ConversationalAnalysisAuthoringProjectDeletionJobState

Результат задания удаления проекта.

Other Status Codes

ErrorResponse

Ответ об ошибке.

Безопасность

AADToken

Это потоки OAuth2 Azure Active Directory . При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

  • Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

  • В настоящее время Azure Active Directory версии 1.0 или 2.0 поддерживает рабочие, учебные заведения и гостей, но не поддерживает личные учетные записи.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
https://cognitiveservices.azure.com/.default https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса языковой службы.

Тип: apiKey
В: header

Примеры

Successful Get Project Deletion Status

Образец запроса

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-04-01

Пример ответа

{
  "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000",
  "createdDateTime": "2022-04-18T14:02:34Z",
  "lastUpdatedDateTime": "2022-04-18T14:02:34Z",
  "expirationDateTime": "2022-04-25T14:02:34Z",
  "status": "succeeded"
}

Определения

Имя Описание
ConversationalAnalysisAuthoringProjectDeletionJobState

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

ConversationalAnalysisAuthoringWarning

Представляет предупреждение, обнаруженное при выполнении запроса.

Error

Объект ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

ErrorResponse

Ответ об ошибке.

InnerErrorCode

Код ошибки, доступный для чтения человеком.

InnerErrorModel

Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

JobStatus

Состояние задания.

ConversationalAnalysisAuthoringProjectDeletionJobState

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

Имя Тип Описание
createdDateTime

string

Дата создания задания.

errors

Error[]

Ошибки, возникшие при выполнении задания.

expirationDateTime

string

Дата окончания срока действия задания.

jobId

string

Идентификатор задания.

lastUpdatedDateTime

string

Дата последнего обновления задания.

status

JobStatus

Состояние задания.

warnings

ConversationalAnalysisAuthoringWarning[]

Предупреждения, которые были обнаружены при выполнении задания.

ConversationalAnalysisAuthoringWarning

Представляет предупреждение, обнаруженное при выполнении запроса.

Имя Тип Описание
code

string

Код предупреждения.

message

string

Предупреждающее сообщение.

Error

Объект ошибки.

Имя Тип Описание
code

ErrorCode

Один из серверных наборов кодов ошибок.

details

Error[]

Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.

innererror

InnerErrorModel

Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.

message

string

Понятное представление ошибки.

target

string

Целевой объект ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

Имя Тип Описание
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

Ответ об ошибке.

Имя Тип Описание
error

Error

Объект ошибки.

InnerErrorCode

Код ошибки, доступный для чтения человеком.

Имя Тип Описание
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

Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по 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

Состояние задания.

Имя Тип Описание
cancelled

string

cancelling

string

failed

string

notStarted

string

partiallyCompleted

string

running

string

succeeded

string