快速入门

更新时间:
复制 MD 格式

前置条件

  1. 成功注册阿里云账号并通过实名认证

  2. 开通阿里云账号并登录控制台时,会提示先创建access key才能继续使用。

  • 创建及使用应用依赖access key参数,主账号下access key参数不能为空。

  • 在为主账号创建access key参数后,还可以再创建RAM子账号access key通过RAM子账号进行访问,RAM子账号赋予对应访问权限,请参考授权访问鉴权规则

  1. 需要用户拥有VPC环境,详情可点击此处进行查看。

说明

如果需要使用子账号操作召回引擎版实例,请使用主账号为子账号授予AliyunSearchEngineFullAccessAliyunSearchEngineReadOnlyAccess 权限

购买实例

  1. 进入OpenSearch控制台,在左上角切换到OpenSearch-召回引擎版

  1. 进入召回引擎版控制台后,在实例管理界面,点击创建实例

  1. 商品版本选择召回引擎版,选择地区,配置“查询节点个数”、“查询节点规格”、“数据节点数量”、“数据节点规格”、“单数据节点总存储空间”,设置“专有网络”和“虚拟交换机”,最后按提示要求设置用户名和用户密码(用于查询时校验权限,非阿里云账号密码),点击”立即购买”。

说明
  • 购买的查询节点和数据节点的个数及规格,需根据自身业务进行规划,确定规格后实际费用可在售卖页自动生成。

  • 专有网络和虚拟交换的配置一定要和访问召回引擎版实例的ECS机器保持一致。否则在访问召回引擎版实例时会报错{'errors':{'code':'403','message':'Forbidden'}}

  • 单数据节点存储空间有免费额度,用户也可申请额外额度,按额外额度部分收费(步长50GB)

  1. 确认订单界面,查看服务协议,确认无误后,点击立即开通

  1. 购买成功后,点击管理控制台,即可在实例管理界面查看已购买的召回引擎版实例。

  1. 新购的实例会设置一个默认实例名称,可在操作栏下点击管理按钮,进入详情页进行修改。

点击修改图标,按提示框要求修改实例名称最后点击确认

配置集群

新购买的实例,在其详情页中,实例状态为“待配置”,并且会自动部署一个与购买的查询节点和数据节点的个数及规格一致的空集群,之后需要为该集群配置数据源--->配置索引--->索引重建,之后才可正常搜索。

  1. 配置数据源(目前支持的数据源有“MaxCompute数据源”和“API推送数据源”)这里以MaxCompute数据源为例:点击“添加数据源”,数据源类型选择“MaxCompute”,设置project、accesskeyID、accesskeyId、accesskeySecret、Table、分组键partition,可按需选择是否开启“”。

校验成功之后,点击“确定”,完成数据源的添加。

  1. 数据源配置成功后,需点击下一步配置索引结构

2.1. 添加索引表:在索引结构页面中,单击添加索引表按钮。

2.2. 配置索引表:

  • 索引表:可自定义

  • 数据源:选择 1 中配置的数据源

  • 数据分片:根据用户购买的数据节点个数进行配置

2.3. 字段设置:

字段设置表格中包含字段名称字段类型主键属性属性压缩摘要压缩摘要区间分析方式高级配置列,可按需配置各字段属性。

属性和字段内容压缩

  • 属性字段可以选择是否压缩,默认为不压缩,选择file_compressor表示开启压缩

  • 字段内容可以选择是否压缩,默认为不压缩,默认多值和STRING类型选择uniq,单值数值类型是equal

说明
  • 如果开启了属性压缩,建议前往「部署管理-数据节点-在线表配置」编辑索引加载方式,以此降低对性能的影响。

  • 支持复制字段操作,复制出的新字段(DUP字段)与原字段内容保持一致(推送不一致内容时,将采用原字段内容覆盖),如期望字段内容不一致,请手动删除DUP字段高级配置中的copy from配置。

2.4. 索引设置:

索引设置表格中包含索引名称索引类型包含字段数据压缩高级配置操作列,可查看和修改各索引配置。

  • 索引字段可以选择是否压缩,默认为不压缩,选择file_compressor表示开启压缩

说明
  • 主键索引不支持压缩

  • 如果开启了索引压缩,建议前往「部署管理-数据节点-在线表配置」编辑索引加载方式,以此降低对性能的影响

  1. 配置完成后,点击保存版本,并在弹框后填写备注(可选),点击发布

等待索引发布完成后,可点击“下一步”进行索引重建。

  1. 索引重建,选择索引重建需要配置的参数项,点击“下一步”。

  • API推送数据源

选择数据源名称关联索引表,确认数据源类型API推送数据源,然后单击下一步

  • MaxCompute数据源

选择数据源名称关联索引表,确认数据源类型MaxCompute,配置数据分区时间戳参数,然后单击下一步

查看索引重建进度

数据源及索引结构配置完成后,可在运维中心>部署管理中查看集群拓扑:

拓扑图展示了查询接入集群(含数据节点查询节点)、索引表数据源之间的层级关系。

更新配置之后,可在运维中心>变更历史>数据源变更处查看索引重建进度:

索引重建流程包含 inittriggerscanbuildswitch 五个阶段,各阶段完成后会显示绿色对勾标记。

并且在实例详情页中,也可查看集群的查询节点和数据节点的状态,状态均为正常后,即可进行查询测试:

查询节点显示服务状态(服务中)和配置状态(配置已更新);数据节点额外显示数据状态(数据已更新),三项状态均为 100% 即表示正常。

查询测试

可在功能扩展>查询测试中进行简单的搜索测试,召回引擎版支持的查询方式有HA3子句SQL子句两种:

选择查询方式(如SQL子句),在输入框中输入查询语句(例如 select * from index_a),单击搜索即可查看查询结果,结果中包含耗时(USE_TIME)和命中条数(ROW_COUNT)等信息。

说明

注意事项

重要
  • 付费方式暂时仅支持按量付费;

  • 购买实例时设置的用户名和密码可在实例详情页进行修改;

  • 集群名称在购买实例时由系统为用户指定使用的集群,用户暂时无法修改;

  • 索引重建需按照每次消耗的资源量付费,详情可参考计费概述