返回

通智搜尋使用說明:四個步驟為業務系統接入搜尋能力

通智雲團隊 ·
API整合 搜尋系統 通智搜尋
通智搜尋使用說明:四個步驟為業務系統接入搜尋能力

摘要:本說明介紹如何使用通智搜尋為業務系統接入搜尋能力:包括建立應用、配置索引、建置索引,以及透過 API 或頁面元件完成接入。

一、通智搜尋概述

通智搜尋是通智雲提供的一站式智能搜尋產品,協助企業快速為業務系統接入高品質的搜尋能力。主要流程如下:

步驟 說明
建立應用 選擇行業和套餐,獲得搜尋服務所需的資源配額
配置索引 將資料集欄位對應為索引欄位,定義搜尋的資料結構
建置索引 系統根據索引配置自動建置搜尋索引
接入應用 透過 API 或頁面元件,將搜尋能力整合到業務系統中

二、進入通智搜尋

  1. 登入通智雲控制台,在左側導覽列中找到「通智搜尋」,點擊進入。

    左側導覽列中的「通智搜尋」入口
    圖2-1 左側導覽列中的「通智搜尋」入口

  2. 進入通智搜尋概覽頁。在概覽頁可以看到「新建應用」的入口,點擊進入建立應用流程。

    通智搜尋概覽頁
    圖2-2 通智搜尋概覽頁

三、建立應用

第一步:選擇行業和套餐

  1. 選擇當前業務所屬行業。系統會針對所選行業進行行業級優化,若清單中沒有對應行業,可選擇「通用行業」。

  2. 選擇套餐版本。不同套餐對應不同的資源配額和功能,可根據業務量體選擇合適的套餐。

  3. 點擊「建立」按鈕,完成應用建立。

    選擇行業和套餐
    圖3-1 選擇行業和套餐

第二步:開啟應用詳情頁

  1. 建立完成後,點擊「返回應用清單」,回到應用清單頁。

    返回應用清單
    圖3-2 返回應用清單

  2. 在應用清單頁可以看到剛建立的應用。清單預設按建立時間倒序排列,新建立的應用由系統自動命名。

    應用清單頁
    圖3-3 應用清單頁

  3. 點擊應用名稱,進入應用詳情頁。

第三步:了解詳情頁「基礎資訊」

應用詳情頁主要包含「基礎資訊」「索引配置」「效果預覽」等功能區。其中,「基礎資訊」的主要功能如下:

序號 功能 說明
1 修改名稱 點擊應用名稱後面的修改按鈕,即可設定應用名稱
2 操作清單 可進行升級、續費、刪除等操作
3 服務狀態 顯示當前套餐版本和服務狀態,支援升級或續費
4 執行狀態 顯示應用的執行狀態;使用前需要完成索引配置,配置完成後才可正常使用
5 套餐用量 顯示當前套餐的配額和已用量;升級套餐可獲得更大配額
6 效果預覽 在右側彈出視窗中預覽搜尋頁面元件的展示效果
7 API 接入 在右側彈出視窗中查看 API 接入指引
8 頁面元件接入 在右側彈出視窗中查看搜尋頁面元件的接入指引
9 介面除錯 在右側彈出視窗中查看介面除錯資訊,驗證配置是否生效

應用詳情頁之「基礎資訊」
圖3-4 應用詳情頁之「基礎資訊」

⚠️ 注意:API Key 是呼叫應用介面的憑證,請妥善保管,不要洩漏。

四、索引配置

索引是搜尋的基礎。透過索引配置,將資料集的欄位對應為索引欄位,系統據此建置搜尋索引。

第一步:進入索引配置頁面

在應用詳情頁點擊「索引配置」,進入索引配置頁面。

第二步:選擇資料集

選擇作為索引資料來源的資料集。

選擇資料集
圖4-2 選擇資料集

第三步:配置索引欄位

