Conversational Analysis Authoring - Get Project Deletion Status

Referência

Serviço:: Cognitive Services - Language

Versão da API:: 2022-05-01

Obtém o status de um trabalho de exclusão de projeto.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).
jobId	path	True	string	A ID do trabalho.
api-version	query	True	string	Versão de API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Uma chave de assinatura para um recurso de serviço de linguagem.

Respostas

Nome	Tipo	Description
200 OK	ConversationalAnalysisAuthoringProjectDeletionJobState	O resultado do trabalho de exclusão do projeto.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Uma chave de assinatura para um recurso de serviço de linguagem.

Tipo: apiKey
Em: header

Exemplos

Successful Get Project Deletion Status

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:: 200

{
  "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"
}

Definições

Nome	Description
ConversationalAnalysisAuthoringProjectDeletionJobState	Representa o estado de um trabalho de exclusão de projeto.
ConversationalAnalysisAuthoringWarning	Representa um aviso que foi encontrado durante a execução da solicitação.
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	O trabalho status.

ConversationalAnalysisAuthoringProjectDeletionJobState

Representa o estado de um trabalho de exclusão de projeto.

Nome	Tipo	Description
createdDateTime	string	A data de criação do trabalho.
errors	Error[]	Os erros encontrados durante a execução do trabalho.
expirationDateTime	string	A data de validade do trabalho.
jobId	string	A ID do trabalho.
lastUpdatedDateTime	string	A última data em que o trabalho foi atualizado.
status	JobStatus	O trabalho status.
warnings	ConversationalAnalysisAuthoringWarning[]	Os avisos que foram encontrados durante a execução do trabalho.

ConversationalAnalysisAuthoringWarning

Representa um aviso que foi encontrado durante a execução da solicitação.

Nome	Tipo	Description
code	string	O código de aviso.
message	string	A mensagem de aviso.

Error

O objeto de erro.

Nome	Tipo	Description
code	ErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo homem do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

Nome	Tipo	Description
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

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode