Conversational Analysis Authoring - Train
Desencadena un trabajo de entrenamiento para un proyecto.
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:train?api-version=2023-04-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
|
project
|
path | True |
string |
Nombre del proyecto que se va a usar. |
api-version
|
query | True |
string |
Versión de la API que se va a usar para esta operación. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
modelLabel | True |
string |
Representa la etiqueta del modelo de salida. |
trainingMode | True |
Representa el modo de la operación de entrenamiento. |
|
evaluationOptions |
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 |
La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Encabezados Operation-Location: string |
|
Other Status Codes |
Una respuesta de error inesperada. |
Seguridad
Ocp-Apim-Subscription-Key
Tipo:
apiKey
En:
header
OAuth2Auth
Tipo:
oauth2
Flujo:
accessCode
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token:
https://login.microsoftonline.com/common/oauth2/token
Ámbitos
Nombre | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Ejemplos
Successful Train Project
Solicitud de ejemplo
POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:train?api-version=2023-04-01
{
"modelLabel": "model1",
"trainingMode": "standard",
"trainingConfigVersion": "latest",
"evaluationOptions": {
"kind": "percentage",
"testingSplitPercentage": 20,
"trainingSplitPercentage": 80
}
}
Respuesta de muestra
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Definiciones
Nombre | Description |
---|---|
Conversational |
Representa las opciones usadas para ejecutar la evaluación. |
Conversational |
Representa las opciones para iniciar un nuevo trabajo de entrenamiento. |
Error |
Objeto de error. |
Error |
Código de error legible para personas. |
Error |
Respuesta de error. |
Evaluation |
|
Inner |
Código de error legible para personas. |
Inner |
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. |
Training |
ConversationalAnalysisAuthoringEvaluationOptions
Representa las opciones usadas para ejecutar la evaluación.
Nombre | Tipo | Description |
---|---|---|
kind |
Representa el tipo de evaluación. De forma predeterminada, el tipo de evaluación se establece en porcentaje. |
|
testingSplitPercentage |
integer |
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 |
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
Representa las opciones para iniciar un nuevo trabajo de entrenamiento.
Nombre | Tipo | Description |
---|---|---|
evaluationOptions |
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 |
Representa el modo de la operación de entrenamiento. |
Error
Objeto de error.
Nombre | Tipo | Description |
---|---|---|
code |
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 |
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
Código de error legible para personas.
Nombre | 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
Respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
Objeto de error. |
EvaluationKind
Nombre | Tipo | Description |
---|---|---|
manual |
string |
Divida los datos según el conjunto de datos elegido para cada ejemplo de los datos. |
percentage |
string |
Divida los datos en conjuntos de entrenamiento y pruebas según porcentajes definidos por el usuario. |
InnerErrorCode
Código de error legible para personas.
Nombre | 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
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 |
Uno de un conjunto definido por el servidor de códigos de error. |
|
details |
object |
Detalles del error. |
innererror |
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
Nombre | Tipo | Description |
---|---|---|
advanced |
string |
Entrena mediante modelos de transformadores de red neuronal ajustados. Puede entrenar proyectos multilingües. |
standard |
string |
Tiempos de entrenamiento más rápidos para iteraciones más rápidas. |