View a markdown version of this page

Verwenden von APIs für Analysen - 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.

Verwenden von APIs für Analysen

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

Anmerkung

Um ListUtteranceMetrics und verwenden zu können ListUtteranceAnalyticsData, muss Ihre IAM-Rolle über Berechtigungen zur Ausführung des ListAggregatedUtterances Vorgangs verfügen, der den Zugriff auf Analysen im Zusammenhang mit Äußerungen ermöglicht. Einzelheiten und die IAM-Richtlinie Äußerungsstatistiken aus Lex V2-Konversationen anzeigen für die IAM-Rolle finden Sie unter.

Ergebnisse filtern

Für die Analytics-API-Anfragen müssen Sie das startTime und angebenendTime. Die 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 Analytics-API-Anfragen. Es ist einer Liste von AnalyticsSessionFilter, AnalyticsIntentFilter AnalyticsIntentStageFilter, oder AnalyticsUtteranceFilter Objekten 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 sind.

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

Metriken für einen Bot abrufen

Verwenden Sie die ListUtteranceMetrics OperationenListSessionMetrics,ListIntentMetrics, undListIntentStageMetrics, um zusammenfassende Metriken 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 anmetrics, in denen Sie rechnen möchten AnalyticsSessionMetric, eine Liste von AnalyticsIntentMetric AnalyticsIntentStageMetric,, oder AnalyticsUtteranceMetric Objekten. Verwenden Sie in jedem Objekt das name Feld, um die Metrik anzugeben, um das statistic Feld zu berechnen, um anzugeben, ob dieSum, Average Max Oder-Zahl berechnet werden soll, und das order Feld, um anzugeben, ob die Ergebnisse in der Descending Reihenfolge Ascending oder der Reihenfolge sortiert werden sollen.

    Anmerkung

    metricsSowohl die als auch die binBy Objekte 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 Ergebnisse filtern.

  • Ergebnisse nach Kategorie gruppieren — Geben Sie das groupBy Feld oder eine Liste an, die ein einzelnes AnalyticsSessionResult, AnalyticsIntentResult AnalyticsIntentStageResult, oder AnalyticsUtteranceResult Objekt 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,, oder AnalyticsUtteranceGroupByKey Objekten AnalyticsIntentGroupByKey AnalyticsIntentStageGroupByKey, von denen jedes das Objekt enthält, name das Sie in der Anfrage angegeben haben, und ein Mitglied dieser Kategorie im value Feld.

  • Ergebnisse nach Zeit sortieren — Geben Sie das binBy Feld an. Dabei handelt es sich um eine Liste, die ein einzelnes AnalyticsBinBySpecification Objekt enthält. Geben Sie im Objekt das name Feld an, in dem die Ergebnisse nach dem Beginn der Konversation oder UtteranceTimestamp nach dem Zeitpunkt der Äußerung sortiert werden sollen. ConversationStartTime Geben Sie das Zeitintervall an, nach dem die Ergebnisse im interval Feld sortiert werden sollen, und geben Sie an, ob das Feld nach Ascending oder Descending nach der Zeit sortiert werden soll. order

    Wenn Sie in der Anfrage ein binBy Feld angeben, enthält das results Objekt in der Antwort eine Liste von AnalyticsBinKey ObjektenbinKeys, von denen jedes das Objekt enthält, name das Sie in der Anforderung angegeben haben, und das Zeitintervall, das diesen Abschnitt im value Feld definiert.

    Anmerkung

    metricsSowohl die als auch die binBy Objekte 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 steuern:

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

  • Wenn die Anzahl der Ergebnisse größer ist als die Zahl, die Sie im 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 AnalyticsUtteranceAttribute Objekt 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, AnalyticsIntentResult AnalyticsIntentStageResult, oder AnalyticsUtteranceResult Objekten 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.

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

