Conversational Analysis Authoring - Get Training Status

Referência

Serviço:: Cognitive Services - Language

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

Obtém o estado de um trabalho de formação.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/train/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	ConversationalAnalysisAuthoringTrainingJobState	O resultado da tarefa de preparação.
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 Train Status

Pedido de amostra

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2022-05-01

Resposta da amostra

Código de estado:: 200

{
  "result": {
    "modelLabel": "model1",
    "trainingConfigVersion": "2022-05-01",
    "trainingMode": "standard",
    "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
    "trainingStatus": {
      "percentComplete": 3,
      "startDateTime": "2022-04-18T15:45:06.8190649Z",
      "status": "running"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "status": "notStarted"
    }
  },
  "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}

Definições

Name	Description
ConversationalAnalysisAuthoringSubTrainingJobState	Representa o estado detalhado de uma sub-operação de preparação.
ConversationalAnalysisAuthoringTrainingJobResult	Representa o resultado de uma tarefa de preparação.
ConversationalAnalysisAuthoringTrainingJobState	Representa o estado de um trabalho de formaçã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.
TrainingMode	Representa o modo da operação de preparação.

ConversationalAnalysisAuthoringSubTrainingJobState

Representa o estado detalhado de uma sub-operação de preparação.

Name	Tipo	Description
endDateTime	string	Representa a data de fim.
percentComplete	integer	Representa a percentagem de progresso.
startDateTime	string	Representa a hora da data de início.
status	JobStatus	Representa o estado da sub-operação.

ConversationalAnalysisAuthoringTrainingJobResult

Representa o resultado de uma tarefa de preparação.

Name	Tipo	Description
estimatedEndDateTime	string	Representa a data de fim estimada para preparação e avaliação.
evaluationStatus	ConversationalAnalysisAuthoringSubTrainingJobState	Representa o estado de avaliação do modelo.
modelLabel	string	Representa uma etiqueta de modelo preparada.
trainingConfigVersion	string	Representa a versão de configuração de preparação.
trainingMode	TrainingMode	Representa o modo da operação de preparação.
trainingStatus	ConversationalAnalysisAuthoringSubTrainingJobState	Representa o estado de preparação do modelo.

ConversationalAnalysisAuthoringTrainingJobState

Representa o estado de um trabalho de formaçã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.
result	ConversationalAnalysisAuthoringTrainingJobResult	Representa o resultado detalhado das tarefas de preparação.
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 matriz de detalhes sobre erros específicos que levaram a este erro reportado.
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