前往首页v1.12文档

    索引

    索引是一组具有关联设置的文档集合。它类似于 SQL 中的表或 MongoDB 中的集合。

    索引由一个 uid 定义，并包含以下信息：

    示例

    假设您管理一个包含电影信息的数据库，类似于 IMDb。您可能希望保留多种类型的文档，例如电影、电视剧、演员、导演等等。Meilisearch 中，这些类别中的每一个都将由一个索引表示。

    使用索引的设置，您可以自定义该索引的搜索行为。例如，一个 movies 索引可能包含具有 movie_id、title、genre、overview 和 release_date 等字段的文档。使用设置，您可以让电影的 title 比其 overview 对搜索结果产生更大的影响，或者使 movie_id 字段不可搜索。

    一个索引的设置不会影响其他索引。例如，您可以为 movies 索引使用与 costumes 索引不同的同义词列表，即使它们在同一服务器上。

    索引创建

    隐式索引创建

    如果您尝试向尚不存在的索引添加文档或设置，Meilisearch 将自动为您创建它。

    显式索引创建

    您可以使用创建索引端点显式创建一个索引。创建后，您可以使用添加文档端点添加文档。

    虽然隐式索引创建更方便，只需要一个 API 请求，但是显式索引创建被认为对于生产环境更安全。这是因为隐式索引创建将多个操作捆绑到一个任务中。如果一个操作成功完成，而另一个操作失败，则问题可能难以诊断。

    索引 UID

    uid 是索引的唯一标识符。它在创建索引时设置，并且必须是仅包含字母数字字符 a-z A-Z 0-9、连字符 - 和下划线 _ 的整数或字符串。

    一旦定义，uid 就不能更改，并且您不能创建另一个具有相同 uid 的索引。

    {
  "uid": "movies",
  "createdAt": "2019-11-20T09:40:33.711324Z",
  "updatedAt": "2019-11-20T10:16:42.761858Z"
}

    主键

    每个索引都有一个主键：一个必需的属性，该属性必须存在于索引中的所有文档中。每个文档都必须具有与此属性关联的唯一值。

    主键用于标识每个文档，以便索引中的两个文档永远不能完全相同。如果您添加两个具有相同主键值的文档，它们将被视为同一个文档：一个将覆盖另一个。如果您尝试添加文档，即使其中一个缺少主键，也不会存储任何文档。

    您可以为索引设置主键或让 Meilisearch 推断它。阅读更多关于设置主键的信息。

    了解更多关于主键字段的信息

    索引设置

    索引设置可以被认为是一个 JSON 对象，其中包含许多不同的选项，用于自定义搜索行为。

    您可以自定义以下索引设置：

    要更改索引设置，请使用更新设置端点或任何子路由。

    显示和可搜索属性

    默认情况下，每个文档字段都可搜索并在响应搜索查询时显示。但是，您可以选择将某些字段设置为不可搜索、不可显示，或两者都不可。

    您可以使用更新设置端点，或显示属性和可搜索属性各自的端点来更新这些字段属性。

    了解更多关于显示和可搜索属性的信息。

    去重属性

    如果您的数据集中包含多个相似的文档，您可能希望在搜索时只返回一个。假设您的 costumes 索引中有许多不同尺寸的黑色夹克。将 costume_name 设置为去重属性将意味着 Meilisearch 不会返回多个具有相同 costume_name 的黑色夹克。

    使用更新设置端点或更新去重属性端点来指定去重属性。每个索引只能设置一个字段作为去重属性。

    了解更多关于去重属性的信息。

    分面

    分面是 Meilisearch 中过滤器的特定用例：某物是分面还是过滤器取决于您的 UI 和 UX 设计。与过滤器一样，您需要将您的分面添加到filterableAttributes，然后使用filter 搜索参数进行搜索查询。

    默认情况下，Meilisearch 为每个分面字段返回 100 个分面值。您可以使用更新设置端点或更新分面设置端点更改此设置。

    了解更多关于分面的信息。

    可过滤属性

    过滤允许您根据不同的类别优化搜索。例如，您可以搜索特定 genre 的所有电影：Science Fiction，并且 rating 高于 8。

    在对任何文档属性进行过滤之前，您必须使用更新设置端点或更新可过滤属性端点将其添加到 filterableAttributes 中。然后，使用filter搜索参数进行搜索查询。

    了解更多关于过滤的信息。

    分页

    为了保护您的数据库免受恶意抓取，Meilisearch 的搜索查询最多只返回 1000 个结果。您可以使用更新设置端点或更新分页设置端点来更改此限制。

    了解更多关于分页的信息。

    排名规则

    Meilisearch 使用排名规则来对匹配的文档进行排序，以便最相关的文档出现在顶部。所有索引都使用相同的内置排名规则，并按默认顺序执行。这些规则的顺序很重要：第一个规则影响最大，最后一个规则影响最小。

    您可以更改此顺序或定义自定义排名规则，以首先返回某些结果。这可以使用更新设置端点或更新排名规则端点来完成。

    了解更多关于排名规则的信息。

    可排序属性

    默认情况下，Meilisearch 根据结果的相关性对其进行排序。您可以更改此排序行为，以首先显示某些结果。

    使用更新设置端点或更新可排序属性端点，将您想要排序的属性添加到 sortableAttributes 中。然后，您可以使用sort搜索参数按升序或降序对结果进行排序。

    了解更多关于排序的信息。

    停用词

    您的数据集可能包含您希望在搜索过程中忽略的词，例如，因为它们没有语义价值或出现频率过高（例如，英语中的 the 或 of）。您可以将这些词添加到停用词列表中，Meilisearch 将在搜索过程中忽略它们。

    使用更新设置端点或更新停用词端点来更改索引的停用词列表。除了提高相关性之外，将常用词指定为停用词还可以大大提高性能。

    了解更多关于停用词的信息。

    同义词

    您的数据集可能包含含义相似的词。对于这些词，您可以定义一个同义词列表：在搜索中将被视为相同或相似的词。由于拼写错误和拆分查询等因素，设置为同义词的词并不总是返回相同的结果。

    由于同义词是为给定索引定义的，因此它们不会应用于同一 Meilisearch 实例上的任何其他索引。您可以使用更新设置端点或更新同义词端点来创建您的同义词列表。

    了解更多关于同义词的信息。

    拼写容错

    拼写容错是一项内置功能，即使您的搜索查询包含拼写错误或错别字，也能帮助您找到相关结果，例如，输入 chickne 而不是 chicken。此设置允许您对索引执行以下操作

    您可以使用更新设置端点或更新拼写容错端点来更新拼写容错设置。

    了解更多关于拼写容错的信息。

    交换索引

    假设您有一个生产环境中的索引 movies，您的用户目前正在对其进行搜索请求。您想要部署一个具有不同设置的新版本的 movies，但是正常更新它可能会导致您的用户停机。这个问题可以使用索引交换来解决。

    要使用索引交换，您需要创建第二个索引 movies_new，其中包含您想要对 movies 进行的所有更改。

    这意味着 movies 的文档、设置和任务历史将与 movies_new 的文档、设置和任务历史交换，而搜索客户端不会有任何停机时间。enqueued 任务的任务历史不会被修改。

    一旦交换，您的用户仍然会向 movies 索引发出搜索请求，但它将包含 movies_new 的数据。您可以在交换后删除 movies_new，或者保留它以防万一出现问题，您想要换回去。

    交换索引是一个原子事务：要么所有索引都成功交换，要么都不交换。

    有关更多信息，请参阅交换索引端点。