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 operaciones de la API que se utilizan para recuperar los análisis de un bot.
**nota**
Para usar [ListUtteranceMetrics](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListUtteranceMetrics.html)y [ListUtteranceAnalyticsData](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListUtteranceAnalyticsData.html), su función de IAM debe tener permisos para realizar la [ListAggregatedUtterances](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html)operació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](#monitoring-utterances) para obtener información detallada y la política de IAM que se debe aplicar al rol de IAM.
+ Las siguientes operaciones de la API recuperan las métricas resumidas de un bot:
+ [ListSessionMetrics](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSessionMetrics.html)
+ [ListIntentMetrics](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntentMetrics.html)
+ [ListIntentStageMetrics](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntentStageMetrics.html)
+ [ListUtteranceMetrics](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListUtteranceMetrics.html)
+ Las siguientes operaciones de la API recuperan una lista de metadatos para sesiones y enunciados:
+ [ListSessionAnalyticsData](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSessionAnalyticsData.html)
+ [ListUtteranceAnalyticsData](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListUtteranceAnalyticsData.html)
+ La [ListIntentPaths](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntentPaths.html)operación recupera métricas sobre el orden de intenciones que los clientes adoptan cuando conversan con un bot.
## Filtrado de resultados
Las solicitudes de la API de Analytics requieren que especifique el `startTime` y el `endTime`. La API devuelve las sesiones, las intenciones, las etapas de intención o los enunciados que comenzaron *después del* `startTime` y finalizaron *antes del* `endTime`.
`filters` es un campo opcional en las solicitudes de la API de Analytics. Se asigna a una lista de [AnalyticsSessionFilter](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsSessionFilter.html), [AnalyticsIntentFilter[AnalyticsIntentStageFilter](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentStageFilter.html)](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentFilter.html), u [AnalyticsUtteranceFilter](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceFilter.html)objetos. 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](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsSessionMetric.html), [AnalyticsIntentMetric[AnalyticsIntentStageMetric](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentStageMetric.html)](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentMetric.html), u [AnalyticsUtteranceMetric](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceMetric.html)objetos. 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](#analytics-api-filters) para obtener más detalles.
+ **Agrupar los resultados por categoría**: especifique el `groupBy` campo, una lista que contenga un único [AnalyticsSessionResult](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsSessionResult.html), [AnalyticsIntentResult[AnalyticsIntentStageResult](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentStageResult.html)](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentResult.html), o un [AnalyticsUtteranceResult](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceResult.html)objeto. En el objeto, especifique el campo `name` con la categoría por la que desee agrupar los resultados.
Si especifica un `groupBy` campo en la solicitud, el `results` objeto de la respuesta contendrá `groupByKeys` una lista de [AnalyticsSessionGroupByKey](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsSessionGroupByKey.html), [AnalyticsIntentGroupByKey](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentGroupByKey.html), u [AnalyticsUtteranceGroupByKey](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceGroupByKey.html)objetos [AnalyticsIntentStageGroupByKey](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentStageGroupByKey.html), cada uno con los `name` que especificó 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 [AnalyticsBinBySpecification](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsBinBySpecification.html)objeto. 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 [AnalyticsBinKey](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsBinKey.html)objetos, 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 [AnalyticsUtteranceAttribute](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceAttribute.html)objeto. 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 [AnalyticsSessionResult[AnalyticsIntentResult](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentResult.html)](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsSessionResult.html), [AnalyticsIntentStageResult](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsIntentStageResult.html), u [AnalyticsUtteranceResult](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_AnalyticsUtteranceResult.html)objetos. 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 [ListUtteranceAnalyticsData](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListUtteranceAnalyticsData.html)operaciones [ListSessionAnalyticsData](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSessionAnalyticsData.html)y 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](#analytics-api-filters) para obtener más detalles.
+ **Ordenar los resultados**: ordena los resultados con el `sortBy` campo, que contiene un [UtteranceDataSortBy](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UtteranceDataSortBy.html)objeto [SessionDataSortBy](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_SessionDataSortBy.html)o. 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 [UtteranceSpecification](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UtteranceSpecification.html)objetos [SessionSpecification](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_SessionSpecification.html)o. Cada objeto contiene metadatos para una sola sesión o enunciado.
## Recuperación de datos de análisis de la ruta de intención
Utilice la [ListIntentPaths](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntentPaths.html)operación para recuperar las métricas sobre el 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](#analytics-api-filters).
## 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 del enunciado se pueden consultar mediante la API de `ListUtteranceMetrics` y la API de `ListAggregatedUtterance`.
Las estadísticas de los enunciados no se generan mediante la API de `ListUtteranceMetrics` 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`.
La API de `ListUtteranceMetrics` ofrece 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 usar la API incluso si ha optado por no almacenar datos. La funcionalidad de la consola para los enunciados perdidos o detectados dependerá de la API de `ListUtteranceMetrics`.
Las estadísticas de los enunciados no se generan mediante la API de `ListAggregatedUtterance` 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.
La API de `ListAggregatedUtterance` ofrece funciones como:
+ 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. Si cierra su cuenta de AWS, se eliminan todos los enunciados. 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 `ListUtteranceMetrics` APIs, las expresiones se agrupan 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 [RecognizeUtterance](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeUtterance.html)operación, el texto que se utiliza es la transcripción de entrada.
Para usar la `ListAggregatedUtterances` y `ListUtteranceMetrics` APIs, aplique la siguiente política a un rol.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "ListAggregatedUtterancesPolicy",
"Effect": "Allow",
"Action": "lex:ListAggregatedUtterances",
"Resource": "*"
}
]
}
```
------