如何用 Node.js 和 Elasticsearch 构建搜索引擎

Bertha 。 2023-01-13 10:48 149阅读 0赞

[Elasticsearch][] 是一款开源的搜索引擎，由于其高性能和分布式系统架构而备受关注。本文将讨论其关键特性，并手把手教你如何用它创建 Node.js 搜索引擎。

# Elasticsearch 概述 #

Elasticsearch 底层使用 [Apache Lucene][] 库，Apache Lucene 自身是一款高性能、基于文本的搜索引擎库。 Elasticsearch 并不以提供数据存储和检索等类数据库功能为核心目标，相反，它以搜索引擎(服务器端)为目标，意在提供数据索引、数据检索、和数据实时分析功能

Elasticsearch 采用分布式架构，因而通过新增节点、或者部署到系统已有节点上即可实现水平扩展。Elasticsearch 可以在数以百计的服务器上处理 PB级别的数据。水平扩展同时也意味着高可用性，如果有节点异常，数据可重新被调度执行。

一旦数据导入完成，即可被检索。Elasticsearch 提供无模式、JSON 格式文件存储、数据结构和类型自动检检测等功能。

Elasticsearch 同时采用完全 API 驱动，这意味着：几乎所有的操作都可在 HTTP 上通过使用符合 JSON 数据格式的Restful API 完成。Elasticsearch 提供多种程序语言的客户端 lib，包括 Node.js。本文档将使用 [the official client library][]。

Elasticsearch 对软硬件要求比较灵活。虽然官方建议线上环境采用 64GB 内存，和尽可能多 CPU 系统配置，但其在一个资源受限的系统中依然可以很好地运行（前提是你的数据集不大）。如本文中的示例，2GB 内存，单核 cpu 系统即可。

Elasticsearch 支持主流操作系统，如 Linux、Mac os 和 Windows，只需安装最新版的 Java 运行时环境(参考 Elasticsearch 安装章节)。对于本文中的示例，还需要安装 [Node.js][] (v0.11.0 之后的版本都可) 和 [npm][]。

### Elasticsearch术语 ###

Elasticsearch使用自己的术语，在某些情况下和典型的数据库系统中使用的术语不同。下面列出了Elasticsearch中常用的一些术语及其含义。

索引: 在Elasticsearch环境中，该术语有两个含义。第一个含义是添加数据的操作。当添加数据时，文本会被拆分成分词（token）（例如：单词），每个分词都会被索引。然而，一个索引也指的是所有索引数据的存储位置。通常，当我们导入数据时，数据会被索引成一个index。每次需要对数据执行任何操作时，都必须指定它的索引名。

类型:Elasticsearch在一个索引中对文档提供了更详细的分类，称为类型。一个索引中的每个文档还必须有一个类型。例如，我们可以定义一个图书馆（library）索引，然后再将数据索引成多种类型，比如，文章（article）、书（book）、报告（report）和演示（presentation）。由于索引几乎有固定的开销，所以建议使用较少的索引和较多的类型，而不是较多的索引和较少的类型。

检索: 如字面意思，你可以检索不同的索引和类型数据。Elasticsearch 提供了多种类型的检索关键字，如term、phrase、range、fuzzy，甚至还提供了地理数据的查询词。

过滤: Elasticsearch 支持过滤功能。根据不同的过滤规则过滤检索结果，以便进一步缩小检索结果集。Elasticsearch 依据相关性对文档进行排序。如果你为旧文档新增查询词，可能会触发文档的相关性排序，使得旧文档顺序发生变化。但如果只是新增过滤词，旧文档的顺序保持不变。

聚合: 可在不同类型的聚合数据上展开统计分析，比如minimum, maximum, average, summation, histograms, 等等.

建议: 针对文本输入，Elasticsearch 提供不同的建议类型，这些建议类型可以是一个单词、短语，甚至是完整的语句。

### 安装Elasticsearch ###

