设置

使用 /settings 路由自定义给定索引的搜索设置。您可以使用 更新设置端点 一次性修改所有索引设置，或者使用子路由配置单个设置。

有关索引设置的概念性概述，请参阅索引解释。要了解有关索引配置的基础知识，请参阅索引配置教程。

​

设置界面

Meilisearch Cloud 除了 /settings 路由外，还提供了一个用户友好的图形界面来管理索引设置。Cloud 界面提供了更即时和可见的反馈，并且与搜索预览结合使用时有助于调整相关性。

​

设置对象

默认情况下，设置对象如下所示。所有字段均可修改。

{
  "displayedAttributes": [
    "*"
  ],
  "searchableAttributes": [
    "*"
  ],
  "filterableAttributes": [],
  "sortableAttributes": [],
  "rankingRules":
  [
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness"
  ],
  "stopWords": [],
  "nonSeparatorTokens": [],
  "separatorTokens": [],
  "dictionary": [],
  "synonyms": {},
  "distinctAttribute": null,
  "typoTolerance": {
    "enabled": true,
    "minWordSizeForTypos": {
      "oneTypo": 5,
      "twoTypos": 9
    },
    "disableOnWords": [],
    "disableOnAttributes": []
  },
  "faceting": {
    "maxValuesPerFacet": 100
  },
  "pagination": {
    "maxTotalHits": 1000
  },
  "proximityPrecision": "byWord",
  "facetSearch": true,
  "prefixSearch": "indexingTime",
  "searchCutoffMs": null,
  "embedders": {}
}

​

所有设置

此路由允许您一次性检索、配置或重置索引的所有设置。

​

获取设置

获取索引的设置。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/settings'

响应：200 Ok

{
  "displayedAttributes": [
    "*"
  ],
  "searchableAttributes": [
    "*"
  ],
  "filterableAttributes": [],
  "sortableAttributes": [],
  "rankingRules":
  [
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness"
  ],
  "stopWords": [],
  "nonSeparatorTokens": [],
  "separatorTokens": [],
  "dictionary": [],
  "synonyms": {},
  "distinctAttribute": null,
  "typoTolerance": {
    "enabled": true,
    "minWordSizeForTypos": {
      "oneTypo": 5,
      "twoTypos": 9
    },
    "disableOnWords": [],
    "disableOnAttributes": []
  },
  "faceting": {
    "maxValuesPerFacet": 100
  },
  "pagination": {
    "maxTotalHits": 1000
  },
  "proximityPrecision": "byWord",
  "facetSearch": true,
  "prefixSearch": "indexingTime",
  "searchCutoffMs": null,
  "embedders": {}
}

​

更新设置

更新索引的设置。

将 null 传递给索引设置会将其重置为默认值。

设置路由中的更新是部分更新。这意味着请求体中未提供的任何参数将保持不变。

如果提供的索引不存在，则会创建它。

​

路径参数

​

请求体

​

示例

curl \
  -X PATCH 'MEILISEARCH_URL/indexes/movies/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "rankingRules": [
      "words",
      "typo",
      "proximity",
      "attribute",
      "sort",
      "exactness",
      "release_date:desc",
      "rank:desc"
    ],
    "distinctAttribute": "movie_id",
    "searchableAttributes": [
      "title",
      "overview",
      "genres"
    ],
    "displayedAttributes": [
      "title",
      "overview",
      "genres",
      "release_date"
    ],
    "stopWords": [
      "the",
      "a",
      "an"
    ],
    "sortableAttributes": [
      "title",
      "release_date"
    ],
    "synonyms": {
      "wolverine": [
        "xmen",
        "logan"
    ],
      "logan": ["wolverine"]
    },
    "typoTolerance": {
      "minWordSizeForTypos": {
        "oneTypo": 8,
        "twoTypos": 10
      },
      "disableOnAttributes": ["title"]
    },
    "pagination": {
      "maxTotalHits": 5000
    },
    "faceting": {
      "maxValuesPerFacet": 200
    },
    "searchCutoffMs": 150
  }'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

重置设置

将索引的所有设置重置为其默认值。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/movies/settings'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

词典

允许用户通过添加用户定义术语的补充词典，指示 Meilisearch 将字符串组视为单个术语。

这在处理包含许多特定领域词汇的数据集以及在日语等不使用空格分隔词语的语言中特别有用。

自定义词典在某些以空格分隔的语言用例中也很有用，例如包含 "J. R. R. Tolkien" 和 "W. E. B. Du Bois" 等名称的数据集。

