¿Se usa APIs para análisis? - Amazon Lex
Filtrado de resultadosRecuperar las métricas de un botRecuperar los metadatos de las sesiones y los enunciados de un botRecuperar los metadatos de las sesiones y los enunciados de un botVisualización de las estadísticas de enunciado de las conversaciones de Lex V2

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

¿Se usa APIs para análisis?

En esta sección se describen las API operaciones que se utilizan para recuperar los análisis de un bot.

nota

Para usar la tecla ListUtteranceMetricsy ListUtteranceAnalyticsData, tu IAM rol debe tener permisos para realizar la ListAggregatedUtterancesoperación, lo que proporciona acceso a los análisis relacionados con las expresiones. Consulte Visualización de las estadísticas de enunciado de las conversaciones de Lex V2 los detalles y la IAM política que se debe aplicar al IAM rol.

Filtrado de resultados

Las API solicitudes de Analytics requieren que especifique la startTime y. endTime APIDevuelve las sesiones, las intenciones, las etapas de intención o las expresiones que comenzaron después de startTime y terminaron antes de. endTime

filterses un campo opcional en las solicitudes de AnalyticsAPI. Se asigna a una lista de AnalyticsSessionFilterAnalyticsIntentFilter, AnalyticsIntentStageFilter, u AnalyticsUtteranceFilterobjetos. En cada objeto, utilice los campos para crear una expresión por la que filtrar. Por ejemplo, si añade el siguiente filtro a la lista, el bot busca conversaciones que duren más de 30 segundos.

{
    "name": "Duration",
    "operator": "GT",
    "value": "30 sec",
}

Recuperar las métricas de un bot

Utilice las operaciones ListSessionMetrics, ListIntentMetrics, ListIntentStageMetrics y ListUtteranceMetrics para recuperar métricas resumidas de las sesiones, las intenciones, las etapas de intención y los enunciados.

Para estas operaciones, rellene los siguientes campos obligatorios:

  • Proporcione un startTime y un endTime para definir un intervalo de tiempo para el que desee recuperar los resultados.

  • Especifique las métricas que desea calcular en metrics una lista de AnalyticsSessionMetric, AnalyticsIntentMetricAnalyticsIntentStageMetric, u AnalyticsUtteranceMetricobjetos. En cada objeto, utilice el campo name para especificar la métrica para calcular el campo statistic y especificar si se debe calcular el número Sum, Average o Max, y el campo order para especificar si se deben ordenar los resultados en un orden Ascending o Descending.

    nota

    Tanto los objetos metrics como binBy contienen un campo order. Puede especificar la clasificación order solo en uno de los dos objetos.

El resto de los campos de la solicitud son opcionales. Puede filtrar y organizar los resultados de las siguientes maneras:

  • Filtrar los resultados: utilice el campo filters para filtrar los resultados. Consulte Filtrado de resultados para obtener más detalles.

  • Agrupar los resultados por categoría: especifique el groupBy campo, una lista que contenga un único AnalyticsSessionResultAnalyticsUtteranceResultobjeto. AnalyticsIntentResultAnalyticsIntentStageResult En el objeto, especifique el campo name con la categoría por la que desee agrupar los resultados.

    Si especificas un groupBy campo en la solicitud, el results objeto de la respuesta contiene groupByKeys una lista de AnalyticsSessionGroupByKey, AnalyticsIntentGroupByKey, u AnalyticsUtteranceGroupByKeyobjetos AnalyticsIntentStageGroupByKey, cada uno con los name que especificaste en la solicitud y un miembro de esa categoría en el value campo.

  • Clasificar los resultados por tiempo: especifique el binBy campo, una lista que contenga un único AnalyticsBinBySpecificationobjeto. En el objeto, especifique el campo name con ConversationStartTime para agrupar los resultados según el momento en que se inició la conversación o UtteranceTimestamp para agrupar los resultados según el momento en que tuvo lugar el enunciado. Especifique el intervalo de tiempo en el que desea agrupar los resultados en el campo interval y si desea ordenarlos por orden Ascending o Descending de tiempo en el campo order.

    Si especificas un binBy campo en la solicitud, el results objeto de la respuesta contiene binKeys una lista de AnalyticsBinKeyobjetos, cada uno con los name que especificaste en la solicitud y el intervalo de tiempo que define ese intervalo en el value campo.

    nota

    Tanto los objetos metrics como binBy contienen un campo order. Puede especificar la clasificación order solo en uno de los dos objetos.