Elasticsearch 受Apache 2许可证保护，可以被下载，使用，免费修改。安装Elasticsearch 之前你需要先确保在你的电脑上安装了Java Runtime Environment (JRE) ，Elasticsearch 是使用java实现的并且依赖java库运行。你可以使用下面的命令行来检测你是否安装了java

java -version

推荐使用java最新的稳定版本（写这篇文章的时候是1.8）。你可以在[这里][Link 1]找到在你系统上安装java的指导手册。

接下来是下载最新版本的Elasticsearch （写这篇文章的时候是2.3.5），去[下载页][Link 2]下载ZIP 文件。Elasticsearch 不需要安装，一个zip文件就包含了可在所有支持的系统上运行的文件。解压下载的文件，就完成了。有几种其他的方式运行Elasticsearch ，比如：获得TAR 文件或者为不同Linux发行版本的包（看[这里][Link 3]）。

如果你使用的是Mac操作系统并且安装了 [Homebrew][] ，你就可以使用这行命令安装Elasticsearch brew install elasticsearch.Homebrew 会自动添加executables 到你的系统并且安装所需的服务。它也可以使用一行命令帮你更新应用:brew upgrade elasticsearch.

想在Windows上运行Elasticsearch ，可以在解压的文件夹里，通过命令行运行bin\\elasticsearch.bat 。对于其他系统，可以从终端运行 ./bin/elasticsearch.这时候，Elasticsearch 就应该可以在你的系统上运行了。

就像我之前提到的，你可以使用Elasticsearch的几乎所有的操作，都可以通过RESTful APIs完成。Elasticsearch 默认使用9200 端口。为了确保你正确的运行了Elasticsearch。在你的浏览器中打开http://localhost:9200/ ，将会显示一些关于你运行的实例的基本信息。

如果想深入阅读关于安装和故障排除，可以访问[文档][Link 4].

### 图形用户界面 ###

Elasticsearch不须图形用户界面，只通过REST APIs就提供了几乎所有的功能。然而如果我不介绍怎么通过APIs和 Node.js执行所有所需的操作，你可以通过几个提供了索引和数据的可视化信息GUI工具来完成，这些工具甚至含有一些高水平的分析。

[Kibana][], 是同一家公司开发的工具， 它提供了数据的实时概要，并提供了一些可视化定制和分析选项。Kibana 是免费的，这是[详细文档][Link 5]

还有一些是社区开发的工具，如 [elasticsearch-head][], [Elasticsearch GUI][], 甚至谷歌浏览器的扩展组件[ElasticSearch Toolbox][].这些工具可以帮你在浏览器中查看你的索引和数据，甚至可以试运行不同的搜索和汇总查询。所有这些工具提供了安装和使用的攻略。

# 创建一个Node.js环境 #

弹性搜索为Node.js提供一个官方模块，称为elasticsearch。首先，你需要添加模块到你的工程目录下，并且保存依赖以备以后使用。

npm install elasticsearch --save

然后，你可以在脚本里导入模块，如下所示：

const elasticsearch = require('elasticsearch');

最终，你需要创建客户端来处理与弹性搜索的通讯。在这种情况下，我假设你正在运行弹性搜索的本地机器IP地址是127.0.0.1，端口是9200（默认设置）。

const esClient = new elasticsearch.Client({
      host: '127.0.0.1:9200',
      log: 'error'
      });

日志选项确保所有错误被打印出来。在本篇文章末处，我将使用相同的esClient对象与Elasticsearch进行通讯。这里提供Node模块的复杂文档说明。

注意：这篇导读的所有源代码都可以在GitHub下载查看。最简单的查看方式是在你的PC机上克隆仓库，并且从那里运行示例代码：

git clone https://github.com:sitepoint-editors/node-elasticsearch-tutorial.git
    cd node-elasticsearch-tutorial
    npm install