"dictionary": ["W. E. B.", "W.E.B."],
"synonyms": {
  "W. E. B.": ["W.E.B."],
  "W.E.B.": ["W. E. B."]
}

​

获取词典

获取索引的用户定义词典。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/books/settings/dictionary'

响应：200 OK

[]

​

更新词典

更新索引的用户定义词典。

​

路径参数

​

请求体

["J. R. R.", "W. E. B."]

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/books/settings/dictionary' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "J. R. R.",
    "W. E. B."
  ]'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2023-09-11T15:39:06.073314Z"
}

使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

重置词典

将索引的词典重置为默认值 []。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/books/settings/dictionary'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:53:32.863107Z"
}

使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

显示属性

添加到 displayedAttributes 列表中的属性会显示在搜索结果中。displayedAttributes 仅影响搜索端点。它对通过 POST 获取文档和通过 GET 获取文档端点没有影响。

默认情况下，displayedAttributes 数组等于数据集中所有字段。此行为由值 ["*"] 表示。

要了解有关显示属性的更多信息，请参阅我们的专用指南。

​

获取显示属性

获取索引的显示属性。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/settings/displayed-attributes'

响应：200 Ok

[
  "title",
  "overview",
  "genres",
  "release_date.year"
]

​

更新显示属性

更新索引的显示属性。

​

路径参数

​

请求体

[<String>, <String>, …]

字符串数组。每个字符串都应是所选索引中存在的属性。

如果属性包含对象，您可以使用点表示法指定其一个或多个键，例如 "displayedAttributes": ["release_date.year"]。

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/movies/settings/displayed-attributes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "title",
    "overview",
    "genres",
    "release_date"
  ]'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

重置显示属性

将索引的显示属性重置为默认值。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/movies/settings/displayed-attributes'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

唯一属性

唯一属性是指在返回文档中其值始终唯一的字段。

要了解有关唯一属性的更多信息，请参阅我们的专用指南。

​

获取唯一属性

获取索引的唯一属性。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/shoes/settings/distinct-attribute'

响应：200 Ok

"skuid"

​

更新唯一属性

更新索引的唯一属性字段。

​

路径参数

​

请求体

<String>

字符串。该字符串应是所选索引中存在的属性。

如果属性包含对象，您可以使用点表示法将其一个或多个键设置为此设置的值，例如 "distinctAttribute": "product.skuid"。

要了解有关唯一属性的更多信息，请参阅我们的专用指南。

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/shoes/settings/distinct-attribute' \
  -H 'Content-Type: application/json' \
  --data-binary '"skuid"'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

重置唯一属性

将索引的唯一属性重置为其默认值。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/shoes/settings/distinct-attribute'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

分面

使用 Meilisearch，您可以创建分面搜索界面。此设置允许您

• 定义 facets 搜索参数返回的最大值数量
• 按值计数或字母数字顺序排序分面值

要了解有关分面的更多信息，请参阅我们的专用指南。

​

分面对象

​

获取分面设置

获取索引的分面设置。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/books/settings/faceting'

响应：200 OK

{
  "maxValuesPerFacet": 100,
  "sortFacetValuesBy": {
    "*": "alpha"
  }
}

​

更新分面设置

部分更新索引的分面设置。请求体中未提供的任何参数将保持不变。

​

路径参数

​

请求体

{
  "maxValuesPerFacet": <Integer>,
  "sortFacetValuesBy": {
      <String>: "count",
      <String>: "alpha"
  }
}

假设查询的搜索结果中包含 colors 分面的三个值：blue、green 和 red。如果您将 maxValuesPerFacet 设置为 2，Meilisearch 将在响应体的 facetDistribution 对象中仅返回 blue 和 green。

​

示例

以下代码示例将 maxValuesPerFacet 设置为 2，按降序计数对 genres 分面进行排序，并按升序字母数字顺序对所有其他分面进行排序

curl \
  -X PATCH 'MEILISEARCH_URL/indexes/books/settings/faceting' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "maxValuesPerFacet": 2,
    "sortFacetValuesBy": {
      "*": "alpha",
      "genres": "count"
    }
  }'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:56:44.991039Z"
}

您可以使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

重置分面设置

将索引的分面设置重置为其默认值。将 sortFacetValuesBy 设置为 null (--data-binary '{ "sortFacetValuesBy": null }')，会将其恢复为默认值 ("*": "alpha")。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/books/settings/faceting'

响应：200 OK

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:53:32.863107Z"
}

您可以使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

可过滤属性

filterableAttributes 列表中的属性可用作过滤器或分面。

​

可过滤属性对象

filterableAttributes 可以是字符串数组或可过滤属性对象数组。

