文档是由一个或多个字段组成的对象。每个字段都包含一个**属性**及其关联的**值**。文档充当组织数据的容器，是 Meilisearch 数据库的基本组成单元。要搜索文档，您必须首先将其添加到索引中。

如果两个索引包含完全相同的文档，它们之间不会共享任何内容。相反，这两个文档将被视为不同的文档。根据索引的设置，文档可能具有不同的大小。

​
结构

​
重要术语

  • **文档**：包含一个或多个字段形式数据的对象
  • **字段**：一组两个相互关联的数据项：一个属性和一个值
  • **属性**：字段的第一部分。用作其关联值的名称或描述
  • **值**：字段的第二部分，由任何有效的 JSON 类型数据组成
  • **主字段**：所有文档中都必须存在的特殊字段。它包含主键和文档标识符

​
字段

**字段**是相互关联的两个数据项的集合：一个属性和一个值。文档由字段组成。

**属性**是区分大小写的字符串，用作字段的名称，允许您存储、访问和描述数据。

该数据是字段的**值**。每个字段都有一个由其值决定的数据类型。每个值都必须是有效的JSON 数据类型。

如果该值为字符串，它**最多可以包含 65535 个位置**。超过 65535 位置限制的单词将被忽略。

如果一个字段包含一个对象，Meilisearch 会在索引期间使用点表示法将其展平，并将对象的键和值带到文档本身的根级别。这个扁平化的对象只是一个中间表示——您将在搜索时获得原始结构。您可以在我们的专用指南中了解更多信息。

通过排名规则，您可以决定哪些字段比其他字段更相关。例如，您可能决定最近的电影应该比旧的电影更相关。您还可以将某些字段指定为显示字段或可搜索字段。

某些功能要求 Meilisearch 保留属性。例如，要使用地理搜索功能，您的文档必须包含一个 _geo 字段。

保留属性始终以 underscore (_) 前缀。

​
显示和可搜索字段

默认情况下，文档中的所有字段既是显示字段又是可搜索字段。显示字段包含在每个匹配的文档中，而可搜索字段用于搜索匹配的查询词。

您可以使用更新设置端点，或显示属性和可搜索属性的相应更新端点来修改此行为，从而使字段变为

  • 可搜索但不可显示
  • 可显示但不可搜索
  • 既不可显示也不可搜索

在后一种情况下，该字段在搜索期间将被完全忽略。但是，它仍将存储在文档中。

要了解更多信息，请参阅我们的显示和可搜索属性指南。

​
主字段

主字段是所有文档中都必须存在的特殊字段。其属性是主键，其值是文档 ID。如果您尝试索引缺少主键或具有给定索引错误主键的文档，则会发生错误，并且不会添加任何文档。

要了解更多信息，请参阅主键说明。

​
上传

默认情况下，Meilisearch 将所有负载（以及文档上传）的大小限制为 100MB。您可以在运行时使用 http-payload-size-limit 选项更改负载大小限制。

Meilisearch 在索引文档时会占用大量 RAM。请注意您的 RAM 可用性，因为增加批处理大小可能会导致 Meilisearch 崩溃。

使用添加新文档端点时，请确保

  • 负载格式正确。没有多余的逗号、不匹配的括号、缺失的引号等。
  • 所有文档都以数组形式发送，即使只有一个文档

​
数据集格式

Meilisearch 接受以下格式的数据集

​
JSON

表示为 JSON 对象的文档是括在花括号中的键值对。因此，适用于 JSON 对象格式的任何规则也适用于 Meilisearch 文档的格式。例如，属性必须是字符串，而值必须是有效的JSON 数据类型。

Meilisearch 只有在收到 application/json 内容类型头时才会接受 JSON 文档。

举个例子，假设您正在创建一个包含电影信息的索引。示例文档可能如下所示

{
  "id": 1564,
  "title": "Kung Fu Panda",
  "genres": "Children's Animation",
  "release-year": 2008,
  "cast": [
    { "Jack Black": "Po" },
    { "Jackie Chan": "Monkey" }
  ]
}

在上面的示例中

  • "id"、"title"、"genres"、"release-year" 和 "cast" 是属性
  • 每个属性都关联一个值，例如，"Kung Fu Panda" 是 "title" 的值
  • 文档包含一个字段，其属性是主键，值是唯一的文档 ID："id": "1564"

​
NDJSON

NDJSON 或 jsonlines 对象由单独的行组成，其中每行都是有效的 JSON 文本，并且每行都以换行符分隔。适用于 NDJSON 格式的任何规则也适用于 Meilisearch 文档。

Meilisearch 只有在收到 application/x-ndjson 内容类型头时才会接受 NDJSON 文档。

与 JSON 相比，NDJSON 具有更好的写入性能，并且对 CPU 和内存的占用更少。它更容易验证，并且与 CSV 不同，可以处理嵌套结构。

上述 JSON 文档在 NDJSON 中将如下所示

{ "id": 1564, "title": "Kung Fu Panda", "genres": "Children's Animation", "release-year": 2008, "cast": [{ "Jack Black": "Po" }, { "Jackie Chan": "Monkey" }] }

​
CSV

CSV 文件以由分隔符字符分隔的值序列表示数据。Meilisearch 接受 CSV 文档的 string、boolean 和 number 数据类型。如果您未指定属性的数据类型，它将默认为 string。空字段（如 ,, 和 , ,）将被视为 null。

默认情况下，Meilisearch 使用单个逗号 (,) 作为分隔符。使用 csvDelimiter 查询参数与添加或更新文档或添加或替换文档端点来设置不同的字符。适用于 CSV 格式的任何规则也适用于 Meilisearch 文档。

Meilisearch 只有在收到 text/csv 内容类型头时才会接受 CSV 文档。

与 JSON 相比，CSV 具有更好的写入性能，并且对 CPU 和内存的占用更少。

上述 JSON 文档在 CSV 中将如下所示

"id:number","title:string","genres:string","release-year:number"
  "1564","Kung Fu Panda","Children's Animation","2008"

由于 CSV 不支持数组或嵌套对象，cast 无法转换为 CSV。

​
自动批处理

自动批处理将相似的连续操作合并到一个批次中并一起处理。这显著加快了索引过程。

Meilisearch 在以下情况下批处理文档添加和删除等操作

  • 目标相同索引
  • 紧密连续

同一批次中的任务共享相同的 startedAt、finishedAt 和 duration 值。

如果任务因无效文档而失败，它将从批次中删除。批次的其余部分仍将正常处理。如果发生internal 错误，整个批次将失败，并且批次中的所有任务将共享相同的 error 对象。

​
自动批处理和任务取消

如果您正在取消的任务是批处理的一部分，Meilisearch 会中断整个过程，放弃所有进度，并取消该任务。然后，它会自动创建一个不包含已取消任务的新批处理，并立即开始处理该批处理。