npm 版本 GitHub package.json 版本

ItemsJS - JavaScript 搜索引擎

极其快速的 JavaScript 分面搜索引擎 - 轻量级、灵活且易于使用。专为在 JSON 数据集（最多 10 万项）上执行快速搜索而创建。

演示

查看更多演示示例

使用场景

Itemsjs 主要用于公司、产品、出版物、文档、工作或植物的数据分类。

来自亚马逊、赫尔墨斯、苹果、微软、詹姆斯库克大学、卡内基梅隆大学等机构的人员已实施了该解决方案。您可以在这里找到真实实施案例列表。

特性

超快速分面搜索：以极快的速度处理和过滤数据。
简单的全文搜索：直观简单的文本搜索。
相关性评分：根据相关性对搜索结果进行排名。
分面过滤和排序：通过各种分面过滤和排序结果。
分页
同时适用于前端和后端
与自定义全文搜索引擎集成

入门

NPM

npm install itemsjs

使用 CommonJS 语法

const itemsjs = require('itemsjs')(data, configuration);
const items = itemsjs.search();

使用 ES 模块语法

import itemsjs from 'itemsjs';
const searchEngine = itemsjs(data, configuration);
const items = searchEngine.search();

客户端

在浏览器中使用 UMD：

<!-- CDN -->
<!-- unpkg: 使用最新版本 -->
<script src="https://unpkg.com/itemsjs@latest/dist/index.umd.js"></script>
<!-- unpkg: 使用特定版本 -->
<script src="https://unpkg.com/itemsjs@2.1.24/dist/index.umd.js"></script>
<!-- jsdelivr: 使用特定版本 -->
<script src="https://cdn.jsdelivr.net/npm/itemsjs@2.1.24/dist/index.umd.js"></script>

<script>
  itemsjs = itemsjs(data, configuration);
  itemsjs.search()
</script>

在浏览器中使用 ES 模块：

<!-- 作为 ES 模块引入 -->
<script type="module">
  import itemsjs from 'https://unpkg.com/itemsjs@2.1.24/dist/index.module.js';
  // 在此初始化和使用 itemsjs
  const searchEngine = itemsjs(data, configuration);
  searchEngine.search();
</script>

使用示例

npm install itemsjs

# 下载 json 数据
wget https://raw.githubusercontent.com/itemsapi/itemsapi-example-data/master/items/imdb.json -O data.json

接下来，创建一个 search.js 文件，内容如下：

const data = require('./data.json');

const itemsjs = require('itemsjs')(data, {
  sortings: {
    name_asc: {
      field: 'name',
      order: 'asc'
    }
  },
  aggregations: {
    tags: {
      title: '标签',
      size: 10,
      conjunction: false
    },
    actors: {
      title: '演员',
      size: 10
    },
    genres: {
      title: '类型',
      size: 10
    }
  },
  searchableFields: ['name', 'tags']
});

/**
 * 获取过滤后的电影列表
 */
const movies = itemsjs.search({
  per_page: 1,
  sort: 'name_asc',
  // 全文搜索
  // query: 'forrest gump',
  filters: {
    tags: ['1980s']
  }
})
console.log(JSON.stringify(movies, null, 2));

/**
 * 获取热门标签列表
 */
const top_tags = itemsjs.aggregation({
  name: 'tags',
  per_page: 10
})
console.log(JSON.stringify(top_tags, null, 2));

使用 Node.js 运行脚本：

node search.js

集成

如果原生全文搜索不够用，您可以与外部全文搜索集成。

工作原理：

数据中的每个项目都需要有 id 字段。也可以是自定义字段，但需要定义。
配置中的 native_search_enabled 选项应该被禁用。
在您的搜索引擎和 itemsjs 中索引数据一次。
在自定义搜索中进行搜索，并将 ids 数据提供给 itemsjs。
完成！

示例：

API

`const itemsjs = ItemsJS(data, [configuration])`

`data`

第一个 data 参数是对象数组。

`configuration`

负责定义全局配置。完整示例请参见配置

aggregations 过滤器配置，如 tags、actors、colors 等。负责生成分面。

每个过滤器可以有自己的配置。您可以在 search() 响应的 buckets 中访问这些配置。
title 人类可读的过滤器名称
size 为此过滤器提供的值的数量（默认：10）
sort 值按count（默认）或key（值名称）排序。这也可以是一个定义排序优先级的键数组
order asc | desc。这也可以是一个顺序数组（如果sort也是数组）
show_facet_stats true | false（默认）以从整个过滤数据集中检索最小、最大、平均、总评分值
conjunction true（默认）表示 AND 查询（结果必须符合所有选定的分面值），false 表示 OR 查询（结果必须符合所选分面值之一）
chosen_filters_on_top true（默认）已选择的过滤器将显示在未选择的过滤器之上，false 表示过滤器按照sort和order设定的顺序显示，不考虑是否被选中
hide_zero_doc_count true | false（默认）隐藏返回结果为0的过滤器
sortings 你可以配置不同的排序方式，如tags_asc、tags_desc，并带有选项，以后可以使用一个键来使用它。
searchableFields 可搜索字段的数组。
native_search_enabled 是否启用原生全文搜索（true | false。默认启用）
isExactSearch 设置为true如果你总是想显示精确搜索匹配。参见lunr stemmer和lunr stopWordFilter。
removeStopWordFilter 设置为true如果你想移除停用词过滤器。参见https://github.com/itemsapi/itemsjs/issues/46。