可过滤属性对象必须包含以下字段

​

attributePatterns

属性模式可以以 * 通配符开头或结尾，以匹配多个字段：customer_*, attribute*。

​

features

features 允许您决定为指定属性启用哪些过滤器功能。它接受以下字段：

• facetSearch：是否为指定属性启用分面搜索。布尔值，默认为 false
• filter：列出指定属性的过滤器类型。必须是对象并接受以下字段：
  • equality：启用 =, !=, IN, EXISTS, IS NULL, IS EMPTY, NOT, AND 和 OR。布尔值，默认为 true
  • comparison：启用 >, >=, <, <=, TO, EXISTS, IS NULL, IS EMPTY, NOT, AND 和 OR。布尔值，默认为 false

计算 comparison 过滤器是资源密集型操作。禁用它们可能会提高搜索和索引性能。equality 过滤器使用较少资源，对性能影响有限。

​

获取可过滤属性

获取索引的可过滤属性。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/settings/filterable-attributes'

响应：200 Ok

[
  "genres",
  "director",
  "release_date.year"
]

​

更新可过滤属性

更新索引的可过滤属性列表。

​

路径参数

​

请求体

[<String>, <String>, …]

字符串数组，包含可在查询时用作过滤器的属性。当使用字符串数组格式时，为指定属性启用所有过滤器类型。

您也可以使用对象数组

[
  {
    "attributePatterns": [<String>, <String>, …],
    "features": {
      "facetSearch": <Boolean>,
      "filter": {
        "equality": <Boolean>,
        "comparison": <Boolean>
      }
    }
  }
]

如果指定字段不存在，Meilisearch 将静默忽略它。

如果属性包含对象，您可以使用点表示法将其一个或多个键设置为此设置的值："filterableAttributes": ["release_date.year"] 或 "attributePatterns": ["release_date.year"]。

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/movies/settings/filterable-attributes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "genres",
    "director",
    {
      "attributePatterns": ["*_ratings"],
      "features": {
        "facetSearch": false,
        "filters": {
          "equality": true,
          "comparison": false
        }
      }
    }
  ]'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

重置可过滤属性

将索引的可过滤属性列表重置回其默认值。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/movies/settings/filterable-attributes'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

本地化属性

默认情况下，Meilisearch 会自动检测文档中使用的语言。此设置允许您显式定义数据集中存在哪些语言以及在哪些字段中。

本地化属性影响 searchableAttributes、filterableAttributes 和 sortableAttributes。

为一个索引配置多种语言可能会对性能产生负面影响。

​

本地化属性对象

localizedAttributes 必须是区域设置对象的数组。其默认值为 []。

区域设置对象必须包含以下字段

​

locales

Meilisearch 支持以下ISO-639-3 三字母 locales：epo、eng、rus、cmn、spa、por、ita、ben、fra、deu、ukr、kat、ara、hin、jpn、heb、yid、pol、amh、jav、kor、nob、dan、swe、fin、tur、nld、hun、ces、ell、bul、bel、mar、kan、ron、slv、hrv、srp、mkd、lit、lav、est、tam、vie、urd、tha、guj、uzb、pan、aze、ind、tel、pes、mal、ori、mya、nep、sin、khm、tuk、aka、zul、sna、afr、lat、slk、cat、tgl、hye。

您也可以使用受支持 locales 的 ISO-639-1 双字母等效项。

您也可以将空数组分配给 locales。在这种情况下，Meilisearch 将自动检测相关 attributePatterns 的语言。

​

attributePatterns

属性模式可以以 * 通配符开头或结尾，以匹配多个字段：en_*, *-ar。

您也可以将 attributePatterns 设置为 *，在这种情况下，Meilisearch 会将所有字段视为属于相关区域设置。

​

获取本地化属性设置

获取索引的本地化属性设置。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/localized-attributes'

响应：200 OK

[
  {"locales": ["jpn"], "attributePatterns": ["*_ja"]}
]

​

更新本地化属性设置

更新索引的本地化属性设置。

​

路径参数

​

请求体

[
  {
   "locales": [<String>, …],
   "attributePatterns": [<String>, …],
  }
]

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/localized-attributes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    {"locales": ["jpn"], "attributePatterns": ["*_ja"]}
  ]'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "INDEX_NAME",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:56:44.991039Z"
}

您可以使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

重置本地化属性设置

将索引的本地化属性重置为其默认值。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/localized-attributes'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "INDEX_NAME",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:53:32.863107Z"
}

您可以使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

分页

