tntsearch

TNTSearch

TNTSearch 是一个完全用 PHP 编写的全文搜索（FTS）引擎。通过简单的配置，您可以在几分钟内添加令人惊叹的搜索体验。功能包括：

模糊搜索
即时搜索
地理搜索
文本分类
词干提取
自定义分词器
Bm25 排名算法
布尔搜索
结果高亮
动态索引更新（无需每次重新索引）
通过 Packagist.org 轻松部署

我们还创建了一些演示页面，展示了使用 n-gram 进行容错检索的效果。该包还包含一些辅助函数，如 Jaro-Winkler 和余弦相似度用于距离计算。它支持英语、克罗地亚语、阿拉伯语、意大利语、俄语、葡萄牙语和乌克兰语的词干提取。如果内置的词干提取器不够用，该引擎还允许您轻松插入任何兼容的 Snowball 词干提取器。一些分支版本甚至支持中文。欢迎贡献其他语言！

与许多其他引擎不同，索引可以轻松更新，无需重新索引或使用增量更新。

查看在线演示 | 关注我们的 Twitter 或 Facebook | 访问我们的赞助商：

演示

教程

高级产品

如果您正在使用 TNT Search 并发现它很有用，请看看我们的高级分析工具：

在 Open Collective 上支持我们

TNTSearch

安装

安装 TNTSearch 最简单的方法是通过 composer：

composer require teamtnt/tntsearch

要求

在继续之前，请确保您的服务器满足以下要求：

PHP >= 7.1
PDO PHP 扩展
SQLite PHP 扩展
mbstring PHP 扩展

示例

创建索引

为了能够进行全文搜索查询，您需要创建一个索引。

用法：

use TeamTNT\TNTSearch\TNTSearch;

$tnt = new TNTSearch;

$tnt->loadConfig([
    'driver'    => 'mysql',
    'host'      => 'localhost',
    'database'  => 'dbname',
    'username'  => 'user',
    'password'  => 'pass',
    'storage'   => '/var/www/tntsearch/examples/',
    'stemmer'   => \TeamTNT\TNTSearch\Stemmer\PorterStemmer::class//可选
]);

$indexer = $tnt->createIndex('name.index');
$indexer->query('SELECT id, article FROM articles;');
//$indexer->setLanguage('german');
$indexer->run();

重要提示:"storage"设置标记了所有索引将保存的文件夹,因此请确保有权限写入该文件夹,否则可能会抛出以下异常:

[PDOException] SQLSTATE[HY000] [14] 无法打开数据库文件 *

注意:如果您的主键不是id,请这样设置:

$indexer->setPrimaryKey('article_id');

使主键可搜索

默认情况下,主键是不可搜索的。如果您想让它可搜索,只需运行:

$indexer->includePrimaryKey();

搜索

搜索短语或关键词非常简单:

use TeamTNT\TNTSearch\TNTSearch;

$tnt = new TNTSearch;

$tnt->loadConfig($config);
$tnt->selectIndex("name.index");

$res = $tnt->search("这是一个测试搜索", 12);

print_r($res); //返回最匹配查询的12个文档id数组

// 要显示结果,您需要对应用程序数据库进行额外查询
// SELECT * FROM articles WHERE id IN $res ORDER BY FIELD(id, $res);

ORDER BY FIELD子句很重要,否则数据库引擎将不会按所需顺序返回结果。

布尔搜索

use TeamTNT\TNTSearch\TNTSearch;

$tnt = new TNTSearch;

$tnt->loadConfig($config);
$tnt->selectIndex("name.index");

//这将返回所有包含romeo但不包含juliet的文档
$res = $tnt->searchBoolean("romeo -juliet");

//返回所有包含romeo或hamlet的文档
$res = $tnt->searchBoolean("romeo or hamlet");

//返回所有包含romeo和juliet,或prince和hamlet的文档
$res = $tnt->searchBoolean("(romeo juliet) or (prince hamlet)");

模糊搜索

可以通过设置以下成员变量来调整模糊度:

public $fuzzy_prefix_length  = 2;
public $fuzzy_max_expansions = 50;
public $fuzzy_distance       = 2; //表示Levenshtein距离;

use TeamTNT\TNTSearch\TNTSearch;

$tnt = new TNTSearch;

$tnt->loadConfig($config);
$tnt->selectIndex("name.index");
$tnt->fuzziness(true);

//当模糊标志设置为true时,关键词juleit将返回
//匹配单词juliet的文档,默认Levenshtein距离为2
$res = $tnt->search("juleit");

更新索引

创建索引后,每次对文档集合进行更改时都不需要重新索引。TNTSearch支持动态索引更新。

use TeamTNT\TNTSearch\TNTSearch;

$tnt = new TNTSearch;

$tnt->loadConfig($config);
$tnt->selectIndex("name.index");

