Conversational Analysis Authoring - Get Deployment Status

Служба:

Azure AI Services

Версия API:

2022-05-01

Возвращает состояние существующего задания развертывания.

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

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
200 OK	ConversationalAnalysisAuthoringDeploymentJobState	Результат задания развертывания.
Other Status Codes	ErrorResponse	Ответ на ошибку.

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Примеры

Successful Get Deployment Status

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

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-05-01

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

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

200

{
  "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000",
  "createdDateTime": "2022-04-18T15:52:48Z",
  "lastUpdatedDateTime": "2022-04-18T15:53:04Z",
  "expirationDateTime": "2022-04-25T15:52:48Z",
  "status": "succeeded"
}

Определения

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

ConversationalAnalysisAuthoringDeploymentJobState

Object

Представляет состояние задания развертывания.

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

ConversationalAnalysisAuthoringWarning

Object

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

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

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

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