返回

通智搜索使用说明

tengence ·
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同步和行为数据三种接入方式
← 上一篇: 通智云数据中心使用说明
咨询 咨询
二维码

企业微信