Conversational Analysis Authoring - Get Model Evaluation Results

Servicio:

Azure AI Services

Versión de la API:

2023-04-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?api-version=2023-04-01&stringIndexType=Utf16CodeUnit

Con parámetros opcionales:

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?api-version=2023-04-01&top={top}&skip={skip}&maxpagesize={maxpagesize}&stringIndexType=Utf16CodeUnit

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string
projectName	path	True	string	Nombre del nuevo proyecto.
trainedModelLabel	path	True	string	Etiqueta del modelo entrenado.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.
stringIndexType	query	True	StringIndexType	Especifica el método utilizado para interpretar los desplazamientos de cadena. Para obtener más información, consulte https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	Número máximo de elementos de resultado por página.
skip	query		integer int32	Número de elementos de resultado que se van a omitir.
top	query		integer int32	Número de elementos de resultado que se van a devolver.

Respuestas

Nombre	Tipo	Description
200 OK	PagedConversationalAnalysisAuthoringUtteranceEvaluationResult	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	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 Get Model Evaluation

Solicitud de ejemplo

HTTP

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

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": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-01&top=2147483637&skip=100&maxpagesize=100"
}

Definiciones

Nombre	Description
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 para personas.
ErrorResponse	Respuesta de error.
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.
PagedConversationalAnalysisAuthoringUtteranceEvaluationResult	Colección paginada de elementos ConversationalAnalysisAuthoringUtteranceEvaluationResult
StringIndexType

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 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. Esta es la 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 prevista de la expresión.

Error

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

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

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

PagedConversationalAnalysisAuthoringUtteranceEvaluationResult

Colección paginada de elementos ConversationalAnalysisAuthoringUtteranceEvaluationResult

Nombre	Tipo	Description
nextLink	string	Vínculo a la página siguiente de elementos
value	ConversationalAnalysisAuthoringUtteranceEvaluationResult[]	Los elementos ConversationalAnalysisAuthoringUtteranceEvaluationResult de esta página

StringIndexType

Nombre	Tipo	Description
Utf16CodeUnit	string	Los valores de desplazamiento y longitud se corresponden con unidades de código UTF-16. Use esta opción si la aplicación está escrita en un lenguaje que admita Unicode, por ejemplo Java, JavaScript.