README

Ola Search 是一个基于人工智能的平台，用于构建基于搜索的应用程序和聊天机器人。我们帮助您在探索和发现信息或寻找答案时构建和维护出色的体验。

PHP 的 Ola Search API 客户端 允许您轻松地从 PHP 代码中使用 Ola Search REST API。

如果您是 Laravel 用户，您可能正在寻找以下集成

Laravel: Ola Search Laravel Scout

API 文档

您可以在 Ola Search 网站上找到完整的参考信息。

支持的平台

安装

开始使用

索引数据

搜索

搜索 UI

入门指南

支持的平台

此库与 PHP 版本 5.3 及以上兼容。

安装

使用 Composer（推荐）

通过 Composer 安装包

composer require shebinleovincent/olasearch-client-php

不使用 Composer

如果您不使用 Composer，您可以下载包并将其包含在您的代码中。

require_once('olasearch-client-php/olasearch.php');

框架集成

我们官方支持 Laravel 框架

如果您正在使用 Laravel 框架，请参阅我们的 Laravel 文档

开始使用

以下说明将向您展示如何索引和搜索文档。

初始化客户端

首先，您需要初始化客户端。为此，您需要您的 项目 ID 和 API 密钥。您可以在您的 Ola Search 账户上找到这两项。

// composer autoload
require __DIR__ . '/vendor/autoload.php';

// if you are not using composer
// require_once 'path/to/olasearch.php';

$client = new \OlaSearch\Client('YourProjectID', 'YourAdminAPIKey');

$index = $client->initIndex();

索引数据

以下代码展示了如何索引文档

$index = $client->initIndex();
$documents = json_decode(file_get_contents('articles.json'), true);
$mapping = json_decode(file_get_contents('mapping.json'), true);
$index->addDocuments($documents, $mapping);

搜索

您现在可以使用 title、category、author 等搜索文章。

// search by title
var_dump($index->search('falcon heavy'));

// search articles by author
var_dump($index->search('articles by jackie wattles'));

// search articles by category
var_dump($index->search('articles in technology'));

搜索 UI

注意：如果您正在构建一个 Web 应用程序，您可能更感兴趣的是使用我们的一些前端搜索 UI 库

Web 聊天机器人

在您的网站上嵌入聊天机器人

将以下代码放置在您希望聊天机器人出现的位置

<div id="ola-chatbot"></div>
<link rel='stylesheet' href="https://cdn.olasearch.com/assets/css/olasearch.core.min.css" type='text/css'>
<script src="https://cdn.olasearch.com/production/<YourProjectID>/olasearch.min.js"></script>

自动完成搜索栏

嵌入自动完成搜索栏结果页面

将以下代码放置在您希望自动完成搜索栏出现的位置

<div id="ola-autosuggest"></div>
<link rel='stylesheet' href="https://cdn.olasearch.com/assets/css/olasearch.core.min.css" type='text/css'>
<script src="https://cdn.olasearch.com/production/<YourProjectID>/olasearch.min.js"></script>

搜索结果

嵌入搜索结果页面

将以下代码放置在您希望搜索结果页面出现的位置

<div id="ola-serp"></div>
<link rel='stylesheet' href="https://cdn.olasearch.com/assets/css/olasearch.core.min.css" type='text/css'>
<script src="https://cdn.olasearch.com/production/<YourProjectID>/olasearch.min.js"></script>

shebinleovincent / olasearch-client-php

维护者

详细信息