Conversational Analysis Authoring - Get Export Status

Ссылка

Служба:: Cognitive Services - Language

Версия API:: 2022-05-01

Возвращает состояние задания экспорта. После завершения задания возвращает метаданные проекта и ресурсы.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
jobId	path	True	string	Идентификатор задания.
projectName	path	True	string	Имя используемого проекта.
api-version	query	True	string	Версия API клиента.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Ключ подписки для ресурса языковой службы.

Ответы

Имя	Тип	Описание
200 OK	ConversationalAnalysisAuthoringExportProjectJobState	Состояние длительной операции.
Other Status Codes	ErrorResponse	Ответ об ошибке.

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Примеры

Successful Get Export Status

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

HTTP

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

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

Код состояния:: 200

{
  "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/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"
}

Определения

Имя	Описание
ConversationalAnalysisAuthoringExportProjectJobState	Представляет состояние задания экспорта.
ConversationalAnalysisAuthoringWarning	Представляет предупреждение, которое было обнаружено при выполнении запроса.
Error	Объект error.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ об ошибке.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	Состояние задания.

ConversationalAnalysisAuthoringExportProjectJobState

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

Имя	Тип	Описание
createdDateTime	string	Дата создания задания.
errors	Error[]	Ошибки, возникшие при выполнении задания.
expirationDateTime	string	Дата окончания срока действия задания.
jobId	string	Идентификатор задания.
lastUpdatedDateTime	string	Дата последнего обновления задания.
resultUrl	string	URL-адрес, используемый для скачивания экспортированного проекта.
status	JobStatus	Состояние задания.
warnings	ConversationalAnalysisAuthoringWarning[]	Предупреждения, которые были обнаружены при выполнении задания.

ConversationalAnalysisAuthoringWarning

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

Имя	Тип	Описание
code	string	Код предупреждения.
message	string	Предупреждающее сообщение.

Error

Объект 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	Объект error.

InnerErrorCode