在本教程中，我将使用 1000 篇学术论文里的内容，这些内容是根据随机算法逐一生成的，并以 JSON 格式提供，其中的数据格式如下所示：

{
        "_id": "57508457f482c3a68c0a8ab3",
        "title": "Nostrud anim proident cillum non.",
        "journal": "qui ea",
        "volume": 54,
        "number": 11,
        "pages": "109-117",
        "year": 2014,
        "authors": [
          {
            "firstname": "Allyson",
            "lastname": "Ellison",
            "institution": "Ronbert",
            "email": "Allyson@Ronbert.tv"
          },
          ...
        ],
        "abstract": "Do occaecat reprehenderit dolore ...",
        "link": "http://mollit.us/57508457f482c3a68c0a8ab3.pdf",
        "keywords": [
          "sunt",
          "fugiat",
          ...
        ],
        "body": "removed to save space"
      }

JSON 格式中的每个字段如字面意思，无需多余解释，但值得注意的是：由于<body>包含随机生成的文章的全部的内容（大概有100~200个段落），所以并未展示，若要获取完整数据，请访问[这里][Link 6].

虽然 Elasticsearch 提供了[索引(indexing)][indexing]，[更新(updating)][updating]、[删除(deleting)][deleting]单个数据的方法，但我们采用[批量(bulk)][bulk]接口导入数据，因为批量接口在大型数据集上执行操作的效率更高。

// index.jsconst bulkIndex = function bulkIndex(index, type, data) {
      let bulkBody = [];
    
      data.forEach(item => {
        bulkBody.push({
          index: {
            _index: index,
            _type: type,
            _id: item.id      }
        });
    
        bulkBody.push(item);
      });
    
      esClient.bulk({body: bulkBody})
      .then(response => {
        console.log('here');
        let errorCount = 0;
        response.items.forEach(item => {
          if (item.index && item.index.error) {
            console.log(++errorCount, item.index.error);
          }
        });
        console.log(
          `Successfully indexed ${data.length - errorCount}
           out of ${data.length} items`
        );
      })
      .catch(console.err);};const test = function test() {
      const articlesRaw = fs.readFileSync('data.json');
      bulkIndex('library', 'article', articles);};

这里，我们调用函数bulkIndex建立索引，并传入 3 个参数，分别是：索引名 library，类型名library，JSON 数据格式变量 articles。bulkIndex函数自身则通过调用esClient对象的bulk接口实现，bulk 方法包含一个body属性的对象参数，并且每个body属性值是一个包含 2 种操作实体的数组对象。第一个实体是 JSON 格式的操作类型对象，该对象中的index属性决定了操作的类型(本例子是文件索引)、索引名、文件ID。第二个实体则是文件对象本身。

注意，后续可采用同样的方式，为其他类型文件（如书籍或者报告）添加索引。我们还可以有选择的每个文件分配一个唯一的ID，如果不体统唯一的ID，Elasticsearch 将主动为每个文件分配一个随机的唯一ID。

假设你已经从代码库中下载了 Elasticsearch 项目代码，在项目根目录下执行如下命令，即可将数据导入至Elasticsearch中：

$ node index.js
    1000 items parsed from data file
    Successfully indexed 1000 out of 1000 items

### 检查数据的索引是否准确 ###

Elasticsearch 最大的特性是接近实时检索，这意味着，一旦文档索引建立完成，1 秒内就可被检索(见[这里][Link 7])。索引一旦建立完成，则可通过运行 indice.js 检查索引信息的准确性([源码链接][Link 8])：

// indices.js
    
    const indices = function indices() {
      return esClient.cat.indices({v: true})
      .then(console.log)
      .catch(err => console.error(`Error connecting to the es client: ${err}`));
    };

client 中的cat 对象方法提供当前运行实例的各种信息。其中的 indices 方法列出所有的索引信息，包括每个索引的健康状态、以及占用的磁盘大小。 而其中的 v 选项为 cat方法新增头部响应。

