用APIs於分析 - Amazon Lex
篩選結果擷取機器人的指標擷取機器人中工作階段和語音的中繼資料擷取機器人中工作階段和語音的中繼資料檢視來自 Lex V2 交談的話語統計資料

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

用APIs於分析

本節說明您用來擷取機器人分析的API作業。

注意

若要使用ListUtteranceMetrics和 ListUtteranceAnalyticsData，您的IAM角色必須具有執行ListAggregatedUtterances作業的權限，這可讓您存取與語言相關的分析。如檢視來自 Lex V2 交談的話語統計資料需要套用至IAM角色的IAM詳細資訊，請參閱。

篩選結果

分析API請求會要求您指定startTime和endTime。API傳回在之後開始startTime並在之前結束的工作階段、意圖、意圖階段或語音。 endTime

filters是分析API要求中的選擇性欄位。它會對應至AnalyticsSessionFilter、AnalyticsIntentFilterAnalyticsIntentStageFilter、或AnalyticsUtteranceFilter物件的清單。在每個物件中，使用欄位建立要篩選依據的運算式。例如，如果您將下列篩選器新增至清單，則機器人會搜尋超過 30 秒的交談。

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

擷取機器人的指標

使用ListSessionMetrics、ListIntentMetricsListIntentStageMetrics、和ListUtteranceMetrics作業擷取工作階段、意圖、意圖階段和語音的摘要量度。

對於這些作業，請填寫下列必要欄位：

  • 提供startTime和，endTime以定義您要擷取結果的時間範圍。

  • 指定您要計算的量度metrics、AnalyticsSessionMetricAnalyticsIntentMetricAnalyticsIntentStageMetric、或AnalyticsUtteranceMetric物件清單。在每個物件中，使用name欄位指定要計算statistic欄位的量度，以指定是否要計算SumAverage、或Max數字，以及使用order欄位來指定是按結果排序Ascending還是按Descending順序排序。

    注意

    metrics和binBy物件都包含order欄位。您只能在兩個物件的其order中一個中指定排序。

請求中的其餘字段是可選的。您可以使用下列方式篩選和組織結果：

  • 篩選結果 — 使用filters欄位來篩選結果。如需詳細資訊，請參閱篩選結果。

  • 按類別對結果進行分組 — 指定groupBy字段、包含單個AnalyticsSessionResult、AnalyticsIntentResultAnalyticsIntentStageResult、或AnalyticsUtteranceResult對象的列表。在物件中，指定含有要群組結果所依據之類別的name欄位。

    如果您在請求中指定了一個groupBy字段，則響應中的results對象包含groupByKeys、AnalyticsSessionGroupByKey、AnalyticsIntentGroupByKey、AnalyticsIntentStageGroupByKey或對象的列表，每個對AnalyticsUtteranceGroupByKey象都包name含您在請求中指定的，以及該類別的value字段中的成員。

  • 依時間排列結果 — 指定binBy欄位，此欄位包含單一AnalyticsBinBySpecification物件的清單。在物件中，指定ConversationStartTime要在交談開始時收納結果的name欄位，或者在發生話語時UtteranceTimestamp將結果分隔開始。指定要在欄位中儲存結果的時間間隔，以及是否要在interval欄位中依時間排序Ascending或時間Descending順序。order

    如果您在請求中指定了一個binBy字段，則響應中的results對象包含binKeys一個對AnalyticsBinKey象列表，每個對象列表都包name含您在請求中指定的，以及在該value字段中定義該 bin 的時間間隔。

    注意

    metrics和binBy物件都包含order欄位。您只能在兩個物件的其order中一個中指定排序。

使用下列欄位來處理回應的顯示：

  • 在欄位中指定介於 1 到 1,000 之間的數maxResults字，以限制在單一回應中傳回的結果數目。

  • 如果結果數大于您在maxResults字段中指定的數目，那么響應會包含一個nextToken。再次提出要求，但在nextToken欄位中使用此值可傳回下一批結果。

如果您正在使用ListUtteranceMetrics，則可以指定要在attributes欄位中傳回的屬性。此欄位對映至包含單一AnalyticsUtteranceAttribute物件的清單。LastUsedIntent在name欄位中指定，以傳回 Amazon Lex V2 在發言時使用的意圖。

在回應中，results欄位會對應至AnalyticsSessionResultAnalyticsIntentResultAnalyticsIntentStageResult、或AnalyticsUtteranceResult物件的清單。每個物件都包含一個metrics欄位，此欄位會傳回您要求之測量結果的摘要統計值，以及從您指定之方法建立的任何資料桶或群組。

擷取機器人中工作階段和語音的中繼資料

使用ListSessionAnalyticsData和作ListUtteranceAnalyticsData業擷取有關個別工作階段和話語的中繼資料。

填寫必要endTime欄位startTime和欄位，以定義您要擷取結果的時間範圍。