为保护您的数据库免受恶意抓取，Meilisearch 默认限制每次搜索返回 1000 个结果。此设置允许您配置每次搜索返回的最大结果数量。

maxTotalHits 优先于 limit、offset、hitsPerPage 和 page 等搜索参数。

例如，如果您将 maxTotalHits 设置为 100，则无论为 offset 配置的值是多少，您都无法访问超过 100 个的搜索结果。

要了解有关使用 Meilisearch 分页搜索结果的更多信息，请参阅我们的专用指南。

​

分页对象

​

获取分页设置

获取索引的分页设置。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/books/settings/pagination'

响应：200 OK

{
  "maxTotalHits": 1000
}

​

更新分页设置

部分更新索引的分页设置。

​

路径参数

​

请求体

{maxTotalHits: <Integer>}

​

示例

curl \
  -X PATCH 'MEILISEARCH_URL/indexes/books/settings/pagination' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "maxTotalHits": 100
  }'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:56:44.991039Z"
}

您可以使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

重置分页设置

将索引的分页设置重置为其默认值。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/books/settings/pagination'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2022-04-14T20:53:32.863107Z"
}

您可以使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

临近度精度

计算词语之间的距离是资源密集型操作。降低此操作的精度可能会显著提高性能，并且在大多数用例中对结果相关性影响很小。Meilisearch 在根据临近度对结果进行排名以及用户执行短语搜索时使用词语距离。

proximityPrecision 接受以下字符串值之一：

• "byWord"：计算查询词之间的精确距离。精度更高，但可能导致索引时间更长。这是默认设置
• "byAttribute"：确定同一属性中是否存在多个查询词。精度较低，但索引时间较短

​

获取临近度精度设置

获取索引的临近度精度设置。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/books/settings/proximity-precision'

响应：200 OK

"byWord"

​

更新临近度精度设置

更新索引的分页设置。

​

路径参数

​

请求体

"byWord"|"byAttribute"

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/books/settings/proximity-precision' \
  -H 'Content-Type: application/json' \
  --data-binary '"byAttribute"'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2023-04-14T15:50:29.821044Z"
}

您可以使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

重置临近度精度设置

将索引的临近度精度设置重置为其默认值。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/books/settings/proximity-precision'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "books",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2023-04-14T15:51:47.821044Z"
}

您可以使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

分面搜索

处理分面搜索的可过滤属性是资源密集型操作。此功能默认启用，但禁用它可能会加快索引速度。

facetSearch 接受单个布尔值。如果设置为 false，它将禁用整个索引的分面搜索。如果您在分面搜索被禁用时尝试访问 /facet-search 端点，Meilisearch 将返回错误。

​

获取分面搜索设置

获取索引的分面搜索设置。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/INDEX_UID/settings/facet-search'

响应：200 OK

true

​

更新分面搜索设置

更新索引的分面搜索设置。

​

路径参数

​

请求体

<Boolean>

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/INDEX_UID/settings/facet-search' \
  -H 'Content-Type: application/json' \
  --data-binary 'false'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "INDEX_UID",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2024-07-19T22:33:18.523881Z"
}

使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

重置分面搜索设置

将索引的分面搜索重置为其默认设置。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/INDEX_UID/settings/facet-search'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "INDEX_UID",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2024-07-19T22:35:33.723983Z"
}

使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

前缀搜索

前缀搜索是 Meilisearch 匹配以特定查询词开头而不是仅精确匹配的文档的过程。这是一种资源密集型操作，默认在索引期间发生。

使用 prefixSearch 更改前缀搜索的工作方式。它接受以下字符串之一：

• "indexingTime"：在索引期间计算前缀搜索。这是默认行为
• "disabled"：不计算前缀搜索。可能加快索引速度，但会严重影响搜索结果相关性

​

获取前缀搜索设置

获取索引的前缀搜索设置。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/INDEX_UID/settings/prefix-search'

响应：200 OK

"indexingTime"

​

更新前缀搜索设置

更新索引的前缀搜索设置。

​

路径参数

​

请求体

"indexingTime" | "disabled"

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/INDEX_UID/settings/prefix-search' \
  -H 'Content-Type: application/json' \
  --data-binary '"disabled"'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "INDEX_UID",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2024-07-19T22:33:18.523881Z"
}

使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

重置前缀搜索设置

将索引的前缀搜索重置为其默认设置。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/INDEX_UID/settings/facet-search'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "INDEX_UID",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2024-07-19T22:35:33.723983Z"
}

使用返回的 taskUid 获取有关任务状态的更多详细信息。

​

排名规则

排名规则是内置规则，根据特定条件对搜索结果进行排名。它们按照在 rankingRules 数组中出现的相同顺序应用。

