Conversational Analysis Authoring - Get Export Status

Referência

Serviço:: Cognitive Services - Language

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

Obtém o estado de uma tarefa de exportação. Assim que a tarefa for concluída, devolve os metadados do projeto e os recursos.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com).
jobId	path	True	string	O ID do trabalho.
projectName	path	True	string	O nome do projeto a utilizar.
api-version	query	True	string	Versão da API de Cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Uma chave de subscrição para um recurso do Serviço de idiomas.

Respostas

Name	Tipo	Description
200 OK	ConversationalAnalysisAuthoringExportProjectJobState	O estado da operação de execução prolongada.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Uma chave de subscrição para um recurso do Serviço de idiomas.

Tipo: apiKey
Em: header

Exemplos

Successful Get Export Status

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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"
}

Definições

Name	Description
ConversationalAnalysisAuthoringExportProjectJobState	Representa o estado de uma tarefa de exportação.
ConversationalAnalysisAuthoringWarning	Representa um aviso que foi encontrado durante a execução do pedido.
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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	O estado da tarefa.

ConversationalAnalysisAuthoringExportProjectJobState

Representa o estado de uma tarefa de exportação.

Name	Tipo	Description
createdDateTime	string	A data de criação da tarefa.
errors	Error[]	Os erros encontrados ao executar a tarefa.
expirationDateTime	string	A data de expiração da tarefa.
jobId	string	O ID do trabalho.
lastUpdatedDateTime	string	A última data em que a tarefa foi atualizada.
resultUrl	string	O URL a utilizar para transferir o projeto exportado.
status	JobStatus	O estado da tarefa.
warnings	ConversationalAnalysisAuthoringWarning[]	Os avisos que foram encontrados durante a execução da tarefa.

ConversationalAnalysisAuthoringWarning

Representa um aviso que foi encontrado durante a execução do pedido.

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

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
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 por humanos do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

Name	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.

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode