Conversational Analysis Authoring - Train

Servicio:

Azure AI Services

Versión de la API:

2022-05-01

Desencadena un trabajo de entrenamiento para un proyecto.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Nombre del proyecto que se va a usar.
api-version	query	True	string	Versión de la API de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Una clave de suscripción para un recurso de servicio de lenguaje.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
modelLabel	True	string	Representa la etiqueta del modelo de salida.
trainingMode	True	TrainingMode	Representa el modo de la operación de entrenamiento.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Representa las opciones de evaluación. De forma predeterminada, el tipo de evaluación es porcentaje, con el porcentaje de división de entrenamiento como 80 y el porcentaje de división de pruebas como 20.
trainingConfigVersion		string	Representa la versión de configuración de entrenamiento. De forma predeterminada, se usa el valor "latest" que usa la versión de configuración de entrenamiento publicada más reciente.

Respuestas

Nombre	Tipo	Description
202 Accepted		Una llamada correcta devuelve un encabezado Operation-Location que se usa para comprobar el estado del trabajo. Encabezados operation-location: string
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Una clave de suscripción para un recurso de servicio de lenguaje.

Tipo: apiKey
En: header

Ejemplos

Successful Train Project

Solicitud de ejemplo

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

Respuesta de muestra

status code:

202

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

Definiciones

Nombre	Description
ConversationalAnalysisAuthoringEvaluationOptions	Representa las opciones usadas para ejecutar la evaluación.
ConversationalAnalysisAuthoringTrainingJobOptions	Representa las opciones para iniciar un nuevo trabajo de entrenamiento.
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
EvaluationKind	Representa el tipo de evaluación. De forma predeterminada, el tipo de evaluación se establece en porcentaje.
InnerErrorCode	Código de error legible para personas.
InnerErrorModel	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingMode	Representa el modo de la operación de entrenamiento.

ConversationalAnalysisAuthoringEvaluationOptions

Object

Representa las opciones usadas para ejecutar la evaluación.

Nombre	Tipo	Description
kind	EvaluationKind	Representa el tipo de evaluación. De forma predeterminada, el tipo de evaluación se establece en porcentaje.
testingSplitPercentage	integer (int32)	Representa el porcentaje de división del conjunto de datos de prueba. Solo es necesario en caso de que el tipo de evaluación sea porcentaje.
trainingSplitPercentage	integer (int32)	Representa el porcentaje de división del conjunto de datos de entrenamiento. Solo es necesario en caso de que el tipo de evaluación sea porcentaje.

ConversationalAnalysisAuthoringTrainingJobOptions

Object

Representa las opciones para iniciar un nuevo trabajo de entrenamiento.

Nombre	Tipo	Description
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Representa las opciones de evaluación. De forma predeterminada, el tipo de evaluación es porcentaje, con el porcentaje de división de entrenamiento como 80 y el porcentaje de división de pruebas como 20.
modelLabel	string	Representa la etiqueta del modelo de salida.
trainingConfigVersion	string	Representa la versión de configuración de entrenamiento. De forma predeterminada, se usa el valor "latest" que usa la versión de configuración de entrenamiento publicada más reciente.
trainingMode	TrainingMode	Representa el modo de la operación de entrenamiento.

Error

Object

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

EvaluationKind

Enumeración

Representa el tipo de evaluación. De forma predeterminada, el tipo de evaluación se establece en porcentaje.

Valor	Description
manual	Divida los datos según el conjunto de datos elegido para cada ejemplo de los datos.
percentage	Divida los datos en conjuntos de entrenamiento y pruebas según porcentajes definidos por el usuario.

InnerErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	InnerErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

TrainingMode

Enumeración

Representa el modo de la operación de entrenamiento.

Valor	Description
advanced	Entrena mediante modelos de transformadores de red neuronal ajustados. Puede entrenar proyectos multilingües.
standard	Tiempos de entrenamiento más rápidos para iteraciones más rápidas.