Für Analysen verwenden APIs - Amazon Lex

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Für Analysen verwenden APIs

In diesem Abschnitt werden die API Operationen beschrieben, mit denen Sie Analysen für einen Bot abrufen.

Anmerkung

Um das ListUtteranceMetricsund verwenden zu können ListUtteranceAnalyticsData, muss Ihre IAM Rolle über die erforderlichen Berechtigungen für die Ausführung des ListAggregatedUtterancesVorgangs verfügen, der Zugriff auf Analysen im Zusammenhang mit Äußerungen bietet. Einzelheiten und die Äußerungsstatistiken von Lex V2-Konversationen anzeigen für die Rolle IAM geltenden Richtlinien finden Sie unter. IAM

Filtern von Ergebnissen

Bei den API Analytics-Anfragen müssen Sie den Wert und angeben. startTime endTime Das API gibt Sitzungen, Absichten, Absichtsphasen oder Äußerungen zurück, die nach dem begannen startTime und vor dem endeten. endTime

filtersist ein optionales Feld in den API Analytics-Anfragen. Es wird einer Liste von AnalyticsSessionFilter, AnalyticsIntentFilterAnalyticsIntentStageFilter, oder AnalyticsUtteranceFilterObjekten zugeordnet. Verwenden Sie in jedem Objekt die Felder, um einen Ausdruck zu erstellen, nach dem gefiltert werden soll. Wenn Sie der Liste beispielsweise den folgenden Filter hinzufügen, sucht der Bot nach Konversationen, die länger als 30 Sekunden dauern.

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

Metriken für einen Bot abrufen

Verwenden Sie die ListUtteranceMetrics Operationen ListSessionMetricsListIntentMetrics,ListIntentStageMetrics, und, um zusammenfassende Kennzahlen für Sitzungen, Absichten, Absichtsphasen und Äußerungen abzurufen.

Füllen Sie für diese Operationen die folgenden Pflichtfelder aus:

  • Geben Sie ein startTime und einendTime, um einen Zeitraum zu definieren, für den Sie Ergebnisse abrufen möchten.

  • Geben Sie die Metriken, die Sie berechnen möchtenmetrics, eine Liste von AnalyticsSessionMetricAnalyticsIntentMetric, AnalyticsIntentStageMetric, oder AnalyticsUtteranceMetricObjekten an. Verwenden Sie in jedem Objekt das name Feld, um die Metrik für die Berechnung anzugeben, das statistic Feld, um anzugeben, ob die Max Zahl SumAverage, oder berechnet werden soll, und das order Feld, um anzugeben, ob die Ergebnisse in Ascending oder in der Descending Reihenfolge sortiert werden sollen.

    Anmerkung

    metricsSowohl die binBy Objekte als auch enthalten ein order Feld. Sie können die Sortierung nur order in einem der beiden Objekte angeben.

Die übrigen Felder in der Anfrage sind optional. Sie können die Ergebnisse auf folgende Weise filtern und organisieren:

  • Ergebnisse filtern — Verwenden Sie das filters Feld, um die Ergebnisse zu filtern. Weitere Details finden Sie unter Filtern von Ergebnissen.

  • Ergebnisse nach Kategorie gruppieren — Geben Sie das groupBy Feld an, eine Liste, die ein einzelnes AnalyticsSessionResult, AnalyticsIntentResultAnalyticsIntentStageResult, oder AnalyticsUtteranceResultObjekt enthält. Geben Sie im Objekt das name Feld mit der Kategorie an, nach der Sie die Ergebnisse gruppieren möchten.

    Wenn Sie in der Anfrage ein groupBy Feld angeben, enthält groupByKeys das results Objekt in der Antwort eine Liste von AnalyticsSessionGroupByKey, AnalyticsIntentGroupByKey, AnalyticsIntentStageGroupByKeyoder AnalyticsUtteranceGroupByKeyObjekten, jedes mit demname, was Sie in der Anfrage angegeben haben, und einem Mitglied dieser Kategorie im value Feld.

  • Ergebnisse nach Zeit sortieren — Geben Sie das binBy Feld an, eine Liste, die ein einzelnes AnalyticsBinBySpecificationObjekt enthält. Geben Sie im Objekt das name Feld an, mit dem die Ergebnisse ConversationStartTime nach Beginn der Konversation oder UtteranceTimestamp nach dem Zeitpunkt, zu dem die Äußerung stattgefunden hat, sortiert werden sollen. Geben Sie das Zeitintervall an, nach dem Sie die Ergebnisse im interval Feld einteilen möchten, und legen Sie fest, ob die Sortierung Ascending oder die Descending Reihenfolge im order Feld erfolgen soll.

    Wenn Sie in der Anforderung ein binBy Feld angeben, enthält binKeys das results Objekt in der Antwort eine Liste von AnalyticsBinKeyObjekten, jedes mit demname, was Sie in der Anfrage angegeben haben, und dem Zeitintervall, das diese Ablage im value Feld definiert.

    Anmerkung

    metricsSowohl die binBy Objekte als auch enthalten ein order Feld. Sie können die Sortierung nur order in einem der beiden Objekte angeben.

