Conversational Analysis Authoring - Train

Referência

Serviço:: Cognitive Services - Language

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

Aciona uma tarefa de preparação para um projeto.

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:train?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).
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.

Corpo do Pedido

Name	Necessário	Tipo	Description
modelLabel	True	string	Representa a etiqueta do modelo de saída.
trainingMode	True	TrainingMode	Representa o modo da operação de preparação.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Representa as opções de avaliação. Por predefinição, o tipo de avaliação é percentagem, com a percentagem de divisão de preparação como 80 e a percentagem de teste dividida como 20.
trainingConfigVersion		string	Representa a versão de configuração de preparação. Por predefinição, é utilizado o valor "mais recente", que utiliza a versão de configuração de preparação mais recente lançada.

Respostas

Name	Tipo	Description
202 Accepted		Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa. Cabeçalhos operation-location: string
Other Status Codes	ErrorResponse	Resposta de erro.

Name

Tipo

Description

202 Accepted

Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa.

Cabeçalhos

operation-location: string

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 Train Project

Pedido de amostra

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:train?api-version=2022-05-01


{
  "modelLabel": "model1",
  "trainingMode": "standard",
  "trainingConfigVersion": "latest",
  "evaluationOptions": {
    "kind": "percentage",
    "testingSplitPercentage": 20,
    "trainingSplitPercentage": 80
  }
}

Resposta da amostra

Código de estado:: 202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Definições

Name	Description
ConversationalAnalysisAuthoringEvaluationOptions	Representa as opções utilizadas para executar a avaliação.
ConversationalAnalysisAuthoringTrainingJobOptions	Representa as opções para iniciar uma nova tarefa de preparação.
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
EvaluationKind	Representa o tipo de avaliação. Por predefinição, o tipo de avaliação está definido como percentagem.
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.
TrainingMode	Representa o modo da operação de preparação.

ConversationalAnalysisAuthoringEvaluationOptions

Representa as opções utilizadas para executar a avaliação.

Name	Tipo	Description
kind	EvaluationKind	Representa o tipo de avaliação. Por predefinição, o tipo de avaliação está definido como percentagem.
testingSplitPercentage	integer	Representa a percentagem de divisão do conjunto de dados de teste. Só é necessário caso o tipo de avaliação seja percentagem.
trainingSplitPercentage	integer	Representa a percentagem de divisão do conjunto de dados de preparação. Só é necessário caso o tipo de avaliação seja percentagem.

ConversationalAnalysisAuthoringTrainingJobOptions

Representa as opções para iniciar uma nova tarefa de preparação.

Name	Tipo	Description
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Representa as opções de avaliação. Por predefinição, o tipo de avaliação é percentagem, com a percentagem de divisão de preparação como 80 e a percentagem de teste dividida como 20.
modelLabel	string	Representa a etiqueta do modelo de saída.
trainingConfigVersion	string	Representa a versão de configuração de preparação. Por predefinição, é utilizado o valor "mais recente", que utiliza a versão de configuração de preparação mais recente lançada.
trainingMode	TrainingMode	Representa o modo da operação de preparação.

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.

EvaluationKind

Representa o tipo de avaliação. Por predefinição, o tipo de avaliação está definido como percentagem.

Name	Tipo	Description
manual	string	Divida os dados de acordo com o conjunto de dados escolhido para cada exemplo nos dados.
percentage	string	Divida os dados em conjuntos de preparação e teste de acordo com percentagens definidas pelo utilizador.

InnerErrorCode

Código de erro legível por humanos.

Name	Tipo	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

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.

Name	Tipo	Description
code	InnerErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Destino do erro.

TrainingMode

Representa o modo da operação de preparação.

Name	Tipo	Description
advanced	string	Prepara-se com modelos de transformador de rede neural otimizados. Pode preparar projetos multilingues.
standard	string	Tempos de preparação mais rápidos para iterações mais rápidas.

Partilhar via

Conversational Analysis Authoring - Train

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Successful Train Project

Pedido de amostra

Resposta da amostra

Definições

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

Recursos adicionais