要了解有关排名规则的更多信息，请参阅我们的专用指南。

​

排名规则数组

​

默认顺序

[
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness"
]

​

获取排名规则

获取索引的排名规则。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/settings/ranking-rules'

响应：200 Ok

[
  "words",
  "typo",
  "proximity",
  "attribute",
  "sort",
  "exactness",
  "release_date:desc"
]

​

更新排名规则

更新索引的排名规则。

​

路径参数

​

请求体

[<String>, <String>, …]

一个包含按重要性排序的排名规则的数组。

要创建自定义排名规则，请提供一个属性，后跟冒号 (:) 和 asc 表示升序或 desc 表示降序。

• 要应用升序排序（结果按值递增排序）：attribute_name:asc
• 要应用降序排序（结果按值递减排序）：attribute_name:desc

要了解有关排名规则的更多信息，请参阅我们的专用指南。

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/movies/settings/ranking-rules' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:asc",
    "rank:desc"
  ]'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

重置排名规则

将索引的排名规则重置为其默认值。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/movies/settings/ranking-rules'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

可搜索属性

searchableAttributes 列表中与属性关联的值用于搜索匹配的查询词。列表的顺序还决定了属性排名顺序。

默认情况下，searchableAttributes 数组等于数据集中所有字段。此行为由值 ["*"] 表示。

要了解有关可搜索属性的更多信息，请参阅我们的专用指南。

​

获取可搜索属性

获取索引的可搜索属性。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/settings/searchable-attributes'

响应：200 Ok

[
  "title",
  "overview",
  "genres",
  "release_date.year"
]

​

更新可搜索属性

更新索引的可搜索属性。

​

路径参数

​

请求体

[<String>, <String>, …]

字符串数组。每个字符串都应是所选索引中存在的属性。该数组应按照重要性顺序给出：从最重要的属性到最不重要的属性。

如果属性包含对象，您可以使用点表示法将其一个或多个键设置为此设置的值："searchableAttributes": ["release_date.year"]。

要了解有关可搜索属性的更多信息，请参阅我们的专用指南。

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/movies/settings/searchable-attributes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "title",
    "overview",
    "genres"
  ]'

在此示例中，title 字段匹配的文档将比 overview 字段匹配的文档更相关。

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

重置可搜索属性

将索引的可搜索属性重置为默认值。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/movies/settings/searchable-attributes'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

您可以使用此 taskUid 获取有关任务状态的更多详细信息。

​

搜索截止时间

配置搜索查询的最大持续时间。Meilisearch 将中断任何超过截止时间的搜索。

默认情况下，Meilisearch 在 1500 毫秒后中断搜索。

​

获取搜索截止时间

获取索引的搜索截止时间值。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/movies/settings/search-cutoff-ms'

响应：200 Ok

null

​

更新搜索截止时间

更新索引的搜索截止时间值。

​

路径参数

​

请求体

150

一个整数，表示以毫秒为单位的截止时间值。

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/movies/settings/search-cutoff-ms' \
  -H 'Content-Type: application/json' \
  --data-binary '150'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2023-03-21T06:33:41.000000Z"
}

使用此 taskUid 获取有关任务状态的更多详细信息。

​

重置搜索截止时间

将索引的搜索截止时间值重置为其默认值 null。这相当于 1500ms 的截止时间。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/movies/settings/search-cutoff-ms'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2023-03-21T07:05:16.000000Z"
}

​

分隔符标记

将字符串配置为自定义分隔符标记，指示单词的结束和开始位置。

separatorTokens 列表中的标记是在 Meilisearch 默认分隔符列表的基础上添加的。要从默认列表中删除分隔符，请使用nonSeparatorTokens 设置。

​

获取分隔符标记

获取索引的自定义分隔符标记列表。

​

路径参数

​

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/articles/settings/separator-tokens'

响应：200 Ok

[]

​

更新分隔符标记

更新索引的自定义分隔符标记列表。

​

路径参数

​

请求体

["|", "…"]

字符串数组，每个字符串表示一个单词分隔符。

​

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/articles/settings/separator-tokens' \
  -H 'Content-Type: application/json'  \
  --data-binary '["|", "…"]'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}

使用此 taskUid 获取有关任务状态的更多详细信息。

​

重置分隔符标记

将索引的自定义分隔符标记列表重置为其默认值 []。

​

路径参数

​

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/articles/settings/separator-tokens'

响应：202 Accepted

{
  "taskUid": 1,
  "indexUid": "movies",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2021-08-11T09:25:53.000000Z"
}