Utilice los siguientes campos para gestionar la visualización de la respuesta:

  • Especifique un número entre 1 y 1000 en el campo maxResults para limitar el número de resultados que se devolverán en una sola respuesta.

  • Si el número de resultados es mayor que el número que especificó en el campo maxResults, la respuesta contiene un nextToken. Vuelva a realizar la solicitud, pero utilice este valor en el campo nextToken para devolver el siguiente lote de resultados.

Si está utilizando ListUtteranceMetrics, puede especificar los atributos que se devolverán en el campo attributes. Este campo se asigna a una lista que contiene un único AnalyticsUtteranceAttributeobjeto. Especifique LastUsedIntent en el campo name para devolver la intención que utiliza Amazon Lex V2 en el momento del enunciado.

En la respuesta, el results campo se asigna a una lista de AnalyticsSessionResultAnalyticsIntentResult, AnalyticsIntentStageResult, u AnalyticsUtteranceResultobjetos. Cada objeto contiene un campo metrics que devuelve el valor de una estadística resumida de una métrica que haya solicitado, además de los contenedores o grupos creados a partir de los métodos que haya especificado.

Recuperar los metadatos de las sesiones y los enunciados de un bot

Utilice las ListUtteranceAnalyticsDataoperaciones ListSessionAnalyticsDatay para recuperar metadatos sobre sesiones y expresiones individuales.

Rellene los campos startTime y endTime obligatorios para definir el intervalo de tiempo para el que desee recuperar los resultados.

El resto de los campos de la solicitud son opcionales. Para filtrar y ordenar los resultados:

  • Filtrar los resultados: utilice el campo filters para filtrar los resultados. Consulte Filtrado de resultados para obtener más detalles.

  • Ordenar los resultados: ordena los resultados con el sortBy campo, que contiene un UtteranceDataSortByobjeto SessionDataSortByo. Especifique el valor por el que desea ordenarlos en el campo name y si desea ordenarlos de forma Ascending o Descending en el campo order.

Utilice los siguientes campos para gestionar la visualización de la respuesta:

  • Especifique un número entre 1 y 1000 en el campo maxResults para limitar el número de resultados que se devolverán en una sola respuesta.

  • Si el número de resultados es mayor que el número que especificó en el campo maxResults, la respuesta contiene un nextToken. Vuelva a realizar la solicitud, pero utilice este valor en el campo nextToken para devolver el siguiente lote de resultados.

En la respuesta, el utterances campo sessions o se asigna a una lista de UtteranceSpecificationobjetos SessionSpecificationo. Cada objeto contiene metadatos para una sola sesión o enunciado.

Recuperar los metadatos de las sesiones y los enunciados de un bot

Usa la ListIntentPathsoperación para recuperar métricas sobre un orden de intenciones que los clientes adoptan cuando conversan con un bot.

Para esta operación, rellene los siguientes campos obligatorios:

  • Proporcione un startTime y un endTime para definir un intervalo de tiempo para el que desee recuperar los resultados.

  • Proporcione un intentPath para definir un orden de intenciones para el que desea recuperar métricas. Separe las intenciones de la ruta con una barra diagonal. Por ejemplo, rellene el campo intentPath con /BookCar/BookHotel para ver información detallada sobre el número de veces que los usuarios han invocado las intenciones BookCar y BookHotel en ese orden.

Use el campo filters opcional para filtrar los resultados. Para obtener más información, consulte Filtrado de resultados.

Visualización de las estadísticas de enunciado de las conversaciones de Lex V2

Puede utilizar las estadísticas de enunciados para determinar los enunciados que los usuarios envían a su bot. Puede ver tanto los enunciados que Amazon Lex V2 detecta correctamente como los que no reconoce. Puede utilizar esta información para ajustar su bot.