当运行上面代码段，您会发现，集群的健康状态被不同的颜色标示。其中，红色表示为正常运行的有问题集群；黄色表示集群可运行，但存在告警；绿色表示集群正常运行。在本地运行上面的代码段，您极有可能(取决于您的配置)看到集群的健康状态颜色是黄色，这是因为默认的集群设置包含 5 个节点，但本地运行只有 1 个实例正常运行。鉴于本教程的目的仅局限于 Elasticsearch 指导学习，黄色即可。但在线上环境中，你必须确保集群的健康状态颜色是绿色的。

$ node indices.js
    elasticsearch indices information:
    health status index   pri rep docs.count docs.deleted store.size pri.store.size
    yellow open   library   5   1       1000            0     41.2mb         41.2mb

### 动态和自定义映射 ###

如前所述, Elasticsearch 无模式(schema-free)，这意味着，在数据导入之前，您无需定义数据的结构(类似于SQL数据库需要预先定义表结构)，Elasticsearch 会主动检测。尽管 Elasticsearch 被定义为无模式，但数据结构上仍有些限制。

Elasticsearch 以映射的方式引用数据结构。当数据索引建立完成后，如果映射不存在，Elasticsearch 会依次检索 JSON 数据的每个字段，然后基于被字段的类型(type)自动生成映射(mapping)。如果存在该字段的映射，则会确保按照同样的映射规则新增数据。否则直接报错。

比如：如果\{"key1": 12\} 已经存在，Elasticsearch 自动将字段 key1 映射为长整型。现在如果你尝试通过\{"key1": "value1", "key2": "value2"\} 检索, 则会直接报错，因为系统预期字段 key1 为长整型。同时，如果通过 \{"key1": 13, "key2": "value2"\} 检索则不会报错，并为字段 key2 新增 string 类型。

映射不能超出文本的范围，大都数情况下，系统自动生成的映射都可正常运行。如果想深入了解映射，建议查阅[Elasticsearch 文档][Elasticsearch 1]。

## 构建查询引擎 ##

数据索引一旦成功建立，就可立马构建查询引擎。 Elasticsearch 提供了一种构建在 JSON 格式之上，直观、完整的检索查询结构，称之为查询DSL(Query DSL),来定义查询。Elasticsearch支持多种类型的检索词，但本文只说明几个比较常见的类型检查词，更详细的查询DSL(Query DSL)文档,请参考[这里][Link 9]：

> 请记住，每个示例代码我都提供对应的链接。环境配置完成和测试数据索引成功建立后，你可以通过从[代码库][Link 10] 克隆代码到本地，其中的任何示例都可成功执行，只需要在命令中运行 node filename.js

### 以一个或者多个索引的形式返回所有文件内容 ###

我们将使用client 端提供的各种检索方法执行检索操作。最简单的检索方式是：match\_all，该方法讲所有文件内容以一个或者多个索引的形式返回。如何以一个索引的方式返回所有文档内容，请看下面示例：([源码链接][Link 11]).

//search_all.js
    
    const search = function search(index, body) {
      return esClient.search({index: index, body: body});
    };
    
    const test = function test() {
      let body = {
        size: 20,
        from: 0,
        query: {
          match_all: {}
        }
      };
    
      search('library', body)
      .then(results => {
        console.log(`found ${results.hits.total} items in ${results.took}ms`);
        console.log(`returned article titles:`);
        results.hits.hits.forEach(
          (hit, index) => console.log(
            `\t${body.from + ++index} - ${hit._source.title}`
          )
        )
      })
      .catch(console.error);
    };

主要的检索词被包含在 query 对象中。稍后我们还可以为该 query 对象新增其他不同类型的检索词。需要为每个 query 对象添加一个关键检索类型(本例是 match\_all)，且值是一个包含检索选项对象。在这个例子中，由于我们需要返回所有文件的索引，所以没设置可选项。

