快速入门

前提条件

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

2. 首次登录阿里云控制台时，会提示先创建AccessKey才能继续使用。

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

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

步骤一：购买应用

登录OpenSearch控制台，页面左上角选择OpenSearch-高性能检索版，进入实例管理页，单击创建应用。

购买应用分为：预付费（包年包月）以及后付费（按量付费）。

在购买页面中，选择地域和可用区（如华南1（深圳）、华北2（北京）等），填写应用名称（应用名称创建后无法修改），并选择集群偏好（独享集群-通用型、独享集群-计算型、独享集群-存储型或共享集群-通用型）。

在购买页面中，配置存储容量（如 100 GB）、计算资源（如 800 LCU）、计费周期（可选 1–6 个月，支持勾选到期自动续费）和资源组（默认为默认资源组），然后单击立即购买完成下单。

步骤二：配置应用

应用初始化完成后，状态变更为待配置，此时可以单击配置进入下一步定义应用结构：

配置应用向导分为四个步骤：应用结构 → 索引结构 → 数据源 → 完成。在第一步中，选择创建应用结构的方式，可选项包括通过数据源创建、手动创建、通过模板创建和上传文档创建，选择后单击下一步。

定义应用结构

目前提供了 4 种应用结构创建方式。

定义应用结构流程：

1. 通过模板创建应用结构。用户可以将自己定义的应用结构创建成模板，可以通过已有模板快速创建出一个新的应用。

2. 通过上传文档创建应用结构。您可以上传已有的数据文件（仅支持JSON格式），系统会自动解析并创建出初始的应用结构（注意字段类型等需要重新定义）。

3. 通过数据源创建应用结构。适用于通过RDS、MaxCompute等数据源同步的场景，可以快速由源表结构创建出初始的应用结构，节省手动构造的工作量，降低出错概率。这里以RDS为例，其他数据源操作类似，具体详见数据源配置：

   选择通过数据源创建 Tab 后，在右侧弹出的选择数据源面板中选择 RDS，然后单击+ 新建数据库。

   在连接数据库对话框中，填写RDS 实例 ID、数据库名、用户名和密码，然后单击连接。

4. 通过手动创建应用结构，非以上三种场景使用。

   在手动创建页面，输入表名（如 main），并选择主表。在字段定义区域，设置字段名称（如 id、name），为其中一个字段选中主键单选按钮，并为每个字段选择类型（如 INT、LITERAL）。字段类型的选择会影响后续配置索引和属性字段。单击 + 可添加更多字段。

定义索引结构

• 需放到 query子句中的字段，必须创建为索引（浮点型字段不支持创建为索引），详情请参见OpenSearch表结构。

• 需放到 filter子句，sort子句，及函数中涉及字段有明确标识，需设置为属性的字段必须创建为属性字段。

• 分词字段类型无法配置为属性字段，例如 TEXT，SHORT_TEXT等都不支持，只支持数值字段类型及不分词字段类型配置为属性字段，例如 int，int_array，float，float_array，double，double_array，literal，literal_array 等字段类型。

  在索引结构步骤中，需配置三部分内容：索引字段列表，设置索引名称、包含字段及分析方式（如中文 - 通用分析或关键字），使用示例形如 query=default:"云搜索"；属性字段列表，将字段添加为属性字段后可在 filter、aggregate、sort、distinct 子句中使用，示例 filter=id>100000；默认展示字段列表，将字段添加为展示字段后搜索结果中将返回该字段的值。配置完成后单击下一步进入数据源配置。

同步数据源

1. 首先关联数据源，关联成功后，选择数据表，单击>>选中后，确认。

2. 确认后默认进入字段映射界面，选择添加数据，开放搜索应用字段与数据源字段名一致会自动映射，若不一致则需要手动添加。

3. 字段映射界面可以同时设置数据源插件，插件使用及说明文档，请单击此处：

   说明

   若需要数据源实时同步功能，可以参考：DTS实时同步。

4. 创建完成

步骤三：搜索测试

数据上传成功后就可以开始搜索体验，我们在控制台中内置了搜索测试页面方便用户搜索测试，主要包含查询子句和查询参数，可以根据具体搜索需求自行配置进行搜索测试（详情请参见API概览及SDK简介），此处以控制台中搜索测试页面为例。通过单击子句或参数后的+按钮，在弹出的下拉框中选择添加需要的查询子句或参数，再填写对应查询子句或参数内容，最后单击搜索按钮进行搜索效果测试。

使用方法

1. 左侧导航栏，功能扩展下进入搜索测试页。输入必填参数query子句。

   选择线上应用，在 config 子句中设置 start:0,hit:10,format:fulljson，单击搜索查看返回结果。

2. 同时可以添加更多的子句以及参数。

   单击+按钮，在下拉菜单中选择要添加的子句类型，包括过滤子句（filter）、排序子句（sort）、打散子句（distinct）、统计子句（aggregate）、自定义子句（kvpairs）和配置子句（config）。

   单击参数旁的+按钮，在下拉菜单中选择需要添加的参数。可选参数包括：展示字段（fetch_fields）、查询分析（qp）、粗排表达式（first_rank_name）、精排表达式（second_rank_name）、精排插件类型（second_rank_type）、结果摘要配置（summary）、类目预测（category_prediction）、原始Query（raw_query）、重查策略（re_search）、业务信息（biz）、搜索ReqId（from_request_id）、用户ID（user_id）、A/BTest（abtest）、禁用参数（disable）和自定义参数（custom）。

扩展内容

子句说明

查询子句-query子句。

过滤子句-filter子句。

排序子句-sort子句。

打散子句-distinct子句。

统计子句-aggregate子句。

自定义子句-kvpair子句。

翻页子句-config子句。

参数说明

展示字段fetch_fields，多个展示字段按分号分隔。

查询规则qp，设置查询分析的名称。

粗排表达式first_rank_name，设置基础排序的名称。

精排表达式second_rank_name，设置业务排序的名称。

结果摘要配置-summary，请参见搜索结果摘要。

类目预测和原始Query用法：设置类目预测名称以及查询词。

重查策略re_search，请参见搜索处理。

业务信息biz，用户ID，请参见搜索处理。

A/B Test，设置A/B Test的名称。

禁用参数disable，设置想禁用的功能，例如disable=qp。

更多进阶功能，请查看对应功能的产品文档，文档中都有操作流程步骤。