使用教程

使用OpenSearch提供搜索功能十分简单，下面带大家迅速上手。

登录控制台创建应用

• 手动在控制台根据实际业务需要创建对应表结构及其它相关配置，例如：索引，属性，数据源，过滤条件等。

• 下载此处我们提供的测试 标准版应用结构模板，在创建应用结构时，选择“通过模板创建应用结构”，然后下一步，再选择左上角的“导入模板”，上传此处下载的应用结构模板，一直下一步直到完成。【此应用结构测试模板，可适用于标准版Php SDK文档中的搜索及推送数据Demo代码】

下载php SDK并添加到项目中

在左侧栏“相关下载”页面中下载v3版 php SDK包，并根据需编写具体功能需要，添加如下头文件内容到项目中，具体参考Demo中各功能实现的代码样例

主要功能头文件集合<参考>

主要功能包含，查询应用信息，查询应用文档，推送文档，下拉提示等，依赖的头文件，引用对应功能的头文件后就可以编写对应功能及对象方法调用。

<?php
//Config 页面，头文件，包含AK，host，应用名，下拉名称及 options 等信息
require_once("../OpenSearch/Autoloader/Autoloader.php");
use OpenSearch\Client\OpenSearchClient;

//获取应用列表，头文件
require_once("Config.inc.php");
use OpenSearch\Client\AppClient;
use OpenSearch\Generated\Common\Pageable;

//查询文档，头文件
require_once("Config.inc.php");
use OpenSearch\Client\SearchClient;
use OpenSearch\Util\SearchParamsBuilder;

//推送文档，头文件
require_once("Config.inc.php");
use OpenSearch\Client\DocumentClient;

//下拉提示，头文件
require_once("Config.inc.php");
use OpenSearch\Client\SuggestClient;
use OpenSearch\Util\SuggestParamsBuilder;

我们先实例化一个SDK客户端client，在编写对应功能时会使用到它。

<?php
//引用配置头文件
require_once("Config.inc.php");

//创建用于获取应用列表client
$appClient = new AppClient($client);

//创建用于查询文档client
require_once("Config.inc.php");
$searchClient = new SearchClient($client);

//创建用于推送文档client
require_once("Config.inc.php");
$documentClient = new DocumentClient($client);

//创建用于下拉查询client
require_once("Config.inc.php");
$suggestClient = new SuggestClient($client);

创建Config配置头文件

Config 页面中的内容将作为后续的查询推送文档的头文件，其中包含AK，host，应用名，下拉名称及 options 选项，等重要参数信息

<?php
//引入头文件
require_once("../OpenSearch/Autoloader/Autoloader.php");
use OpenSearch\Client\OpenSearchClient;

// 用户识别信息
// 从环境变量读取配置的AccessKey ID和AccessKey Secret，
// 运行代码示例前必须先配置环境变量，参考文档上面“配置环境变量”步骤
// 替换对应的access key id
$accessKeyId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');
//替换对应的access secret
$secret = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
//替换为对应区域api访问地址，可参考应用控制台,基本信息中api地址
$endPoint = '<region endPoint>';
//替换为应用名
$appName = '<app name>';
//替换为下拉提示名称
$suggestName = '<suggest name>';
//开启调试模式
$options = array('debug' => true);
//创建OpenSearchClient客户端对象
$client = new OpenSearchClient($accessKeyId, $secret, $endPoint, $options);

在上面代码的基础上我们继续使用DocumentClient类对象向刚创建的应用中上传一些文档，应用名称继续使用上面config页面中的$appName。OpenSearch应用中的文档是一个JSON类型的字符串，结构如下：

[
    {
        "fields":{},
        "cmd":""
    }
...
]

cmd字段可选的值为：ADD、DELETE、UPDATE（

标准版应用，不支持UPDATE，新增和更新都通过ADD实现，也不支持部分字段更新

），分别表示添加、删除以及更新一条文档；

fields字段内包含文档本身的字段属性，比如在一个小说应用的结构中可能包含以下字段：title：小说的名字，body：小说主体内容，url：访问小说的地址等。

完整示例代码

可以下载V3 版PhpSDK，并解压到下面代码文件的同级目录中，然后直接复制下面代码，将其中的access key和secret替换成自己的，以及替换其它关键信息，就可以体验一下OpenSearch了。

<?php
header("Content-Type:text/html;charset=utf-8");
//引用头部文件
require_once("Config.inc.php");
use OpenSearch\Client\DocumentClient;
use OpenSearch\Client\SearchClient;
use OpenSearch\Util\SearchParamsBuilder;

//设置数据需推送到表名
$tableName = '替换为应用表名';
//创建文档操作client
$documentClient = new DocumentClient($client);
//添加文档数据
$docs_to_upload = array();
for ($i = 0; $i < 10; $i++){
    $item = array();
    $item['cmd'] = 'ADD';
    $item["fields"] = array(
        "id" => $i + 1,
        "name" => "搜索".$i
        );
    $docs_to_upload[] = $item;
}
// 编码
$json = json_encode($docs_to_upload);
//提交推送文档
$ret = $documentClient->push($json, $appName, $tableName);


// 实例化一个搜索类
$searchClient = new SearchClient($client);
// 实例化一个搜索参数类
$params = new SearchParamsBuilder();
//设置config子句的start值
$params->setStart(0);
//设置config子句的hit值
$params->setHits(20);
// 指定一个应用用于搜索
$params->setAppName('替换为应用名');
// 指定搜索关键词
$params->setQuery("name:'搜索'");
// 指定返回的搜索结果的格式为json
$params->setFormat("fulljson");
//添加排序字段
$params->addSort('RANK', SearchParamsBuilder::SORT_DECREASE);
// 执行搜索，获取搜索结果
$ret = $searchClient->execute($params->build());
// 将json类型字符串解码
print_r(json_decode($ret->result,true));
//打印调试信息
echo $ret->traceInfo->tracer;

通过上面的操作我们已经可以使用基本的搜索功能了，但是优化搜索、提高搜索结果相关性是一个漫长的过程，需要我们不断试错和迭代来一点点改进。在这个过程中如果遇到问题或者发现结果与预期不一致时可以通过下面的接口获得请求的详细信息，可以通过这些信息排查问题。特别是当遇您到问题，在旺旺群、钉钉群中寻求帮助的时候，根据调试信息我们可以迅速帮您定位到问题所在。

echo $ret->traceInfo->tracer;