除了 query 对象之外，检索主体还可以包含其他可选属性，比如 size(大小)和 from(出处)。 size(大小)属性表明响应中包含的文档的数量，如果不设置该属性值，默认返回10个文档。from(出处)属性表明待返回文档的起始索引的位置，用于分页场景。

### 理解查询API的返回结果 ###

如果你打印搜索API返回结果（上面例子的结果）日志。由于它包含了很多信息，刚开始看起来无所适从。

{ took: 6,
      timed_out: false,
      _shards: { total: 5, successful: 5, failed: 0 },
      hits:
       { total: 1000,
         max_score: 1,
         hits:
          [ [Object],
            [Object],
        ...
            [Object] ] } }

在最高级别日志输出里，返回结果中含有took 属性，该属性值表示查找结果所用的毫秒数，timed\_out只有在最大允许时间内没有找到结果时为true，\_shards 是不同节点的状态的信息（如果部署的是节点集群），hits是查询结果。

hits的属性值是一个含有下列属性的对象：

*  total —表示匹配的条目的总数量
 *  max\_score — 找到的条目的最大分数
 *  hits — 找到的条目的数组，在hits数组里的每一天记录，都有索引，类型，文档，ID，分数，和记录本身（在\_source元素内）。

这十分复杂，但是好消息是一旦你实现了一个提取结果的方法，不管你的搜索查询结果时什么，你都可以使用相同的格式获取结果。

还需要注意的是Elasticsearch 有一个好处是它自动地给每一个匹配记录分配分数，这个分数用来量化文件的关联性，返回结果的顺序默认的按钮分数倒排。在例子中我们使用match\_all取回了所有的记录，分数是没有意义的，所有的分数都被计算为1.

### 匹配含指定字段值的文档 ###

现在我们看几个更加有趣的例子. 我们可以通过使用 match 关键字查询文档是否与指定的字段值匹配。一个最简单的包含 match 关键字的检索主体代码如下所示：([源码链接][Link 12]).

// search_match.js
    
    {
      query: {
        match: {
          title: {
            query: 'search terms go here'
          }
        }
      }
    }

如上文所述, 首先通过为查询对象新增一个条目，并指定检索类型，上面示例给的是 match 。然后再检索类型对象里面，申明待检索的文档对象，本例是 title 文档对象。然后再文档对象里面，提供相关检索数据，和 query 属性。我希望你测试过上述示例之后，惊讶于 Elasticsearch 的检索效率。

上述示例执行成功后，将返回title(标题)字段与任一 query 属性词匹配的所有文档信息。同时还可以参考如下示例，为查询对象附加最小匹配数量条件：

// search_match.js
    
    ...
    match: {
      title: {
        query: 'search terms go here',
        minimum_should_match: 3
      }
    }
    ...

与该查询匹配的文档 title(标题)字段至少包含上诉指定的 3 个关键词。如果查询关键词少于 3个，那么匹配文档的 title(标题)字段必须包含所有的查询词。Elasticsearch 的另一个有用的功能是 fuzziness(模糊匹配).这对于用户输入错误的查询词将非常有用，因为fuzzy(模糊匹配)将发现拼写错误并给出最接近词供选择。对于字符串类型，每个关键字的模糊匹配值是根据算法 [Levenshtein distance][] 算出的最大允许值。fuzziness(模糊匹配)示例如下所示：

match: {
      title: {
        query: 'search tems go here',
        minimum_should_match: 3,
        fuzziness: 2
      }
    }

### 多个字段搜索 ###

如果你想在多个字段中搜索，可以使用multi\_match搜索类型。除了Query对象中的fields属性外，它同match有点类似。fields属性是需要搜索的字段的集合。这里我们将在title,authors.firstname, 和authors.lastname 字段中搜索（[源码][Link 13]）。

// search_multi_match
    
    multi_match: {
      query: 'search terms go here',
      fields: ['title', 'authors.firstname',  'authors.lastname']
    }

