Resin 项目介绍
Resin 是一个远程 HTTP 搜索引擎,也可以作为嵌入式库使用。这个项目基于向量空间索引开发,旨在提供灵活、快速的数据搜索服务。
Resin 的使用方式
Resin 提供了两种主要操作文档的方法:远程和本地。
远程写入文档
用户可以通过 HTTP POST 请求远程写入数据。请求格式如下:
- 请求示例:
[host]/write?collection=[collection]
(例如:http://localhost/write?collection=mycollection
) - 内容类型:
application/json
数据以 JSON 格式提交,如下:
[
{
"field1": "value1",
"field2": "value2"
}
]
本地写入文档
用户还可选择在本地写入文档数据,代码示例为:
using (var database = new DocumentDatabase<string>(_directory, collectionId, model, strategy))
{
foreach (var document in documents)
{
database.Write(document);
}
database.Commit();
}
查询数据
Resin 提供多种查询方式,支持 GET 和 POST 方法。
GET 查询
GET 请求格式示例:
- 请求示例:
[host]/query/?collection=mycollection&q=[my_query]&field=field1&field=field2&select=field1&skip=0&take=10
- 接受类型:
application/json
POST 查询
POST 请求允许更复杂的条件查询,格式为:
- 请求示例:
[host]/query/?select=field1&skip=0&take=10
- 内容类型:
application/json
- 接受类型:
application/json
数据体以 JSON 格式描述查询条件:
{
"and":
{
"collection": "film,music",
"title": "rocky eye of the tiger",
"or":
{
"title": "rambo",
"or":
{
"title": "cobra"
"or":
{
"cast": "antonio banderas"
}
}
},
"and":
{
"year": 1980,
"operator": "gt"
},
"not":
{
"title": "first blood"
}
}
}
本地查询
本地查询同样通过程序代码实现:
using (var database = new DocumentDatabase<string>(_directory, collectionId, model, strategy))
{
var queryParser = database.CreateQueryParser();
var query = queryParser.Parse(collectionId, word, "title", "title", and:true, or:false, label:true);
var result = database.Read(query, skip: 0, take: 1);
}
文档数据库
Resin 使用文档集合存储数据,用户可以根据自己的模型和索引策略在写入和查询时应用这些策略。写入过程中,管道会为每个文档字段生成一组索引(图形),用户可以通过 JSON HTTP API 或编程方式与其交互。
向量索引
Resin 的索引是二叉搜索树,这些树根据其内容将相似的向量聚集在一起。每当一个新节点加入图中,其余弦角决定其在图中的位置。
性能优势
目前,Resin 能够在处理 Wikipedia 规模的数据集时提供秒级的短语搜索性能。
其他特性
- 用户可以使用命令行工具 Sir.Cmd 构建、验证和优化索引。
- 通过指定 JSON 结果中需要返回的字段,提升读取效率。
- 如果 JSON 不适合,用户可以实现其他消息格式如 XML。
- 构建跨字段甚至跨集合的复合查询,并通过 JSON 或编程方式提交。
- 支持使用稀疏或密集向量构建几乎任何维度的嵌入索引方案。
Resin 项目致力于提供简便灵活的搜索解决方案,无论是远程 API 还是本地编程都能支持用户自定义的搜索需求。