Por ejemplo, si descubre que sus usuarios envían un enunciado que falta en Amazon Lex V2, puede añadir el enunciado a una intención. La versión preliminar de la intención se actualiza con el nuevo enunciado y puede probarlo antes de implementarlo en su bot.

Se detecta un enunciado cuando Amazon Lex V2 reconoce el enunciado como un intento de invocar una intención configurada para un bot. Se pierde un enunciado cuando Amazon Lex V2 no lo reconoce y, en su lugar, invoca AMAZON.FallbackIntent.

Las estadísticas de enunciado se pueden ver utilizando las ListUtteranceMetrics API y las. ListAggregatedUtterance API

Las estadísticas de enunciado no se generan ListUtteranceMetrics API en las siguientes condiciones:

  • La configuración de la Ley de Protección de la Privacidad en Línea para Niños se estableció como Sí cuando se creó el bot con la consola, o el campo childDirected se estableció en verdadero cuando se creó el bot con la operación CreateBot.

ListUtteranceMetricsAPIProporciona funciones adicionales, entre las que se incluyen:

  • Hay más información disponible, como la intención mapeada de los enunciados detectados.

  • Más capacidad de filtrado (incluidos el canal y el modo).

  • Intervalo de fechas de retención más prolongado (30 días).

  • Puede utilizar el API incluso si ha optado por no almacenar datos. Se basará en la funcionalidad de la consola para las expresiones omitidas o detectadas ListUtteranceMetricsAPI.

Las estadísticas de los enunciados no se generan ListAggregatedUtterance API en las siguientes condiciones:

  • La configuración de la Ley de Protección de la Privacidad en Línea para Niños se estableció como Sí cuando se creó el bot con la consola, o el campo childDirected se estableció en verdadero cuando se creó el bot con la operación CreateBot.

  • Está utilizando la ofuscación de slots con uno o más slots.

  • Ha optado por no participar en la mejora de Amazon Lex.

ListAggregatedUtteranceAPIOfrece funciones que incluyen:

  • Menos información detallada disponible (sin la intención mapeada de los enunciados).

  • Capacidad de filtrado limitada (sin incluir el canal y el modo).

  • Intervalo de fechas de retención más corto (15 días).

Con las estadísticas de enunciados, puede ver si se detectó o no se detectó un enunciado específico, así como la última vez que se utilizó el enunciado en una interacción con un bot.

Amazon Lex V2 almacena los enunciados continuamente mientras los usuarios interactúan con su bot. Puede consultar las estadísticas mediante la consola o la operación ListAggregatedUtterances. Tiene una retención de datos de 15 días y no está disponible si el usuario ha optado por no almacenarlos. Puede eliminar los enunciados mediante la operación DeleteUtterances u optando por no almacenar datos. Todos los enunciados se eliminan si cierras tu AWS cuenta. Los enunciados almacenados se cifran con una clave gestionada por el servidor.

Cuando elimina una versión de bot, las estadísticas de enunciados de la versión estarán disponibles durante un máximo de 30 días con ListUtteranceMetrics, y 15 días usando ListAggregatedUtterances. No puede ver las estadísticas de la versión eliminada en la consola de Amazon Lex V2. Para ver las estadísticas de las versiones eliminadas, puede usar ambas operaciones ListAggregatedUtterances y ListUtteranceMetrics.

Tanto con la letra ListAggregatedUtterances como con ListUtteranceMetricsAPIs, las expresiones se agregan según el texto de la expresión. Por ejemplo, todas las instancias en las que el cliente utilizó la frase «Quiero pedir una pizza» se agrupan en la misma línea en una respuesta. Cuando se utiliza la RecognizeUtteranceoperación, el texto que se utiliza es la transcripción de entrada.

Para usar la ListAggregatedUtterances y ListUtteranceMetricsAPIs, aplique la siguiente política a un rol.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "ListAggregatedUtterancesPolicy",
            "Effect": "Allow",
            "Action": "lex:ListAggregatedUtterances",
            "Resource": "*"
        }
    ]
}