Verwenden Sie die ListUtteranceAnalyticsData Operationen ListSessionAnalyticsData und, 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 Ergebnisse filtern.

  • Ergebnisse sortieren — Sortiert die Ergebnisse anhand des sortBy Felds, das ein SessionDataSortBy UtteranceDataSortBy OR-Objekt enthält. Geben Sie im name Feld den Wert an, nach dem Sie sortieren möchten, und geben Sie an, ob im order Feld Descending sortiert Ascending oder sortiert werden soll.

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

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

  • Wenn die Anzahl der Ergebnisse größer ist als die Zahl, die Sie im 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 ist das utterances Feld sessions oder einer Liste von SessionSpecification UtteranceSpecification OR-Objekten zugeordnet. Jedes Objekt enthält Metadaten für eine einzelne Sitzung oder Äußerung.

Abrufen von Intent-Pfad-Analysedaten

Verwenden Sie den ListIntentPaths Vorgang, um Kennzahlen über die Reihenfolge der 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 an an anintentPath, 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 ab. Füllen Sie das intentPath Feld beispielsweise mit, /BookCar/BookHotel um Details darüber zu erhalten, wie oft Benutzer die Befehle BookCar und in dieser Reihenfolge aufgerufen habenBookHotel.

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

Äußerungsstatistiken aus Lex V2-Konversationen anzeigen

Mithilfe von Äußerungsstatistiken können Sie 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 in Ihrem 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 aufruft. AMAZON.FallbackIntent

Die Statistiken zur Äußerung können mithilfe der ListUtteranceMetrics API und der API eingesehen werden. ListAggregatedUtterance

Äußerungsstatistiken werden unter den folgenden Bedingungen nicht mithilfe der ListUtteranceMetrics API generiert:

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

Die ListUtteranceMetrics API bietet zusätzliche Funktionen, darunter:

  • Es sind weitere Informationen verfügbar, z. B. die zugeordnete Absicht für erkannte Äußerungen.

  • Mehr Filterfunktionen (einschließlich Kanal und Modus).

  • Längerer Aufbewahrungszeitraum (30 Tage).

  • Sie können die API auch dann verwenden, wenn Sie die Datenspeicherung deaktiviert haben. Die Konsolenfunktion für verpasste und erkannte Äußerungen hängt von der ListUtteranceMetrics API ab.

Unter den folgenden Bedingungen werden mithilfe der ListAggregatedUtterance API keine Statistiken zu Äußerungen generiert:

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

  • Sie verwenden Slot-Obfuscation mit einem oder mehreren Slots.

  • Sie haben sich gegen die Teilnahme an der Verbesserung von Amazon Lex entschieden.

Die ListAggregatedUtterance API bietet unter anderem folgende Funktionen:

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

  • Eingeschränkte Filtermöglichkeiten (ohne Kanal und Modus).

  • Kurzer Aufbewahrungszeitraum (15 Tage).

Mithilfe von Äußerungsstatistiken können Sie sehen, ob eine bestimmte Äußerung erkannt oder übersehen wurde, zusammen mit dem Zeitpunkt, zu dem die Äußerung das letzte Mal in einer Bot-Interaktion verwendet wurde.

Amazon Lex V2 speichert Äußerungen kontinuierlich, während Benutzer mit Ihrem Bot interagieren. Sie können die Statistiken mithilfe der Konsole oder der ListAggregatedUtterances Operation 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 der DeleteUtterances Operation löschen oder indem Sie die Datenspeicherung deaktivieren. Alle Äußerungen werden gelöscht, wenn Sie Ihr AWS-Konto schließen. Gespeicherte Äußerungen werden mit einem serververwalteten Schlüssel verschlüsselt.

Wenn Sie eine Bot-Version löschen, sind die Äußerungsstatistiken für die Version bis zu 30 Tage lang mit und 15 Tage mit ListUtteranceMetrics Nutzung 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 einzusehen, können Sie beide ListAggregatedUtterances ListUtteranceMetrics Operationen verwenden.

Sowohl mit der ListAggregatedUtterances als auch mit der ListUtteranceMetrics API werden Äußerungen anhand des Textes der Äußerung aggregiert. Beispielsweise werden alle Fälle, in denen der Kunde den Ausdruck „Ich möchte eine Pizza bestellen“ verwendet hat, in einer Antwort in derselben Zeile zusammengefasst. Wenn Sie die RecognizeUtterance Operation verwenden, ist der verwendete Text das Eingabeprotokoll.

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

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