multi\_match查询支持其他搜索属性，如minimum\_should\_match 和fuzziness。Elasticsearch支持使用通配符（如\*）匹配字段，那么我们可以使用\['title', 'authors.\*name'\]把上面的例子变得更短些。

### 匹配一个完整的句子 ###

Elasticsearch也支持精确的匹配一个输入的句子，而不是在单词级别。这个查询是在普通的match 查询上扩展而来，叫做 match\_phrase。下面是一个match\_phrase的例子（[源码][Link 14]）

// match_phrase.js
    
    match: {
      title: {
        query: 'search phrase goes here',
        type: 'phrase'
      }}

### 联合多个查询 ###

到目前为止，在例子中我们每次请求只使用了单个查询。然而Elasticsearch允许你联合多个查询。最常用的复合查询是bool，bool查询接受4种关键类型must, should, must\_not, 和filter. 像它们的名字表示的那样，在查询结果的数据里必须匹配must里的查询，必须不匹配must\_not里的查询，如果哪个数据匹配should里的查询，它就会获得高分。每一个提到的元素可以使用查询数组格式接受多个搜索查询。

下面，我们使用bool查询及一个新的叫做query\_string的查询类型。它允许你使用 AND 或 OR写一些比较高级的查询。在[这里][Link 15]可以看到 query\_string语法的所有文档。另外，我们使用了 range查询（文档在[这里][Link 16]），它可以让我们通过给定的范围的方式去限制一个字段。（[源码][Link 17]）

// search_bool.js
    
    {
      bool: {
        must: [
          {
            query_string: {
              query: '(authors.firstname:term1 OR authors.lastname:term2) AND (title:term3)'
            }
          }
        ],
        should: [
          {
            match: {
              body: {
                query: 'search phrase goes here',
                type: 'phrase'
              }
            }
          }
        ],
        must_not: [
          {
            range: {
              year: {
                gte: 2011,
                lte: 2013
              }
            }
          }
        ]
      }
    }

在上面的例子中，查询返回的数据，作者的名包含term1 或它们的姓包含term2，并且它们的title含有term3，而且它们不在2011,2012或2013年出版的，还有在body字段里含有给定句子数据将获得高分，并被排列到结果的前面（由于在should从句中的match 查询）。

## 过滤，聚合，和建议 ##

除了它先进的搜索功能外，Elasticsearch 还提供了其他的功能。接下来，我们再看看其他三个比较常用的功能。

### 过滤 ###

也许，你经常想使用特定的条件凝缩查询结果。Elasticsearch通过filters 提供了这样的功能。在我们的文章数据里，假设你的查询返回了几个文章，这些文章是你选择的在5个具体年份发布的文章。你可以简单的从搜索结果中过滤出那些不匹配条件的数据，而不改变查询结果的顺序。

在bool 查询的must 从句中，过滤和相同查询之间的不同之处在于，过滤不会影响搜索分数，而must 查询会。当查询结果返回并且用户使用给定的条件过滤时，他们不想改变结果的顺序，相反地，他们只想从结果中移除不相关的数据。过滤与搜索的格式一样，但在通常情况下，他们在有明确值的字段上定义，而不是文本字符串上。Elasticsearch 推荐通过bool复合查询的filter从句添加过滤。

继续看上面的例子，假设我们想把搜索结果限制在在2011到2015年之间发布的文章里。这样做，我们只需要在一般搜索查询的filter 部分添加range 查询。这将会从结果中移除那些不匹配的数据。下面是一个过滤查询的例子（[源码][Link 18]）。

// filter.js
    
    {
      bool: {
        must: [
          {
            match: {
              title: 'search terms go here'
            }
          }
        ],
        filter: [
          {
            range: {
              year: {
                gte: 2011,
                lte: 2015
              }
            }
          }
        ]
      }
    }

### 聚合 ###

