search功能Demo - OpenSearch

本文為您介紹通過PHP SDK進行文檔基礎搜尋的環境配置以及程式碼範例。

配置環境變數

配置環境變數ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。

重要

阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運，具體操作，請參見建立RAM使用者。
建立AccessKey ID和AccessKey Secret，請參考建立AccessKey。
如果您使用的是RAM使用者的AccessKey，請確保主帳號已授權AliyunServiceRoleForOpenSearch服務關聯角色，請參考OpenSearch-行業演算法版服務關聯角色，相關文檔參考訪問鑒權規則。
請不要將AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。

Linux和macOS系統配置方法：
執行以下命令，其中， <access_key_id>需替換為您RAM使用者的AccessKey ID，<access_key_secret>替換為您RAM使用者的AccessKey Secret。
```
export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id> 
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
```
Windows系統配置方法
1. 建立環境變數檔案，添加環境變數ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET，並寫入已準備好的AccessKey ID和AccessKey Secret。
2. 重啟Windows系統生效。

建立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>';
//開啟偵錯模式
$options = array('debug' => true);
//建立OpenSearchClient用戶端對象
$client = new OpenSearchClient($accessKeyId, $secret, $endPoint, $options);

搜尋功能Demo（全）

樣本如下：

<?php
header("Content-Type:text/html;charset=utf-8");
//引入標頭檔
require_once("Config.inc.php");
use OpenSearch\Client\SearchClient;
use OpenSearch\Util\SearchParamsBuilder;
$searchClient = new SearchClient($client);
//建立參數對象，並指定對應參數
$params = new SearchParamsBuilder();
$params->setStart(0);
$params->setHits(20);
//設定應用程式名稱
$params->setAppName('替換為應用程式名稱');
//設定查詢query
$params->setQuery("name:'搜尋'");
//設定返回格式
$params->setFormat("fulljson");
//添加排序
$params->addSort('id', SearchParamsBuilder::SORT_DECREASE);
$params->addSort('RANK', SearchParamsBuilder::SORT_DECREASE);
//設定文檔過濾條件
$params->setFilter('id>0');
//添加distinct子句
$params->addDistinct(
    array('key' => 'cate_id', 'distTimes' => 1, 'distCount' => 1, 'reserved' => 'false')
);
//添加摘要
$params->addSummary(
    array('summary_field' => 'name', 'summary_len' => 100, 'summary_ellipsis' => "。。。", 'summary_snippet' => 2, 'summary_element_prefix' => '<em>', 'summary_element_postfix' => '</em>')
);
//$params->addSummary(
//    array('summary_field' => 'name', 'summary_len' => 200)
//);
//設定自訂參數
//$params->setCustomParam('a', 'b');
//$params->setCustomParam('c', 'd');
//$params->setRouteValue('1');

//設定關聯搜尋請求的from_request_id
$params->setCustomParam('from_request_id','159851481919726888064081');


//添加aggregate子句
 $params->addAggregate(
     array('groupKey' => 'cate_id', 'aggFun' => 'count()', 'range' => '1', 'aggSamplerThresHold' => 1, 'aggSamplerStep' => 10, 'maxGroup' => 10)
 );
// $params->addAggregate(
//     array('groupKey' => 'cate_id', 'aggFun' => 'count()', 'range' => '1', 'aggFilter' => 'id>1', 'aggSamplerThresHold' => 1, 'aggSamplerStep' => 10, 'maxGroup' => 10)
// );
//指定粗排運算式
$params->setFirstRankName('default');
//指定精排運算式
$params->setSecondRankName('default');
//設定需返回哪些欄位
$params->setFetchFields(array('id','name','phone','int_arr','literal_arr','float_arr','cate_id'));
//添加raw_query參數
$params->setRawQuery("字串");
//執行查詢並返回資訊
$ret = $searchClient->execute($params->build());
//列印返回資訊的內容
print_r(json_decode($ret->result,true));
//列印調試資訊
echo $ret->traceInfo->tracer;