快速入门

前置条件

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

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

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

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

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

购买实例

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

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

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

4. 在确认订单界面，查看服务协议，确认无误后，点击立即开通：

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

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

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

配置集群

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

1. 配置数据源（目前支持的数据源有“MaxCompute数据源”和“API推送数据源”）这里以MaxCompute数据源为例：点击“添加数据源”，数据源类型选择“MaxCompute”，设置project、accesskeyID、accesskeyId、accesskeySecret、Table、分组键partition，并开启“自动索引重建配置”：

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

2. 数据源配置成功后，需点击下一步配置索引结构：

2.1. 在没有配置索引时会提示您还没有索引结构版本，请先添加索引表，点击添加索引表

2.2. 配置索引表，模板选择通用模板：

• 索引表：可自定义

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

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

2.3. 设置字段，至少需要定义2个字段主键字段和向量字段（向量字段需要设置为多值float类型）：

如果需要带有类目的向量，可以在主键和向量字段中间加一个类目字段，类型要求单值或多值的整数类型：

属性和字段内容压缩：

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

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

使用向量检索，在定义字段时有位置要求，需要按照主键字段、标签字段（非必要）、向量字段的顺序创建。（如上图所示）

主键字段不支持压缩

• 使用向量检索，在定义字段时有位置要求，需要按照主键字段、标签字段（非必要）、向量字段的顺序创建。（如上图所示）

• 主键字段不支持压缩

3. 设置索引，主键字段索引类型设置为PRIMARYKEY64，向量索引类型选择CUSTOMIZED：

索引字段设置压缩：

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

主键索引不支持压缩

3.1. 为向量字段添加包含字段：

重要

• 主键字段、向量字段必须填写，标签字段非必填，可以为空。

• 仅支持选择固定的三个字段，不支持新增。

3.2. 高级配置，向量索引需要单独配置参数，可以参考如下配置，详情可参考向量索引：

更多参数：

其中build_index_params的配置如下：

{
 "proxima.qc.builder.quantizer_class": "Int8QuantizerConverter",
 "proxima.qc.builder.quantize_by_centroid": true,
 "proxima.qc.builder.optimizer_class": "BruteForceBuilder",
 "proxima.qc.builder.thread_count": 10,
 "proxima.qc.builder.optimizer_params": {
 "proxima.linear.builder.column_major_order": true
 },
 "proxima.qc.builder.store_original_features": false,
 "proxima.qc.builder.train_sample_count": 3000000,
 "proxima.qc.builder.train_sample_ratio": 0.5
}

search_index_params的配置如下：

{
 "proxima.qc.searcher.scan_ratio": 0.01
}

系统自动填充向量索引的配置参数，如无特殊需求，可直接点击「确定」快速完成配置。

4. 配置完成后，点击保存版本，并在弹框后填写备注（可选），点击发布：

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

5. 索引重建，选择索引重建需要配置的参数项，点击“下一步”：

• API推送数据源：

• MaxCompute数据源：

6. 可在运维中心>历史变更>数据源变更查看索引重建进度，进度完成后即可进行查询测试：

switch完成后即可供线上使用。

查看索引重建进度

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

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

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

查询测试

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

注意事项