請求中的其餘字段是可選的。若要篩選和排序結果：

  • 篩選結果 — 使用filters欄位來篩選結果。如需詳細資訊，請參閱篩選結果。

  • 排序結果 — 使用包含SessionDataSortBy或物件的sortBy欄位UtteranceDataSortBy對結果進行排序。指定要在欄位中排序依據的值，以及是在name欄位中依據排序Ascending還是按Descending順序order排序。

使用下列欄位來處理回應的顯示：

  • 在欄位中指定介於 1 到 1,000 之間的數maxResults字，以限制在單一回應中傳回的結果數目。

  • 如果結果數大于您在maxResults字段中指定的數目，那么響應會包含一個nextToken。再次提出要求，但在nextToken欄位中使用此值可傳回下一批結果。

在回應中，sessions或utterances欄位會對應至SessionSpecification或UtteranceSpecification物件清單。每個物件都包含單一工作階段或話語的中繼資料。

擷取機器人中工作階段和語音的中繼資料

使用此ListIntentPaths作業可擷取有關客戶與機器人交談之意圖順序的指標。

對於此操作，請填寫以下必填字段：

  • 提供startTime和，endTime以定義您要擷取結果的時間範圍。

  • 提供intentPath定義您要擷取度量的意圖順序。使用正斜線分隔路徑中的對應方式。例如，在intentPath欄位中填入，/BookCar/BookHotel以查看使用者以該順序呼叫BookCar和BookHotel意圖次數的詳細資訊。

使用選擇性filters欄位來篩選結果。如需詳細資訊，請參閱篩選結果。

檢視來自 Lex V2 交談的話語統計資料

您可以使用話語統計信息來確定用戶發送給您的機器人的話語。您可以看到 Amazon Lex V2 成功偵測到的語音，以及看不到的話語。您可以使用此信息來幫助調整您的機器人。

例如，如果您發現使用者正在傳送 Amazon Lex V2 遺失的語音，您可以將語音新增到意圖中。意圖的草稿版本會以新的話語進行更新，您可以在將其部署到機器人之前對其進行測試。

當 Amazon Lex V2 將語音識別為嘗試叫用針對機器人設定的意圖時，就會偵測到語音。當 Amazon Lex V2 無法識別語音並調用語音時，會錯過一個話語。AMAZON.FallbackIntent

可以使用ListUtteranceMetricsAPI和來檢視語音統計資料。ListAggregatedUtterance API

ListUtteranceMetricsAPI在下列情況下，不會產生話語統計資料：

  • 使用主控台建立機器人時，[兒童線上隱私權保護法案] 設定設為 [是]，或者當機器人透過CreateBot作業建立時，childDirected欄位設定為 true。

ListUtteranceMetricsAPI提供額外的功能，包括：

  • 可用的更多資訊，例如偵測到語音的對應意圖。

  • 更多的濾波功能（包括通道和模式）。

  • 更長的保留日期範圍（30 天）。

  • API即使您已選擇退出資料儲存，也可以使用。遺漏和偵測到的話語的主控台功能將取決於。ListUtteranceMetrics API

ListAggregatedUtteranceAPI在下列情況下，不會產生話語統計資料：

  • 使用主控台建立機器人時，[兒童線上隱私權保護法案] 設定設為 [是]，或者當機器人透過CreateBot作業建立時，childDirected欄位設定為 true。

  • 您正在使用一個或多個插槽的插槽混淆。

  • 您選擇不參與改善 Amazon Lex 的活動。

提ListAggregatedUtteranceAPI供的功能包括：

  • 較少的詳細資訊可用 (沒有對應的語音意圖)。

  • 有限的濾波功能（不包括通道和模式）。

  • 短保留日期範圍（15 天）。

使用話語統計資料，您可以查看是否偵測到或遺漏特定語音，以及上次在機器人互動中使用該語音的時間。

當使用者與您的機器人互動時，Amazon Lex V2 會持續存放語音。您可以使用控制台或ListAggregatedUtterances操作查詢統計信息。它的數據保留時間為 15 天，如果用戶選擇退出數據存儲，則不可用。您可以使用DeleteUtterances作業或選擇退出資料儲存來刪除語音。如果您關閉，所有的話語都會被刪除 AWS 帳戶。儲存的語音會使用由伺服器管理的金鑰加密。

當您刪除機器人版本時，該版本的話語統計最多可使用 30 天ListUtteranceMetrics，並使用 15 天。ListAggregatedUtterances您無法在 Amazon Lex V2 主控台中查看已刪除版本的統計資料。要查看已刪除版本的統計信息，可以同時使用ListAggregatedUtterances和ListUtteranceMetrics操作。

同時使用ListAggregatedUtterances和 ListUtteranceMetricsAPIs，話語由語音的文本彙總。例如，客戶使用「我要訂購比薩餅」一詞的所有執行個體都會在回應中彙總到同一行中。當您使用該RecognizeUtterance操作時，使用的文本是輸入成績單。

若要使用ListAggregatedUtterances和 ListUtteranceMetricsAPIs，請將下列原則套用至角色。

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