Conversational Analysis Authoring - Get Model Evaluation Results

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2022-05-01

Obtiene los resultados detallados de la evaluación de un modelo entrenado. Esto incluye los resultados de inferencia sin procesar para los datos incluidos en el proceso de evaluación.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?stringIndexType=Utf16CodeUnit&api-version=2022-05-01

Con parámetros opcionales:

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?stringIndexType=Utf16CodeUnit&top={top}&skip={skip}&maxpagesize={maxpagesize}&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	Nombre del proyecto que se va a usar.
trainedModelLabel	path	True	string	Etiqueta del modelo entrenado.
api-version	query	True	string	Versión de API del cliente.
stringIndexType	query	True	StringIndexType	Especifica el método utilizado para interpretar los desplazamientos de cadena. Para más información, vea https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	Número máximo de recursos que se van a incluir en una única respuesta.
skip	query		integer int32	Desplazamiento en la colección del primer recurso que se va a devolver.
top	query		integer int32	Número máximo de recursos que se van a devolver de la colección.

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.

Respuestas

Nombre	Tipo	Description
200 OK	ConversationalAnalysisAuthoringEvaluationResults	Lista de las predicciones de evaluación.
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 Get Model Evaluation

Solicitud de ejemplo

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result?stringIndexType=Utf16CodeUnit&maxpagesize=10&api-version=2022-05-01

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "text": "send the email",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [],
        "predictedEntities": []
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "send a mail to daniel",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 15,
            "length": 6
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 15,
            "length": 6
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "i forgot to add an important part to that email to james . please set it up to edit",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 51,
            "length": 5
          }
        ],
        "predictedEntities": [
          {
            "category": "Category",
            "offset": 19,
            "length": 9
          },
          {
            "category": "ContactName",
            "offset": 51,
            "length": 5
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "AddMore",
        "predictedIntent": "AddMore"
      }
    },
    {
      "text": "send email to a and tian",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 14,
            "length": 1
          },
          {
            "category": "ContactName",
            "offset": 20,
            "length": 4
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 14,
            "length": 1
          },
          {
            "category": "ContactName",
            "offset": 20,
            "length": 4
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "send thomas an email",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 5,
            "length": 6
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 5,
            "length": 6
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "i need to add more to the email message i am sending to vincent",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 56,
            "length": 7
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 56,
            "length": 7
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "AddMore",
        "predictedIntent": "AddMore"
      }
    },
    {
      "text": "send an email to lily roth and abc123@microsoft.com",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 9
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 9
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "i need to add something else to my email to cheryl",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 44,
            "length": 6
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 44,
            "length": 6
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "AddMore",
        "predictedIntent": "AddMore"
      }
    },
    {
      "text": "send an email to larry , joseph and billy larkson",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 5
          },
          {
            "category": "ContactName",
            "offset": 25,
            "length": 6
          },
          {
            "category": "ContactName",
            "offset": 36,
            "length": 13
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 5
          },
          {
            "category": "ContactName",
            "offset": 25,
            "length": 6
          },
          {
            "category": "ContactName",
            "offset": 36,
            "length": 13
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "send mail to dorothy",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 13,
            "length": 7
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 13,
            "length": 7
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    }
  ],
  "nextLink": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2022-05-01&top=2147483637&skip=10&maxpagesize=10"
}

Definiciones

Nombre	Description
ConversationalAnalysisAuthoringEvaluationResults	Representa una lista de los resultados de evaluación de expresiones.
ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	Representa la comparación entre las entidades esperadas y predichas de una expresión.
ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult	Representa la salida de evaluación de una etiqueta o predicción de entidad.
ConversationalAnalysisAuthoringUtteranceEvaluationResult	Representa el resultado de evaluación de una expresión.
ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	Representa la comparación entre la intención esperada y la predicción de una expresión.
Error	Objeto de error.
ErrorCode	Código de error legible.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible.
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.
StringIndexType	Especifica el método utilizado para interpretar los desplazamientos de cadena. Para más información, vea https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringEvaluationResults

Representa una lista de los resultados de evaluación de expresiones.

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente.
value	ConversationalAnalysisAuthoringUtteranceEvaluationResult[]	Resultados de evaluación de expresiones.

ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult

Representa la comparación entre las entidades esperadas y predichas de una expresión.

Nombre	Tipo	Description
expectedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	Representa las etiquetas de entidad esperadas.
predictedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	Representa las etiquetas de entidad previstas.

ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult

Representa la salida de evaluación de una etiqueta o predicción de entidad.

Nombre	Tipo	Description
category	string	Representa la categoría de entidad.
length	integer	Representa la longitud de la entidad.
offset	integer	Representa el índice de desplazamiento de la entidad en relación con el texto original.

ConversationalAnalysisAuthoringUtteranceEvaluationResult

Representa el resultado de evaluación de una expresión.

Nombre	Tipo	Description
entitiesResult	ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	Representa los resultados de las entidades de la expresión.
intentsResult	ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	Representa los resultados de las intenciones de la expresión.
language	string	Representa el lenguaje de expresión. Se trata de una representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc.
text	string	Representa el texto de la expresión.

ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult

Representa la comparación entre la intención esperada y la predicción de una expresión.

Nombre	Tipo	Description
expectedIntent	string	Representa la intención esperada de la expresión.
predictedIntent	string	Representa la intención predicha de la expresión.

Error

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Uno de los conjuntos de códigos de error definidos por el servidor.
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

Código de error legible.

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	Error	Objeto de error.

InnerErrorCode