Verwenden Sie die folgenden Felder, um die Anzeige der Antwort zu verwalten:

  • Geben Sie eine Zahl zwischen 1 und 1.000 in das maxResults Feld ein, um die Anzahl der Ergebnisse zu begrenzen, die in einer einzigen Antwort zurückgegeben werden.

  • Wenn die Anzahl der Ergebnisse größer ist als die Zahl, die Sie in dem maxResults Feld angeben, enthält die Antwort einenextToken. Stellen Sie die Anfrage erneut, verwenden Sie jedoch diesen Wert im nextToken Feld, um den nächsten Ergebnisstapel zurückzugeben.

Wenn Sie verwendenListUtteranceMetrics, können Sie Attribute angeben, die im attributes Feld zurückgegeben werden sollen. Dieses Feld ist einer Liste zugeordnet, die ein einzelnes AnalyticsUtteranceAttributeObjekt enthält. Geben Sie LastUsedIntent in dem name Feld an, dass die Absicht zurückgegeben werden soll, die Amazon Lex V2 zum Zeitpunkt der Äußerung verwendet.

In der Antwort wird das results Feld einer Liste von AnalyticsSessionResult, AnalyticsIntentResultAnalyticsIntentStageResult, oder AnalyticsUtteranceResultObjekten zugeordnet. Jedes Objekt enthält ein metrics Feld, das den Wert einer zusammenfassenden Statistik für eine von Ihnen angeforderte Metrik zurückgibt, zusätzlich zu allen Abschnitten oder Gruppen, die mit den von Ihnen angegebenen Methoden erstellt wurden.

Metadaten für Sitzungen und Äußerungen in einem Bot abrufen

Verwenden Sie die ListUtteranceAnalyticsDataOperationen ListSessionAnalyticsDataund, um Metadaten zu einzelnen Sitzungen und Äußerungen abzurufen.

Füllen Sie die erforderlichen endTime Felder startTime und aus, um einen Zeitraum zu definieren, für den Sie Ergebnisse abrufen möchten.

Die übrigen Felder in der Anfrage sind optional. Um Ergebnisse zu filtern und zu sortieren:

  • Ergebnisse filtern — Verwenden Sie das filters Feld, um die Ergebnisse zu filtern. Weitere Details finden Sie unter Filtern von Ergebnissen.

  • Ergebnisse sortieren — Sortiert die Ergebnisse nach dem sortBy Feld, das ein SessionDataSortByUtteranceDataSortByOder-Objekt enthält. Geben Sie den Wert an, nach dem Sie im name Feld sortieren möchten, und legen Sie fest, ob im order Feld sortiert Ascending oder in der Descending Reihenfolge sortiert werden soll.

Verwenden Sie die folgenden Felder, um die Anzeige der Antwort zu verwalten:

  • Geben Sie eine Zahl zwischen 1 und 1.000 in das maxResults Feld ein, um die Anzahl der Ergebnisse zu begrenzen, die in einer einzigen Antwort zurückgegeben werden.

  • Wenn die Anzahl der Ergebnisse größer ist als die Zahl, die Sie in dem maxResults Feld angeben, enthält die Antwort einenextToken. Stellen Sie die Anfrage erneut, verwenden Sie jedoch diesen Wert im nextToken Feld, um den nächsten Ergebnisstapel zurückzugeben.

In der Antwort wird das utterances Feld sessions oder einer Liste von SessionSpecificationUtteranceSpecificationOder-Objekten zugeordnet. Jedes Objekt enthält Metadaten für eine einzelne Sitzung oder Äußerung.

Metadaten für Sitzungen und Äußerungen in einem Bot abrufen

Verwenden Sie diesen ListIntentPathsVorgang, um Kennzahlen zu einer Reihenfolge von Absichten abzurufen, die Kunden im Gespräch mit einem Bot verfolgen.

Füllen Sie für diesen Vorgang die folgenden Pflichtfelder aus:

  • Geben Sie ein startTime und einendTime, um einen Zeitraum zu definieren, für den Sie Ergebnisse abrufen möchten.

  • Geben Sie eine einintentPath, um eine Reihenfolge der Absichten zu definieren, für die Sie Metriken abrufen möchten. Trennen Sie die Absichten im Pfad durch einen Schrägstrich voneinander. Füllen Sie das intentPath Feld beispielsweise mit aus, um Details darüber /BookCar/BookHotel zu sehen, wie oft Benutzer die BookHotel Absichten BookCar und in dieser Reihenfolge aufgerufen haben.

Verwenden Sie das optionale filters Feld, um die Ergebnisse zu filtern. Weitere Details finden Sie unter Filtern von Ergebnissen.

Äußerungsstatistiken von Lex V2-Konversationen anzeigen

Sie können anhand von Statistiken zu Äußerungen ermitteln, welche Äußerungen Ihre Benutzer an Ihren Bot senden. Sie können sowohl die Äußerungen sehen, die Amazon Lex V2 erfolgreich erkennt, als auch die Äußerungen, die es nicht erkennt. Sie können diese Informationen verwenden, um Ihren Bot zu optimieren.

