Hızlı başlangıç
OpenSearch ile arama özellikleri sunmak oldukça basittir. Bu bölüm, hızlı bir şekilde başlamanıza yardımcı olur.
Ortam değişkenlerini yapılandırın
ALIBABA_CLOUD_ACCESS_KEY_ID ve ALIBABA_CLOUD_ACCESS_KEY_SECRET ortam değişkenlerini yapılandırın.
Bir Alibaba Cloud hesabının AccessKey çifti, tüm API işlemlerine erişmek için kullanılabilir. API işlemlerini çağırmak veya rutin işletim ve bakım (O&M) görevlerini yürütmek için bir Resource Access Management (RAM) kullanıcısı kullanmanızı öneririz. RAM kullanıcısının nasıl kullanılacağı hakkında bilgi edinmek için bkz. RAM kullanıcısı oluşturma.
AccessKey çiftinin nasıl oluşturulacağı hakkında bilgi edinmek için bkz. AccessKey çifti oluşturma.
Bir RAM kullanıcısının AccessKey çiftini kullanıyorsanız, gerekli izinlerin Alibaba Cloud hesabınız aracılığıyla AliyunServiceRoleForOpenSearch rolüne verildiğinden emin olun. Daha fazla bilgi için bkz. AliyunServiceRoleForOpenSearch ve Erişim yetkilendirme kuralları.
AccessKey çiftinizi proje kodu gibi başkalarının kolayca erişebileceği materyallerde bulundurmayın. Aksi takdirde AccessKey çiftiniz sızdırılabilir ve hesabınızdaki kaynaklar güvensiz hale gelebilir.
-
Linux ve macOS
Aşağıdaki komutları çalıştırın.
<access_key_id>ve<access_key_secret>değerlerini kullandığınız RAM kullanıcısının AccessKey ID ve AccessKey secret değerleriyle değiştirin.export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id> export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret> -
Windows
Bir ortam değişkeni dosyası oluşturun, ALIBABA_CLOUD_ACCESS_KEY_ID ve ALIBABA_CLOUD_ACCESS_KEY_SECRET ortam değişkenlerini dosyaya ekleyin ve ardından bu değişkenleri AccessKey ID ve AccessKey secret değerlerinize ayarlayın.
AccessKey çiftinin etkili olması için Windows'u yeniden başlatın.
Hazırlıklar
Konsola giriş yapın ve bir uygulama oluşturun
Konsolda, iş gereksinimlerinize bağlı olarak dizinler, nitelikler, veri kaynakları ve filtre koşulları gibi tablo şemasını ve diğer ilgili yapılandırmaları manuel olarak oluşturun.
Sağladığımız test Standart Sürüm uygulama şema şablonunu indirin. Uygulama şemasını oluştururken "Şablondan Uygulama Şeması Oluştur" seçeneğini belirleyin ve İleri'ye tıklayın. Ardından, sol üst köşedeki "Şablonu İçe Aktar" seçeneğine tıklayın, indirdiğiniz uygulama şema şablonunu yükleyin ve işlem tamamlanana kadar İleri'ye tıklayın. [Bu test uygulama şema şablonu, Standart Sürüm PHP SDK belgelerindeki veri aramak ve göndermek için kullanılan Demo koduna uygulanır.]
PHP SDK'yı indirin ve projenize ekleyin
Sol gezinme bölmesindeki "İndirmeler" sayfasından V3 PHP SDK paketini indirin. Uygulamanız gereken belirli özelliklere bağlı olarak aşağıdaki üstbilgi dosyası içeriğini projenize ekleyin. Daha fazla bilgi için Demo'daki her özelliğin kod örneklerine bakın.
Ana özellikler için üstbilgi dosyaları (referans)
Ana özellikler arasında uygulama bilgilerinin sorgulanması, uygulama belgelerinin sorgulanması, belge gönderimi ve açılır menü önerileri yer alır. Bir özelliğin bağımlı olduğu üstbilgi dosyalarını referans verdikten sonra, bu özellik için kod yazabilir ve ilgili nesne yöntemlerini çağırabilirsiniz.
<?php
//Config page header file, which contains information such as the AccessKey, host, application name, drop-down suggestion name, and options
require_once("../OpenSearch/Autoloader/Autoloader.php");
use OpenSearch\Client\OpenSearchClient;
//Header file for obtaining the application list
require_once("Config.inc.php");
use OpenSearch\Client\AppClient;
use OpenSearch\Generated\Common\Pageable;
//Header file for querying documents
require_once("Config.inc.php");
use OpenSearch\Client\SearchClient;
use OpenSearch\Util\SearchParamsBuilder;
//Header file for pushing documents
require_once("Config.inc.php");
use OpenSearch\Client\DocumentClient;
//Header file for drop-down suggestions
require_once("Config.inc.php");
use OpenSearch\Client\SuggestClient;
use OpenSearch\Util\SuggestParamsBuilder;
Ana özellikler için istemciler (referans)
Öncelikle bir SDK istemcisini örneklendirin. İlgili özellikler için kod yazarken bu istemciyi kullanacaksınız.
<?php
//Reference the configuration header file
require_once("Config.inc.php");
//Create a client for obtaining the application list
$appClient = new AppClient($client);
//Create a client for querying documents
require_once("Config.inc.php");
$searchClient = new SearchClient($client);
//Create a client for pushing documents
require_once("Config.inc.php");
$documentClient = new DocumentClient($client);
//Create a client for drop-down suggestion queries
require_once("Config.inc.php");
$suggestClient = new SuggestClient($client);
Config üstbilgi dosyasını oluşturun
Config sayfasının içeriği, sonraki belge sorgulamaları ve gönderimleri için üstbilgi dosyası olarak hizmet eder. AccessKey, ana bilgisayar, uygulama adı, açılır menü önerisi adı ve seçenekler gibi önemli parametreleri içerir.
<?php
//Import the header file
require_once("../OpenSearch/Autoloader/Autoloader.php");
use OpenSearch\Client\OpenSearchClient;
// User identification information
// Read the configured AccessKey ID and AccessKey secret from environment variables.
// You must configure the environment variables before you run the sample code. For more information, see the "Configure environment variables" step earlier in this topic.
// Replace with your AccessKey ID
$accessKeyId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');
//Replace with your AccessKey secret
$secret = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
//Replace with the API endpoint of the corresponding region. You can find the API endpoint in the basic information of the application in the console.
$endPoint = '<region endPoint>';
//Replace with the application name
$appName = '<app name>';
//Replace with the drop-down suggestion name
$suggestName = '<suggest name>';
//Enable debug mode
$options = array('debug' => true);
//Create an OpenSearchClient object
$client = new OpenSearchClient($accessKeyId, $secret, $endPoint, $options);
Belge yükleme formatı
Önceki koda dayanarak, az önce oluşturduğunuz uygulamaya bazı belgeleri yüklemek için bir DocumentClient nesnesi kullanın. Uygulama adı, önceki Config sayfasındaki $appName olarak kalır. Bir OpenSearch uygulamasındaki belge, aşağıdaki yapıya sahip bir JSON dizesidir:
Uygulama belge formatı için, uygulama konsolundaki dosya yükleme düğmesine tıklayabilir ve örnek verilere başvurarak eksiksiz belge veri formatını indirebilirsiniz. İndirilen dosyayı doğrudan uygulamaya yükleyebilir ve ardından arayabilirsiniz.
[
{
"fields":{},
"cmd":""
}
...
]
cmd alanının geçerli değerleri ADD, DELETE ve UPDATE'tir (
Standart Sürüm uygulamaları UPDATE işlemini desteklemez. Ekleme ve güncelleme işlemlerinin her ikisi de ADD kullanılarak gerçekleştirilir. Kısmi alan güncellemeleri de desteklenmez.
) olup, sırasıyla bir belge eklemeyi, silmeyi ve güncellemeyi belirtir.
fields alanı, belgenin kendisine ait alan niteliklerini içerir. Örneğin, bir roman uygulamasının şeması şu alanları içerebilir: title: romanın adı; body: romanın ana içeriği; url: romana erişmek için kullanılan adres.
Tam örnek kod
V3 PHP SDK'yı indirin ve aşağıdaki kod dosyasıyla aynı dizine açın. Ardından, aşağıdaki kodu kopyalayın, AccessKey ID ve secret değerlerini kendi değerlerinizle değiştirin ve diğer önemli bilgileri güncelleyin. Böylece OpenSearch'ü deneyebilirsiniz.
<?php
header("Content-Type:text/html;charset=utf-8");
//Reference the header file
require_once("Config.inc.php");
use OpenSearch\Client\DocumentClient;
use OpenSearch\Client\SearchClient;
use OpenSearch\Util\SearchParamsBuilder;
//Specify the name of the table to which data is pushed
$tableName = 'Replace with the application table name';
//Create a client for document operations
$documentClient = new DocumentClient($client);
//Add document data
$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
$json = json_encode($docs_to_upload);
//Submit and push the documents
$ret = $documentClient->push($json, $appName, $tableName);
// Instantiate a search class
$searchClient = new SearchClient($client);
// Instantiate a search parameter class
$params = new SearchParamsBuilder();
//Set the start value of the config clause
$params->setStart(0);
//Set the hit value of the config clause
$params->setHits(20);
// Specify the application to search
$params->setAppName('Replace with the application name');
// Specify the search keyword
$params->setQuery("name:'search'");
// Specify that search results are returned in the JSON format
$params->setFormat("fulljson");
//Add a sort field
$params->addSort('RANK', SearchParamsBuilder::SORT_DECREASE);
// Execute the search and obtain the search results
$ret = $searchClient->execute($params->build());
// Decode the JSON string
print_r(json_decode($ret->result,true));
//Print the debugging information
echo $ret->traceInfo->tracer;
Hata ayıklama
Yukarıdaki işlemleri tamamladıktan sonra temel arama özelliklerini kullanabilirsiniz. Ancak, aramayı optimize etmek ve arama sonuçlarının alaka düzeyini artırmak, kademeli iyileştirmeler yapmak için sürekli deneme yanılma ve yineleme gerektiren uzun bir süreçtir. Bu süreçte sorunlarla karşılaşırsanız veya sonuçların beklendiği gibi olmadığını fark ederseniz, isteğe ilişkin ayrıntılı bilgileri almak ve bu bilgileri kullanarak sorunu gidermek için aşağıdaki işlemi çağırabilirsiniz. Özellikle, AliWangWang grubunda veya DingTalk grubunda yardım istediğinizde bir sorunla karşılaşırsanız, hata ayıklama bilgileri sorunun nedenini hızla bulmamıza yardımcı olur.
echo $ret->traceInfo->tracer;