$index = $tnt->getIndex();

//向索引插入新文档
$index->insert(['id' => '11', 'title' => '新标题', 'article' => '新文章']);

//更新现有文档
$index->update(11, ['id' => '11', 'title' => '更新的标题', 'article' => '更新的文章']);

//从索引中删除文档
$index->delete(12);

自定义分词器

首先,创建您自己的分词器类。它应该继承AbstractTokenizer类,定义单词分割$pattern值,并且必须实现TokenizerInterface:


use TeamTNT\TNTSearch\Support\AbstractTokenizer;
use TeamTNT\TNTSearch\Support\TokenizerInterface;

class SomeTokenizer extends AbstractTokenizer implements TokenizerInterface
{
    static protected $pattern = '/[\s,\.]+/';

    public function tokenize($text) {
        return preg_split($this->getPattern(), strtolower($text), -1, PREG_SPLIT_NO_EMPTY);
    }
}

这个分词器将使用空格、逗号和句号来分割单词。

准备好分词器后,您应该通过setTokenizer方法将其传递给TNTIndexer。

$someTokenizer = new SomeTokenizer;

$indexer = new TNTIndexer;
$indexer->setTokenizer($someTokenizer);

另一种方法是通过配置传递分词器:

use TeamTNT\TNTSearch\TNTSearch;

$tnt = new TNTSearch;
$tnt->loadConfig([
    'driver'    => 'mysql',
    'host'      => 'localhost',
    'database'  => 'dbname',
    'username'  => 'user',
    'password'  => 'pass',
    'storage'   => '/var/www/tntsearch/examples/',
    'stemmer'   => \TeamTNT\TNTSearch\Stemmer\PorterStemmer::class//可选,
    'tokenizer' => \TeamTNT\TNTSearch\Support\SomeTokenizer::class
]);

$indexer = $tnt->createIndex('name.index');
$indexer->query('SELECT id, article FROM articles;');
$indexer->run();

## 地理搜索

### 索引

```php
$candyShopIndexer = new TNTGeoIndexer;
$candyShopIndexer->loadConfig($config);
$candyShopIndexer->createIndex('candyShops.index');
$candyShopIndexer->query('SELECT id, longitude, latitude FROM candy_shops;');
$candyShopIndexer->run();

搜索

$currentLocation = [
    'longitude' => 11.576124,
    'latitude'  => 48.137154
];

$distance = 2; //公里

$candyShopIndex = new TNTGeoSearch();
$candyShopIndex->loadConfig($config);
$candyShopIndex->selectIndex('candyShops.index');

$candyShops = $candyShopIndex->findNearest($currentLocation, $distance, 10);

分类

use TeamTNT\TNTSearch\Classifier\TNTClassifier;

$classifier = new TNTClassifier();
$classifier->learn("一场精彩的比赛", "体育");
$classifier->learn("选举已经结束", "非体育");
$classifier->learn("非常干净的比赛", "体育");
$classifier->learn("一场干净但平淡无奇的比赛", "体育");

$guess = $classifier->predict("这是一场激烈的选举");
var_dump($guess['label']); //返回 "非体育"

保存分类器

$classifier->save('sports.cls');

加载分类器

$classifier = new TNTClassifier();
$classifier->load('sports.cls');

驱动

Laravel Scout 的 TNTSearch 驱动

PS4软件

您可以免费使用这个包，但如果它进入了您的生产环境，我们非常感谢您能给我们寄送一款您选择的PS4游戏。这样您就可以支持我们进一步开发并添加新功能。

我们的地址是：TNT Studio, Sv. Mateja 19, 10010 Zagreb, Croatia.

我们将在这里公布所有收到的游戏。

支持

支持者

每月捐款支持我们，帮助我们继续我们的活动。[成为支持者]

赞助商

成为赞助商，在我们的GitHub README上获得您的标志和网站链接。[成为赞助商]

鸣谢

许可证

来自克罗地亚，由TNT工作室（@tntstudiohr，博客）以♥制作

TNTSearch

演示

教程

高级产品

在 Open Collective 上支持我们

安装

要求

示例

创建索引

使主键可搜索

搜索

布尔搜索

模糊搜索

更新索引

自定义分词器

搜索

分类

保存分类器

加载分类器

驱动

PS4软件

支持

支持者

赞助商

鸣谢

许可证

编辑推荐精选

蛙蛙写作

Trae

问小白

Transly

讯飞智文

讯飞星火

Spark-TTS

咔片PPT

讯飞绘文

材料星

探索AI的无限可能

推荐工具精选

Trae

豆包

讯飞文书

讯飞绘文

讯飞绘镜

阿里绘蛙

咔片PPT

AI云服务特惠

火山引擎

阿里云

腾讯云

华为云

百度智能云

AWS

关注微信公众号