聚合框架会基于一次搜索查询，提供各种聚合数据和统计信息。两个主要的聚合类型是度量和分块, 度量聚合会对一个文档的集合进行持续的跟踪并计算度量，而分块聚合则会进行块的构建，每个块都会跟一个键和一个文档查询条件关联起来。度量聚合的示例有平均值，最小值，最大值，加总值还有计数值。分块聚合的示例有范围、日期范围、直方图以及主题项。对聚合器更加深入的描述可以在 [这里][Link 19] 找到。

聚合可以放置在一个 aggregations 对象里面，而对象自己则是被直接放到 search 对象体中。在 aggregations 对象里面，每一个键都是由用户赋予一个聚合器的名称。聚合器的类型和其它选项都应该是作为这个键的值而放置的。接下来我们要来看看两个不同类型的聚合器，一个是度量的，一个块的。我们会用度量聚合器来尝试找出数据集合中最小的年份值（也就是最久远的文章），而使用块集合器我要做的就是尝试找出每一个关键词各自出现了多少次。([源代码链接][Link 20])

// aggregations.js{
      aggregations: {
        min_year: {
          min: {field: 'year'}
        },
        keywords: {
          terms: {field: 'keywords'}
        }
      }}

在上述示例中，我们将度量聚合器命名为 min\_year (也可以是其它名称), 也就是 year 这个域上的 min 类型。块聚合器责备命名为 keywords, 就是 keywords 这个域上的 terms 类型。聚合操作的结果被装在了响应消息里的 aggregations 元素里面，更深入一点会发现里面包含了每一个聚合器（这里是 min\_year 和 keywords）以及它们的聚合操作结果。 如下是来自这个示例响应消息中的部分内容。

{
    ...
      "aggregations": {
        "keywords": {
          "doc_count_error_upper_bound": 0,
          "sum_other_doc_count": 2452,
          "buckets": [
            {
              "key": "pariatur",
              "doc_count": 88
            },
            {
              "key": "adipisicing",
              "doc_count": 75
            },
            ...
          ]
        },
        "min_year": {
          "value": 1970
        }
      }
    }

响应消息中默认最多会有10个块返回。你可以在请求中 filed 的边上加入一个size键来规定返回的块的最大数量。如果你想要接收到所有的块，可以将这个值设置为 0。

### 建议 ###

Elasticsearch 提供了多种可以对输入内容提供替换和补全的关联项推荐器（见[文档][Link 21]）。下面将介绍术语和短语推荐器。术语推荐器为每个输入文本中的术语提供关联推荐（如果有的话），而短语推荐器将整个输入文本看做一个短语（与将其拆分成术语对比），然后提供其他短语的推荐（如果有的话）。使用推荐API时，需要调用Node.js client的suggest方法。如下为术语推荐器的示例。（见[源码][Link 22]）

// suggest_term.js
    
    esClient.suggest({
      index: 'articles',
      body: {
        text: 'text goes here',
        titleSuggester: {
          term: {
            field: 'title',
            size: 5
          }
        }
      }
    }).then(...)

与其他client的方法相同，在请求体中包含一个index字段指明采用的索引。在body字段中添加查询推荐的文本，然后给每个推荐器一个（包含了聚合对象的）名称（本例中的titleSuggester）。其值指明了推荐器的类型和配置。这里，为title字段使用了术语推荐器，限制最大建议的数量是每个token最多5个（size: 5）。

建议API返回的数据中包含了对应请求中每一个建议器的key，其值是一个与你输入文本中术语数量相同的一个数组。对于数组中的每一个元素，包含一个options数组，其每个对象的text字段中包含了推荐的文本。如下是上面例子中返回数据的一部分。

...
    "titleSuggester": [
      {
        "text": "term",
        "offset": 0,
        "length": 4,
        "options": [
          {
            "text": "terms",
            "score": 0.75,
            "freq": 120
          },
          {
            "text": "team",
            "score": 0.5,
            "freq": 151
          }
        ]
      },
      ...
    ]
    ...

