使用圖 Amazon Kendra JavaScript 書館提交意見反應 - Amazon Kendra

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

使用圖 Amazon Kendra JavaScript 書館提交意見反應

Amazon Kendra 提供一個 JavaScript 資料庫,讓您可以將點擊回饋新增至搜尋結果頁面。若要使用元件庫,請在用戶端程式碼中插入指令碼標記以顯示搜尋結果,然後將資訊新增至結果清單中的每個文件連結。當使用者選擇檢視文件的連結時,按一下資訊會傳送至 Amazon Kendra。

該庫適用於支持 ES6/ES2015 JavaScript 版本的瀏覽器。

步驟 1:在 Amazon Kendra 搜尋應用程式中插入指令碼標記

在呈現 Amazon Kendra 搜尋結果的用戶端程式碼中,插入<script>標籤並將參考新增至程式 JavaScript 庫:

<script> (function(w, d, s, c, g, n) { if(!w[n]) { w[n] = w[n] || function () { (w[n].q = w[n].q || []).push(arguments); } w[n].st = new Date().getTime(); w[n].ep = g; var e = document.createElement(s), j = document.getElementsByTagName(s)[0]; e.async = 1; e.src = c; e.type = 'module'; j.parentNode.insertBefore(e, j); } })(window, document, 'script', 'library download URL', 'feedback endpoint', 'kendraFeedback'); </script>

指令碼會以非同步方式從 Amazon Kendra 託管的 CDN 下載程式 JavaScript 庫,並初始化名為的全域變數,可kendraFeedback讓您設定選擇性參數。

根據託管 Amazon Kendra 索引的地區,將程式庫下載 URL意見反應端點取代為下表中的識別碼。

區域 下載 URL 反饋端點
us-east-1 https://d2zm0lpns956f8.cloudfront.net/ksf-v1.js https://ujxwp5s92h.execute-api.us-east-1.amazonaws.com/prod/submit
us-east-2 https://d2crv7fufeg244.cloudfront.net/ksf-v1.js https://i6h76zwzf3.execute-api.us-east-2.amazonaws.com/prod/submit
us-west-2 https://d2iezfpnpcoujy.cloudfront.net/ksf-v1.js https://wg6nim909c.execute-api.us-west-2.amazonaws.com/prod/submit
ca-central-1 https://d1zbkfomowykaq.cloudfront.net/ksf-v1.js https://budi8txevj.execute-api.ca-central-1.amazonaws.com/prod/submit
eu-west-1 https://d3gptlxtulu4us.cloudfront.net/ksf-v1.js https://po2b11740b.execute-api.eu-west-1.amazonaws.com/prod/submit
ap-southeast-1 https://d1vvuam7g4taoe.cloudfront.net/ksf-v1 https://9je5uw7t5l.execute-api.ap-southeast-1.amazonaws.com/prod/submit
ap-southeast-2 https://dopqntoe6z0ce.cloudfront.net/ksf-v1.js https://oovf4nvjj7.execute-api.ap-southeast-2.amazonaws.com/prod/submit
ap-south-1 https://d1ts9ouelsmk3g.cloudfront.net/ksf-v1.js https://k1abnmd43b.execute-api.ap-south-1.amazonaws.com/prod/submit
ap-northeast-1 https://d3w0ybsa293kb4.cloudfront.net/ksf-v1.js https://wg7rz0uzjh.execute-api.ap-northeast-1.amazonaws.com/prod/submit
eu-west-2 https://d1tsrujswld1d1.cloudfront.net/ksf-v1.js https://qi7mct3x7f.execute-api.eu-west-2.amazonaws.com/prod/submit

例如,如果您的索引位於美國東部 (維吉尼亞北部),則程式庫下載 URLhttps://d2zm0lpns956f8.cloudfront.net/ksf-v1.js意見反應端點https://ujxwp5s92h.execute-api.us-east-1.amazonaws.com/prod/submit

您可以為程式 Amazon Kendra JavaScript 庫進行兩種選擇性設定:

  • disableCookies— 默認情況下, Amazon Kendra 設置唯一標識用戶的 cookie。將此項設定true為以停用 Cookie。

    kendraFeedback('disableCookie', 'true | false');

    searchDivClassName-默認情況下, Amazon Kendra 監控您的搜索結果頁面上的點擊所有鏈接。將此項設定為<div>類別名稱,以僅監視指定類別中的連結。

    kendraFeedback('searchDivClassName', 'class name');

步驟 2:將意見反應記號新增至搜尋結果

在結果頁面上,新增名data-kendra-token為錨點標籤的 HTML 屬性,或是包含查詢回應之文件連結的直接父 div 標籤。例如:

<a href="document location" data-kendra-token="feedback token value"></a> OR <div data-url="document location" data-kendra-token="feedback token value"></div>

查詢響應在feedbackToken字段中包含令牌。如果使用者選擇回應,Token 會唯一識別回應。將權杖的值指派給data-kendra-token屬性。當用戶選擇結果並將其提交到 Amazon Kendra 端點作為反饋時, Amazon Kendra JavaScript 庫會查找此令牌。

程式 Amazon Kendra JavaScript 庫只會提交意見反應權杖和其他中繼資料,例如選擇結果的時間和唯一訪客 ID。

步驟 3:測試意見反應指令碼

若要確定程式 JavaScript 庫設定正確,並將意見反應傳送至正確的端點,請執行下列動作。這個例子使用 Chrome 瀏覽器。

  1. 在瀏覽器中開啟 Web 開發人員工具。在 Chrome 上,打開瀏覽器右上角的 Chrome 菜單,選擇更多工具,然後選擇開發人員工具

  2. 確保控制台選項卡中沒有與 Amazon Kendra JavaScript 庫相關的錯誤。

  3. 進行搜索並選擇任何結果。在開發人員工具的「網絡」選項卡中。您應該會看到傳送至意見反應端點的要求、結果的權杖,以及 200 OK 狀態。