系統為常見的業務場景提供索引模板,可以在模板基礎上進一步調整。各配置項說明如下:

  1. 語義標籤:為欄位設定語義標籤,協助系統更充分地理解業務資料。

  2. 索引欄位:索引模板已預設索引欄位名稱,只需對應相應的資料集欄位即可。索引必須有且只有一個 ID 欄位,用於唯一識別一筆資料;同時至少需要一個「欄位類型」為「分詞處理」的欄位,以確保搜尋功能正常運作。

  3. 資料集欄位:選擇索引欄位對應的資料集欄位名稱,系統將使用該欄位的內容來建置索引。

  4. 欄位類型:為索引欄位選擇合適的處理類型,決定資料將如何被處理到索引中。

  5. 欄位權重:為「分詞處理」類型的欄位設定權重,搜尋時系統會按權重進行加權排序。

  6. 新增索引欄位:在模板欄位清單的基礎上,如需增加業務欄位,可點擊「新增索引欄位」繼續新增。

  7. 點擊「儲存」,儲存索引配置。

    索引欄位配置
    圖4-3 索引欄位配置

💡 提示:在索引配置欄位清單的表頭,將滑鼠移至欄位名稱旁的「?」圖示上方,可查看該列的詳細說明。

第四步:啟動建置索引

索引儲存成功後,在彈出的對話方塊中點擊「啟動」,即可開始建置索引。也可以點擊「暫不啟動」,繼續修改索引配置後再啟動。

啟動建置索引
圖4-4 啟動建置索引

第五步:查看建置進度

  1. 回到應用詳情頁,在「執行狀態」區域可以查看應用狀態,也可以停止建置索引。

  2. 在「文件數」區域可以查看已建置到索引中的文件數量。

  3. 點擊重新整理按鈕,可動態查看索引中的文件數變化。

    查看建置索引進度
    圖4-5 查看建置索引進度

五、接入應用

索引建置完成後,即可將搜尋能力接入業務系統。通智搜尋提供多種接入方式,可根據業務需求選擇。

效果預覽

點擊「效果預覽」,在右側彈出的頁面中可以預覽搜尋頁面元件的展示效果,方便在接入前確認搜尋體驗。

效果預覽
圖5-1 效果預覽

API 接入

點擊「API 接入」,在右側彈出的頁面中可以查看 API 接入的詳細說明,包括請求位址、參數說明和回傳範例。

API 接入指引
圖5-2 API 接入指引

頁面元件接入

點擊「頁面元件接入」,在右側彈出的頁面中可以查看搜尋頁面元件的接入說明,透過嵌入元件程式碼即可快速為頁面加入搜尋功能。

頁面元件接入指引
圖5-3 頁面元件接入指引

介面除錯

點擊「介面除錯」,在右側彈出的頁面中可以查看介面的詳細除錯資訊,用於驗證搜尋配置是否正確生效。

介面除錯
圖5-4 介面除錯


附錄:名詞說明

名詞 說明
應用 通智搜尋中的搜尋服務單元,每個應用對應一個獨立的搜尋服務,包含索引配置、API Key 等資源
ID 欄位 索引中用於唯一識別一筆資料的欄位,每個索引必須有且只有一個
索引 搜尋的資料基礎,由資料集欄位對應而來,系統根據索引配置建置搜尋索引
語義標籤 描述欄位業務含義的標籤,協助系統更充分地理解業務資料,提升搜尋和排序效果
分詞處理 將文字欄位拆分為更小的詞元(token),使用戶可以透過關鍵詞匹配到相關內容
欄位權重 為「分詞處理」類型的欄位設定的權重值,搜尋時系統按權重對結果進行加權排序
資料集 通智雲資料中心中的資料儲存單元,作為索引的資料來源,支援 API 推送、MySQL 同步和行為資料三種接入方式
← 上一篇: 通智雲數據中心使用說明:API 推送、MySQL 與行為數據集接入 下一篇: 通智雲配額用量與計費說明:超額如何計費、成本如何控制 →
諮詢
二維碼

企業微信