Conversational Analysis Authoring - Train

Referência

Serviço:: Cognitive Services - Language

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

Dispara um trabalho de treinamento para um projeto.

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:train?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).
projectName	path	True	string	O nome do projeto a ser usado.
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.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
modelLabel	True	string	Representa o rótulo do modelo de saída.
trainingMode	True	TrainingMode	Representa o modo da operação de treinamento.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Representa as opções de avaliação. Por padrão, o tipo de avaliação é percentual, com percentual de divisão de treinamento como 80 e percentual de divisão de teste como 20.
trainingConfigVersion		string	Representa a versão de configuração de treinamento. Por padrão, o valor "mais recente" é usado, que usa a versão mais recente da configuração de treinamento lançada.

Respostas

Nome	Tipo	Description
202 Accepted		Uma chamada bem-sucedida resulta em um cabeçalho Operation-Location usado para verificar o status do trabalho. Cabeçalhos operation-location: string
Other Status Codes	ErrorResponse	Resposta de erro.

Nome

Tipo

Description

202 Accepted

Uma chamada bem-sucedida resulta em um cabeçalho Operation-Location usado para verificar o status do trabalho.

Cabeçalhos

operation-location: string

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

Solicitação de exemplo

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 de exemplo

Código de status:: 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

Nome	Description
ConversationalAnalysisAuthoringEvaluationOptions	Representa as opções usadas na execução da avaliação.
ConversationalAnalysisAuthoringTrainingJobOptions	Representa as opções para iniciar um novo trabalho de treinamento.
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 padrão, o tipo de avaliação é definido como percentual.
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.
TrainingMode	Representa o modo da operação de treinamento.

ConversationalAnalysisAuthoringEvaluationOptions

Representa as opções usadas na execução da avaliação.

Nome	Tipo	Description
kind	EvaluationKind	Representa o tipo de avaliação. Por padrão, o tipo de avaliação é definido como percentual.
testingSplitPercentage	integer	Representa o percentual de divisão do conjunto de dados de teste. Necessário somente caso o tipo de avaliação seja percentual.
trainingSplitPercentage	integer	Representa o percentual de divisão do conjunto de dados de treinamento. Necessário somente caso o tipo de avaliação seja percentual.

ConversationalAnalysisAuthoringTrainingJobOptions

Representa as opções para iniciar um novo trabalho de treinamento.

Nome	Tipo	Description
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Representa as opções de avaliação. Por padrão, o tipo de avaliação é percentual, com percentual de divisão de treinamento como 80 e percentual de divisão de teste como 20.
modelLabel	string	Representa o rótulo do modelo de saída.
trainingConfigVersion	string	Representa a versão de configuração de treinamento. Por padrão, o valor "mais recente" é usado, que usa a versão mais recente da configuração de treinamento lançada.
trainingMode	TrainingMode	Representa o modo da operação de treinamento.

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.

EvaluationKind

Representa o tipo de avaliação. Por padrão, o tipo de avaliação é definido como percentual.

Nome	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 treinamento e teste de acordo com percentuais definidos pelo usuário.

InnerErrorCode

Código de erro legível por humanos.

Nome	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 API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Description
code	InnerErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
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 treinamento.

Nome	Tipo	Description
advanced	string	Treina usando modelos de transformador de rede neural ajustados. Pode treinar projetos multilíngues.
standard	string	Tempos de treinamento mais rápidos para iterações mais rápidas.

Compartilhar via

Conversational Analysis Authoring - Train

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Successful Train Project

Solicitação de exemplo

Resposta de exemplo

Definições

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

Recursos adicionais