Wenn Sie beispielsweise feststellen, dass Ihre Benutzer eine Äußerung senden, bei der Amazon Lex V2 fehlt, können Sie die Äußerung zu einer Absicht hinzufügen. Die Entwurfsversion der Absicht wird mit der neuen Äußerung aktualisiert und Sie können sie testen, bevor Sie sie für Ihren Bot bereitstellen.

Eine Äußerung wird erkannt, wenn Amazon Lex V2 die Äußerung als Versuch erkennt, eine für einen Bot konfigurierte Absicht aufzurufen. Eine Äußerung wird übersehen, wenn Amazon Lex V2 die Äußerung nicht erkennt und stattdessen die Äußerung aufruft. AMAZON.FallbackIntent

Statistiken zu Äußerungen können mit dem und dem eingesehen werden. ListUtteranceMetrics API ListAggregatedUtterance API

ListUtteranceMetricsAPIUnter den folgenden Bedingungen werden keine Statistiken zu Äußerungen generiert:

  • Die Einstellung Child Online Privacy Protection Act war auf Ja gesetzt, als der Bot mit der Konsole erstellt wurde, oder das childDirected Feld wurde auf true gesetzt, als der Bot mit dem CreateBot Vorgang erstellt wurde.

Sie ListUtteranceMetrics API bietet zusätzliche Funktionen, darunter:

  • Weitere Informationen sind verfügbar, z. B. eine Zuordnung der Absicht zu erkannten Äußerungen.

  • Mehr Filtermöglichkeiten (einschließlich Kanal und Modus).

  • Längerer Aufbewahrungszeitraum (30 Tage).

  • Sie können das API auch dann verwenden, wenn Sie sich gegen die Datenspeicherung entschieden haben. Auf ListUtteranceMetrics API die Konsolenfunktion für verpasste und erkannte Äußerungen wird zurückgegriffen.

ListAggregatedUtteranceAPIUnter den folgenden Bedingungen werden keine Statistiken zu Äußerungen generiert:

  • Die Einstellung Child Online Privacy Protection Act war auf Ja gesetzt, als der Bot mit der Konsole erstellt wurde, oder das childDirected Feld wurde auf true gesetzt, als der Bot mit dem CreateBot Vorgang erstellt wurde.

  • Sie verwenden die Slot-Obfuscation mit einem oder mehreren Steckplätzen.

  • Sie haben sich von der Teilnahme an der Verbesserung von Amazon Lex abgemeldet.

Das ListAggregatedUtterance API bietet Funktionen wie:

  • Weniger detaillierte Informationen verfügbar (keine Zuordnung der Absicht für Äußerungen).

  • Eingeschränkte Filterfähigkeit (ohne Kanal und Modus).

  • Kurzer Aufbewahrungszeitraum (15 Tage).

Anhand von Statistiken zu Äußerungen können Sie sehen, ob eine bestimmte Äußerung erkannt oder übersehen wurde und wann die Äußerung zuletzt in einer Bot-Interaktion verwendet wurde.

Amazon Lex V2 speichert kontinuierlich Äußerungen, während Benutzer mit Ihrem Bot interagieren. Sie können die Statistiken über die Konsole oder den ListAggregatedUtterances Vorgang abfragen. Es hat eine Datenspeicherung von 15 Tagen und ist nicht verfügbar, wenn der Benutzer die Datenspeicherung deaktiviert hat. Sie können Äußerungen mithilfe des DeleteUtterances Vorgangs oder durch Deaktivierung der Datenspeicherung löschen. Alle Äußerungen werden gelöscht, wenn Sie Ihr Konto schließen. AWS Gespeicherte Äußerungen werden mit einem serververwalteten Schlüssel verschlüsselt.

Wenn Sie eine Bot-Version löschen, sind die Statistiken zu den Äußerungen für die Version bis zu 30 Tage mit ListUtteranceMetrics und für die Nutzung bis zu 15 Tage verfügbar. ListAggregatedUtterances In der Amazon Lex V2-Konsole können Sie keine Statistiken für die gelöschte Version sehen. Um die Statistiken für gelöschte Versionen zu sehen, können Sie beide ListUtteranceMetrics Operationen ListAggregatedUtterances und verwenden.

Sowohl bei als auch werden Äußerungen nach dem Text der Äußerung aggregiert. ListAggregatedUtterances ListUtteranceMetrics APIs Beispielsweise werden alle Fälle, in denen der Kunde den Ausdruck „Ich möchte eine Pizza bestellen“ verwendet hat, in einer Antwort zu derselben Zeile zusammengefasst. Wenn Sie die RecognizeUtteranceOperation verwenden, ist der verwendete Text das Eingabeprotokoll.

Um das ListAggregatedUtterances und zu verwenden ListUtteranceMetricsAPIs, wenden Sie die folgende Richtlinie auf eine Rolle an.

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