获取短语推荐的时候，采用与上文相同的格式并替换推荐器的类型字段即可。如下的例子中，返回数据将与上例格式相同。（见[源码][Link 23]）

// suggest_phrase.js
    
    esClient.suggest({
      index: 'articles',
      body: {
        text: 'phrase goes here',
        bodySuggester: {
          phrase: {
            field: 'body'
          }
        }
      }
    }).then(...).catch(...)

[![debugging][]][debugging 1]

debugging

翻译于 2年前

1人顶

顶 翻译得不错哦！

## 进一步阅读 ##

Elasticsearch 提供了许多特性，这些特性远远超出了这一篇文章所能讨论的范围。在这篇文章中，我试图站在一个很高的层次上来解释它的特性，并为你提供可用来进一步学习的合适资源。Elasticsearch是非常可靠的，并且有着出色的表现（我希望你在运行范例时已经注意到了这一点）。再加之不断增长的社区支持，使得Elasticsearch在工业中的应用也在不断增加，尤其是对于需要处理实时数据或大数据的公司。

学习完这里提供的例子之后，我强烈建议你阅读一些相关文档。文档有两个主要来源，一是[Elasticsearch参考及其特性][Elasticsearch 2]，另外还有一个[指南][Link 24]，它更多关注的是具体实现，使用案例以及最佳实践。你也可以在[这里][Link 25]找到Node.js客户端的详细文档

[Elasticsearch]: https://www.elastic.co/products/elasticsearch
[Apache Lucene]: https://lucene.apache.org/
[the official client library]: https://github.com/elastic/elasticsearch-js
[Node.js]: https://www.sitepoint.com/quick-tip-multiple-versions-node-nvm/
[npm]: https://www.sitepoint.com/beginners-guide-node-package-manager/
[Link 1]: https://java.com/en/download/help/download_options.xml
[Link 2]: https://www.elastic.co/downloads/elasticsearch
[Link 3]: https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html
[Homebrew]: http://brew.sh/
[Link 4]: https://www.elastic.co/guide/en/elasticsearch/reference/current/_installation.html
[Kibana]: https://www.elastic.co/products/kibana
[Link 5]: https://www.elastic.co/guide/en/kibana/current/index.html
[elasticsearch-head]: http://mobz.github.io/elasticsearch-head/
[Elasticsearch GUI]: http://www.gridshore.nl/esgui/
[ElasticSearch Toolbox]: https://chrome.google.com/webstore/detail/elasticsearch-toolbox/focdbmjgdonlpdknobfghplhmafpgfbp
[Link 6]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/data.json
[indexing]: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-index
[updating]: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-update
[deleting]: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-delete
[bulk]: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-bulk
[Link 7]: https://www.elastic.co/guide/en/elasticsearch/guide/current/near-real-time.html
[Link 8]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/indices.js
[Elasticsearch 1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html
[Link 9]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
[Link 10]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial
[Link 11]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/search_all.js
[Link 12]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/search_match.js
[Levenshtein distance]: https://en.wikipedia.org/wiki/Levenshtein_distance
[Link 13]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/search_multi_match.js
[Link 14]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/search_match_phrase.js
[Link 15]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html
[Link 16]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html
[Link 17]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/search_bool.js
[Link 18]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/filter.js
[Link 19]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html
[Link 20]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/aggregations.js
[Link 21]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html
[Link 22]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/suggest_term.js
[Link 23]: https://github.com/sitepoint-editors/node-elasticsearch-tutorial/blob/master/suggest_phrase.js
[debugging]: /images/20221022/0da415083d3b4bffac8acd17ebe9e939.png
[debugging 1]: https://my.oschina.net/debugging
[Elasticsearch 2]: https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
[Link 24]: https://www.elastic.co/guide/en/elasticsearch/guide/current/index.html
[Link 25]: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html