OpenSearch:Tutorials

export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>

<?php
// Import the autoloader.
require_once("../OpenSearch/Autoloader/Autoloader.php");
use OpenSearch\Client\OpenSearchClient;

// Read credentials from environment variables.
$accessKeyId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');
$secret      = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');

// Set the API endpoint for your region.
// Find this value on the application details page in the OpenSearch console.
$endPoint    = '<region endPoint>';

// Set the application name and drop-down suggestion name.
$appName     = '<app name>';
$suggestName = '<suggest name>';

// Enable debug mode to capture trace information.
$options = array('debug' => true);

// Create the OpenSearch client.
$client = new OpenSearchClient($accessKeyId, $secret, $endPoint, $options);

<?php
// Base configuration (required for all features).
require_once("../OpenSearch/Autoloader/Autoloader.php");
use OpenSearch\Client\OpenSearchClient;

// Application information query.
require_once("Config.inc.php");
use OpenSearch\Client\AppClient;
use OpenSearch\Generated\Common\Pageable;

// Document query (search).
require_once("Config.inc.php");
use OpenSearch\Client\SearchClient;
use OpenSearch\Util\SearchParamsBuilder;

// Document push.
require_once("Config.inc.php");
use OpenSearch\Client\DocumentClient;

// Drop-down suggestions.
require_once("Config.inc.php");
use OpenSearch\Client\SuggestClient;
use OpenSearch\Util\SuggestParamsBuilder;

<?php
require_once("Config.inc.php");

// Application information query client.
$appClient = new AppClient($client);

// Document query (search) client.
$searchClient = new SearchClient($client);

// Document push client.
$documentClient = new DocumentClient($client);

// Drop-down suggestion client.
$suggestClient = new SuggestClient($client);

<?php
header("Content-Type:text/html;charset=utf-8");
require_once("Config.inc.php");
use OpenSearch\Client\DocumentClient;

// Specify the table to push documents to.
$tableName = '<table name>';

$documentClient = new DocumentClient($client);

// Build the document array.
$docs_to_upload = array();
for ($i = 0; $i < 10; $i++) {
    $item          = array();
    $item['cmd']   = 'ADD';
    $item['fields'] = array(
        'id'   => $i + 1,
        'name' => 'Search' . $i,
    );
    $docs_to_upload[] = $item;
}

// Encode and push.
$json = json_encode($docs_to_upload);
$ret  = $documentClient->push($json, $appName, $tableName);

<?php
require_once("Config.inc.php");
use OpenSearch\Client\SearchClient;
use OpenSearch\Util\SearchParamsBuilder;

$searchClient = new SearchClient($client);
$params       = new SearchParamsBuilder();

// config clause parameters.
$params->setStart(0);     // Starting offset of results.
$params->setHits(20);     // Number of results to return.

// Query parameters.
$params->setAppName('<app name>');
$params->setQuery("name: 'Search'");
$params->setFormat('fulljson');

// Sort by relevance score in descending order.
$params->addSort('RANK', SearchParamsBuilder::SORT_DECREASE);

// Execute and decode.
$ret    = $searchClient->execute($params->build());
$result = json_decode($ret->result, true);
print_r($result);

echo $ret->traceInfo->tracer;