设置

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

有关索引设置的概念概述，请参阅索引说明。要了解有关索引配置基础知识的更多信息，请参阅索引配置教程。

设置界面

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

设置对象

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

json

{
  "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": {}
}

名称	类型	默认值	描述
`字典`	字符串数组	空	Meilisearch 应解析为单个术语的字符串列表
`displayedAttributes`	字符串数组	所有属性：`["*"]`	返回文档中显示的字段
`distinctAttribute`	字符串	`null`	搜索返回给定字段的唯一（不同）值的文档
`faceting`	对象	默认对象	Facet 设置
`filterableAttributes`	字符串或对象数组	空	用作过滤器和 facet 的属性
`pagination`	对象	默认对象	分页设置
`proximityPrecision`	字符串	`"byWord"`	计算邻近度排名规则时的精度级别
`facetSearch`	布尔值	`true`	启用或禁用 facet 搜索功能
`prefixSearch`	字符串	`"indexingTime"`	Meilisearch 何时应仅返回与查询开头匹配的结果
`rankingRules`	字符串数组	`["words",` `"typo",` `"proximity",` `"attribute",` `"sort",` `"exactness"]`	按重要性顺序列出的排名规则列表
`searchableAttributes`	字符串数组	所有属性：`["*"]`	在其中搜索匹配查询词的字段，按重要性顺序排序
`searchCutoffMs`	整数	`null`，或 1500 毫秒	搜索查询的最大持续时间
`separatorTokens`	字符串数组	空	分隔术语开始和结束位置的字符列表
`nonSeparatorTokens`	字符串数组	空	不分隔术语开始和结束位置的字符列表
`sortableAttributes`	字符串数组	空	排序搜索结果时要使用的属性
`stopWords`	字符串数组	空	Meilisearch 在搜索查询中出现时忽略的词语列表
`synonyms`	对象	空	被视为相似的关联词列表
`typoTolerance`	对象	默认对象	拼写容错设置
`embedders`	对象对象	默认对象	执行基于含义的搜索查询所需的 Embedder

名称	类型	默认值	描述
`maxValuesPerFacet`	整数	`100`	每个 facet 返回的最大 facet 值数量。值按升序词典顺序排序
`sortFacetValuesBy`	对象	所有 facet 值均按升序字母数字顺序排序 (`"*": "alpha"`)	自定义 facet 顺序以按降序值计数 (`count`) 或升序字母数字顺序 (`alpha`) 排序

名称	类型	默认值	描述
`maxValuesPerFacet`	整数	`100`	每个 facet 返回的最大 facet 值数量。值按升序词典顺序排序
`sortFacetValuesBy`	对象	所有 facet 值均按升序字母数字顺序排序 (`"*": "alpha"`)	自定义分面顺序，按降序值计数 (`count`) 或升序字母数字顺序 (`alpha`) 排序

名称	类型	默认值	描述
`attributePatterns`	字符串数组	`[]`	指示可过滤字段的字符串列表
`features`	对象	`{"facetSearch": false, "filters": {"equality": true, "comparison": false}`	概述为指定属性启用的过滤器类型的列表

本地化属性

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

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

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

`locales` 和 `localizedAttributes`

locales 和 localizedAttributes 具有相同的目标：当 Meilisearch 的语言自动检测无法按预期工作时，显式声明搜索中使用的语言。

如果您认为 Meilisearch 因为查询文本而检测到不正确的语言，请使用 locales 显式设置搜索语言。

如果您认为 Meilisearch 因为文档而检测到不正确的语言，请使用 localizedAttributes 在索引级别显式设置文档语言。

为了完全控制 Meilisearch 在索引和搜索时检测语言的方式，请同时设置 locales 和 localizedAttributes。

本地化属性对象

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

区域设置对象必须具有以下字段

名称	类型	默认值	描述
`locales`	字符串数组	`[]`	指示一个或多个 ISO-639 区域设置的字符串列表
`attributePatterns`	字符串数组	`[]`	指示哪些字段对应于指定区域设置的字符串列表

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。

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

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

`attributePatterns`

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

您也可以将 attributePatterns 设置为 *，在这种情况下，Meilisearch 将把所有字段都视为使用关联的区域设置。

获取本地化属性设置

GET/indexes/{index_uid}/settings/localized-attributes

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 OK`

json

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

更新本地化属性设置

PUT/indexes/{index_uid}/settings/localized-attributes

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

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

名称	类型	默认值	描述
`localizedAttributes`	对象数组	`[]`	为一个或多个属性显式设置特定区域设置

示例

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

响应：`202 Accepted`

json

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

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

重置本地化属性设置

RESET/indexes/{index_uid}/settings/localized-attributes

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

{
  "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 对搜索结果进行分页的更多信息，请参阅我们的专用指南。

分页对象

名称	类型	默认值	描述
`maxTotalHits`	整数	`1000`	Meilisearch 可以返回的最大搜索结果数

获取分页设置

GET/indexes/{index_uid}/settings/pagination

获取索引的分页设置。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 OK`

json

{
  "maxTotalHits": 1000
}

更新分页设置

PATCH/indexes/{index_uid}/settings/pagination

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

{maxTotalHits: <Integer>}

名称	类型	默认值	描述
`maxTotalHits`	整数	`1000`	Meilisearch 可以返回的最大搜索结果数

警告

将 maxTotalHits 设置为高于默认值的值会对搜索性能产生负面影响。将 maxTotalHits 设置为超过 20000 的值可能会导致查询花费数秒才能完成。

示例

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

响应：`202 Accepted`

json

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

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

重置分页设置

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

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

邻近精度

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

proximityPrecision 接受以下字符串值之一

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

获取邻近精度设置

GET/indexes/{index_uid}/settings/proximity-precision

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 OK`

"byWord"

更新邻近精度设置

PUT/indexes/{index_uid}/settings/proximity-precision

更新索引的分页设置。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

"byWord"|"byAttribute"

示例

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

响应：`202 Accepted`

json

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

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

重置邻近精度设置

DELETE/indexes/{index_uid}/settings/proximity-precision

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

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

分面搜索

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

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

获取分面搜索设置

GET/indexes/{index_uid}/settings/facet-search

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 OK`

json

true

更新分面搜索设置

PUT/indexes/{index_uid}/settings/facet-search

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

<Boolean>

示例

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

响应：`202 Accepted`

json

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

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

重置分面搜索设置

DELETE/indexes/{index_uid}/settings/facet-search

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

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

前缀搜索

前缀搜索是 Meilisearch 匹配以特定查询词开头的文档的过程，而不是仅进行完全匹配。默认情况下，这是一个在索引期间发生的资源密集型操作。

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

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

获取前缀搜索设置

GET/indexes/{index_uid}/settings/prefix-search

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 OK`

json

"indexingTime"

更新前缀搜索设置

PUT/indexes/{index_uid}/settings/prefix-search

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

"indexingTime" | "disabled"

示例

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

响应：`202 Accepted`

json

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

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

重置前缀搜索设置

DELETE/indexes/{index_uid}/settings/prefix-search

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

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

排名规则

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

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

排名规则数组

名称	描述
`"words"`	按匹配查询词的数量降序对结果进行排序
`"typo"`	按错别字数量升序对结果进行排序
`"proximity"`	按匹配查询词之间距离的升序对结果进行排序
`"attribute"`	基于属性排名顺序对结果进行排序
`"sort"`	基于查询时确定的参数对结果进行排序
`"exactness"`	基于匹配词与查询词的相似性对结果进行排序

默认顺序

json

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

获取排名规则

GET/indexes/{index_uid}/settings/ranking-rules

获取索引的排名规则。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 Ok`

json

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

更新排名规则

PUT/indexes/{index_uid}/settings/ranking-rules

更新索引的排名规则。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

[<String>, <String>, …]

一个数组，其中包含按重要性顺序排列的排名规则。

要创建自定义排名规则，请给出属性，后跟冒号 (:) 以及 asc（升序）或 desc（降序）。

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

警告

如果某些文档不包含自定义排名规则中定义的属性，则排名规则的应用是未定义的，并且搜索结果可能不会按您预期的方式排序。

确保自定义排名规则中使用的任何属性都存在于您的所有文档中。例如，如果您设置自定义排名规则 desc(year)，请确保您的所有文档都包含属性 year。

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

示例

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`

json

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

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

重置排名规则

DELETE/indexes/{index_uid}/settings/ranking-rules

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

提示

重置排名规则与删除排名规则不同。要删除排名规则，请使用更新排名规则端点。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

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

可搜索属性

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

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

警告

更新可搜索属性将重新索引索引中的所有文档，这可能需要一些时间。我们建议先更新您的索引设置，然后再添加文档，因为这可以减少 RAM 消耗。

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

获取可搜索属性

GET/indexes/{index_uid}/settings/searchable-attributes

获取索引的可搜索属性。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 Ok`

json

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

更新可搜索属性

PUT/indexes/{index_uid}/settings/searchable-attributes

更新索引的可搜索属性。

警告

由于实现错误，手动更新 searchableAttributes 将更改 JSON 响应中文档字段的显示顺序。此行为不一致，将在未来的版本中修复。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

[<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`

json

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

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

重置可搜索属性

DELETE/indexes/{index_uid}/settings/searchable-attributes

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

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

搜索截止时间

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

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

获取搜索截止时间

GET/indexes/{index_uid}/settings/search-cutoff-ms

获取索引的搜索截止值。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 Ok`

json

null

更新搜索截止时间

PUT/indexes/{index_uid}/settings/search-cutoff-ms

更新索引的搜索截止值。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

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

示例

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

响应：`202 Accepted`

json

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

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

重置搜索截止时间

DELETE/indexes/{index_uid}/settings/search-cutoff-ms

将索引的搜索截止值重置为其默认值 null。这表示截止时间为 1500 毫秒。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

分隔符标记

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

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

获取分隔符标记

GET/indexes/{index_uid}/settings/separator-tokens

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 Ok`

json

[]

更新分隔符标记

PUT/indexes/{index_uid}/settings/separator-tokens

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

["|", "&hellip;"]

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

示例

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

响应：`202 Accepted`

json

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

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

重置分隔符标记

DELETE/indexes/{index_uid}/settings/separator-tokens

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

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

非分隔符标记

从 Meilisearch 的默认单词分隔符列表中删除标记。

获取非分隔符标记

GET/indexes/{index_uid}/settings/non-separator-tokens

获取索引的非分隔符标记列表。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 Ok`

json

[]

更新非分隔符标记

PUT/indexes/{index_uid}/settings/non-separator-tokens

更新索引的非分隔符标记列表。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

["@", "#"]

一个字符串数组，每个字符串指示单词分隔符列表中存在的标记。

示例

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

响应：`202 Accepted`

json

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

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

重置非分隔符标记

DELETE/indexes/{index_uid}/settings/non-separator-tokens

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

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

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

可排序属性

使用 sort 搜索参数对搜索结果进行排序时可以使用的属性。

警告

更新可排序属性将重新索引索引中的所有文档，这可能需要一些时间。我们建议先更新您的索引设置，然后再添加文档，因为这可以减少 RAM 消耗。

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

获取可排序属性

GET/indexes/{index_uid}/settings/sortable-attributes

获取索引的可排序属性。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/books/settings/sortable-attributes'

响应：`200 Ok`

json

[
  "price",
  "author.surname"
]

更新可排序属性

PUT/indexes/{index_uid}/settings/sortable-attributes

更新索引的可排序属性列表。

您可以在我们的专用指南中阅读有关在查询时排序的更多信息。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

[<String>, <String>, …]

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

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

警告

如果字段不存在，则不会抛出错误。

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

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/books/settings/sortable-attributes' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "price",
    "author"
  ]'

响应：`202 Accepted`

json

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

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

重置可排序属性

DELETE/indexes/{index_uid}/settings/sortable-attributes

将索引的可排序属性列表重置为其默认值。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/books/settings/sortable-attributes'

响应：`202 Accepted`

json

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

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

停用词

添加到 stopWords 列表的词将在未来的搜索查询中被忽略。

警告

更新停用词将重新索引索引中的所有文档，这可能需要一些时间。我们建议先更新您的索引设置，然后再添加文档，因为这可以减少 RAM 消耗。

提示

停用词与数据集中使用的语言密切相关。例如，大多数包含英语文档的数据集将包含无数个 the 和 of。相反，意大利语数据集将受益于忽略诸如 a、la 或 il 之类的词。

此网站由一位法国开发者维护提供了不同语言的停用词列表。请注意，根据您的数据集和用例，您需要调整这些列表以获得最佳结果。

获取停用词

GET/indexes/{index_uid}/settings/stop-words

获取索引的停用词列表。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 Ok`

json

[
  "of",
  "the",
  "to"
]

更新停用词

PUT/indexes/{index_uid}/settings/stop-words

更新索引的停用词列表。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

[<String>, <String>, …]

字符串数组。每个字符串应为单个词。

如果停用词列表已存在，它将被覆盖（替换）。

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/movies/settings/stop-words' \
  -H 'Content-Type: application/json' \
  --data-binary '[
    "the",
    "of",
    "to"
  ]'

响应：`202 Accepted`

json

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

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

重置停用词

DELETE/indexes/{index_uid}/settings/stop-words

将索引的停用词列表重置为其默认值。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

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

同义词

synonyms 对象包含词及其各自的同义词。在 Meilisearch 中，为了计算搜索结果，同义词被认为与其关联的词相等。

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

获取同义词

GET/indexes/{index_uid}/settings/synonyms

获取索引的同义词列表。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`200 OK`

json

{
  "wolverine": [
    "xmen",
    "logan"
  ],
  "logan": [
    "wolverine",
    "xmen"
  ],
  "wow": [
    "world of warcraft"
  ]
}

更新同义词

PUT/indexes/{index_uid}/settings/synonyms

更新索引的同义词列表。同义词已标准化。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

{
  <String>: [<String>, <String>, …],
  …
}

一个包含所有同义词及其关联词的对象。在数组中添加关联词以设置词的同义词。

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

示例

curl \
  -X PUT 'MEILISEARCH_URL/indexes/movies/settings/synonyms' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "wolverine": [
      "xmen",
      "logan"
    ],
    "logan": [
      "wolverine",
      "xmen"
    ],
    "wow": ["world of warcraft"]
  }'

响应：`202 Accepted`

json

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

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

重置同义词

DELETE/indexes/{index_uid}/settings/synonyms

将索引的同义词列表重置为其默认值。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

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

响应：`202 Accepted`

json

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

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

拼写容错

拼写容错功能帮助用户即使在其搜索查询包含拼写错误或错别字时也能找到相关的结果。此设置允许您配置拼写错误的最小词大小，并为特定词或属性禁用拼写容错。

要了解有关拼写容错的更多信息，请参阅我们的专用指南。

拼写容错对象

名称	类型	默认值	描述
`已启用`	布尔值	`true`	是否启用拼写容错
`minWordSizeForTypos.oneTypo`	整数	`5`	接受 1 个错别字的最小词大小；必须介于 `0` 和 `twoTypos` 之间
`minWordSizeForTypos.twoTypos`	整数	`9`	接受 2 个错别字的最小词大小；必须介于 `oneTypo` 和 `255` 之间
`disableOnWords`	字符串数组	空	禁用拼写容错功能的词数组
`disableOnAttributes`	字符串数组	空	禁用拼写容错功能的属性数组

获取拼写容错设置

GET/indexes/{index_uid}/settings/typo-tolerance

获取索引的拼写容错设置。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/books/settings/typo-tolerance'

响应：`200 OK`

json

{
  "enabled": true,
  "minWordSizeForTypos": {
    "oneTypo": 5,
    "twoTypos": 9
  },
  "disableOnWords": [],
  "disableOnAttributes": []
}

更新拼写容错设置

PATCH/indexes/{index_uid}/settings/typo-tolerance

部分更新索引的拼写容错设置。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

{
  "enabled": <Boolean>,
  "minWordSizeForTypos": {
    "oneTypo": <Integer>,
    "twoTypos": <Integer>
  },
  "disableOnWords": [<String>, <String>, …],
  "disableOnAttributes": [<String>, <String>, …]
}

名称	类型	默认值	描述
`已启用`	布尔值	`true`	是否启用拼写容错
`minWordSizeForTypos.oneTypo`	整数	`5`	接受 1 个错别字的最小词大小；必须介于 `0` 和 `twoTypos` 之间
`minWordSizeForTypos.twoTypos`	整数	`9`	接受 2 个错别字的最小词大小；必须介于 `oneTypo` 和 `255` 之间
`disableOnWords`	字符串数组	空	禁用拼写容错功能的词数组
`disableOnAttributes`	字符串数组	空	禁用拼写容错功能的属性数组

示例

curl \
  -X PATCH 'MEILISEARCH_URL/indexes/books/settings/typo-tolerance' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "minWordSizeForTypos": {
      "oneTypo": 4,
      "twoTypos": 10
    },
    "disableOnAttributes": ["title"]
  }'

响应：`202 Accepted`

json

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

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

重置拼写容错设置

DELETE/indexes/{index_uid}/settings/typo-tolerance

将索引的拼写容错设置重置为其默认值。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/books/settings/typo-tolerance'

响应：`202 Accepted`

json

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

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

嵌入器

嵌入器将文档和查询转换为向量嵌入。您必须配置至少一个嵌入器才能使用 AI 驱动的搜索。

嵌入器对象

嵌入器对象最多可以包含 256 个嵌入器对象。每个嵌入器对象都必须分配一个唯一的名称

json

{
  "default": {
    "source": "huggingFace",
    "model": "BAAI/bge-base-en-v1.5",
    "documentTemplate": "A movie titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}"
  },
  "openai": {
    "source": "openAi",
    "apiKey": "OPENAI_API_KEY",
    "model": "text-embedding-3-small",
    "documentTemplate": "A movie titled {{doc.title}} whose description starts with {{doc.overview|truncatewords: 20}}",
  }
}

这些嵌入器对象可能包含以下字段

名称	类型	默认值	描述
`source`	字符串	空	将从文档生成嵌入的第三方工具。必须是 `openAi`、`huggingFace`、`ollama`、`rest` 或 `userProvided`
`url`	字符串	`http://localhost:11434/api/embeddings`	Meilisearch 查询嵌入器时联系的 URL
`apiKey`	字符串	空	Meilisearch 应随每个请求发送给嵌入器的身份验证令牌。如果不存在，Meilisearch 将尝试从环境变量中读取它
`model`	字符串	空	您的嵌入器在生成向量时使用的模型
`documentTemplate`	字符串	`{% for field in fields %} {% if field.is_searchable and not field.value == nil %}{{ field.name }}: {{ field.value }} {% endif %} {% endfor %}`	定义 Meilisearch 发送到嵌入器的数据的模板
`documentTemplateMaxBytes`	整数	`400`	渲染文档模板的最大允许大小
`dimensions`	整数	空	所选模型中的维度数。如果未提供，Meilisearch 会尝试推断此值
`revision`	字符串	空	模型修订哈希
`distribution`	对象	空	描述搜索结果的自然分布。必须包含两个字段，`mean` 和 `sigma`，每个字段都包含介于 `0` 和 `1` 之间的数值
`request`	对象	空	表示 Meilisearch 向远程嵌入器发出的请求的 JSON 值
`response`	对象	空	表示 Meilisearch 期望从远程嵌入器收到的响应的 JSON 值
`binaryQuantized`	布尔值	空	一旦设置为 `true`，将不可逆地将所有向量维度转换为 1 位值
`indexingEmbedder`	对象	空	配置嵌入器以在索引编制期间向量化文档
`searchEmbedder`	对象	空	配置嵌入器以向量化搜索查询
`pooling`	字符串	`"useModel"`	Hugging Face 嵌入器的池化方法

获取嵌入器设置

GET/indexes/{index_uid}/settings/embedders

获取为索引配置的嵌入器。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

curl \
  -X GET 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/embedders'

响应：`200 OK`

json

{
  "default": {
    "source":  "openAi",
    "apiKey": "OPENAI_API_KEY",
    "model": "text-embedding-3-small",
    "documentTemplate": "A movie titled {{doc.title}} whose description starts with {{doc.overview|truncatewords: 20}}",
    "dimensions": 1536
  }
}

更新嵌入器设置

PATCH/indexes/{index_uid}/settings/embedders

部分更新索引的嵌入器设置。更新此设置后，Meilisearch 可能会重新索引所有文档并重新生成其嵌入。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

正文

json

{
  "default": {
    "source": <String>,
    "url": <String>,
    "apiKey": <String>,
    "model": <String>,
    "documentTemplate": <String>,
    "documentTemplateMaxBytes": <Integer>,
    "dimensions": <Integer>,
    "revision": <String>,
    "distribution": {
      "mean": <Float>,
      "sigma": <Float>
    },
    "request": { … },
    "response": { … },
    "headers": { … },
    "binaryQuantized": <Boolean>,
    "pooling": <String>,
    "indexingEmbedder": { … },
    "searchEmbedder": { … }
  }
}

将嵌入器设置为 null 以将其从嵌入器列表中删除。

`source`

使用 source 配置嵌入器的来源。来源对应于从您的文档生成嵌入的服务。

Meilisearch 支持以下来源

openAi
huggingFace
ollama
rest
userProvided
composite 实验性

rest 是一种通用来源，与任何提供 REST API 的嵌入提供商兼容。

当您想手动生成嵌入时，请使用 userProvided。在这种情况下，您必须在文档的 _vectors 字段中包含向量数据。您还必须为搜索查询生成向量。

此字段为必填项。

复合嵌入器实验性

选择 composite 以在索引编制期间使用一个嵌入器，在搜索期间使用另一个嵌入器。必须与indexingEmbedder 和 searchEmbedder 一起使用。

激活复合嵌入器

这是一个实验性功能。使用实验性功能端点来激活它

curl \
  -X PATCH 'MEILISEARCH_URL/experimental-features/' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "compositeEmbedders": true
  }'

`url`

Meilisearch 查询 url 以生成查询和文档的向量嵌入。url 必须指向 REST 兼容的嵌入器。您也可以使用 url 来处理代理，例如从代理后面定位 openAi 时。

使用 rest 嵌入器时，此字段为必填项。

当使用 ollama 和 openAi 嵌入器时，此字段是可选的。ollama URL 必须以 /api/embed 或 /api/embeddings 结尾。

此字段与 huggingFace 和 userProvided 嵌入器不兼容。

`apiKey`

Meilisearch 应随每个请求发送给嵌入器的身份验证令牌。

如果使用受保护的 rest 嵌入器，则此字段为必填项。

对于 openAI 和 ollama 嵌入器，此字段是可选的。如果您未指定 apiKey，Meilisearch 将尝试从环境变量 OPENAI_API_KEY 和 MEILI_OLLAMA_URL 中读取它。

此字段与 huggingFace 和 userProvided 嵌入器不兼容。

`model`

您的嵌入器在生成向量时使用的模型。这些是 Meilisearch 支持的官方支持模型

openAi: text-embedding-3-small, text-embedding-3-large, openai-text-embedding-ada-002
huggingFace: BAAI/bge-base-en-v1.5

其他模型，例如 HuggingFace 的 BERT 模型或 Ollama 和 REST 嵌入器提供的模型也可能与 Meilisearch 兼容。

对于 Ollama 嵌入器，此字段为必填项。

对于 openAi 和 huggingFace，此字段是可选的。默认情况下，Meilisearch 分别使用 text-embedding-3-small 和 BAAI/bge-base-en-v1.5。

此字段与 rest 和 userProvided 嵌入器不兼容。

`documentTemplate`

documentTemplate 是一个字符串，其中包含 Liquid 模板。Meilisearch 为每个文档插入模板，并将生成的文本发送到嵌入器。然后，嵌入器根据此文本生成文档向量。

您可以使用以下上下文值

{{doc.FIELD}}：doc 代表文档本身。FIELD 必须对应于输入文档中所有文档值中存在的属性，将被该字段的值替换
{{fields}}：索引中任何文档中出现的所有 field 的列表。此列表中的每个 field 对象都具有以下属性
- name：字段的属性
- value：字段的值
- is_searchable：字段是否在可搜索属性列表中

如果文档中不存在 field，则其 value 为 nil。

为了获得最佳结果，请构建仅包含高度相关数据的短模板。如果使用长字段，请考虑截断它。如果您不手动设置，documentTemplate 将包含所有可搜索和非空文档字段。这可能会导致次优的性能和相关性。

此字段与 userProvided 嵌入器不兼容。

对于所有其他嵌入器，此字段是可选的，但强烈建议使用。

`documentTemplateMaxBytes`

渲染文档模板的最大大小。较长的文本将被截断以适应配置的限制。

documentTemplateMaxBytes 必须是整数。它默认为 400。

此字段与 userProvided 嵌入器不兼容。

对于所有其他嵌入器，此字段是可选的。

`dimensions`

所选模型中的维度数。如果未提供，Meilisearch 会尝试推断此值。

在大多数情况下，dimensions 应与您选择的模型的值完全相同。将 dimensions 设置为低于模型的值可能会提高性能，并且仅在以下 OpenAI 模型中受支持

openAi: text-embedding-3-small, text-embedding-3-large

对于 userProvided 嵌入器，此字段为必填项。

对于 openAi、huggingFace、ollama 和 rest 嵌入器，此字段是可选的。

`revision`

使用此字段可使用模型的特定修订版。

对于 huggingFace 嵌入器，此字段是可选的。

此字段与所有其他嵌入器不兼容。

`request`

request 必须是一个 JSON 对象，其结构和数据与您必须发送到 rest 嵌入器的请求相同。

包含 Meilisearch 应发送到嵌入器的输入文本的字段必须替换为 "{{text}}"

json

{
  "source": "rest",
  "request": {
    "prompt": "{{text}}"
    …
  },
  …
}

如果在单个请求中发送多个文档，请将输入字段替换为 ["{{text}}", "{{..}}"]

json

{
  "source": "rest",
  "request": {
    "prompt": ["{{text}}", "{{..}}"]
    …
  },
  …
}

使用 rest 嵌入器时，此字段为必填项。

此字段与所有其他嵌入器不兼容。

`response`

response 必须是一个 JSON 对象，其结构和数据与您期望从 rest 嵌入器收到的响应相同。

包含嵌入本身的字段必须替换为 "{{embedding}}"

json

{
  "source": "rest",
  "response": {
    "data": "{{embedding}}"
    …
  },
  …
}

如果单个响应包含多个嵌入，则包含嵌入本身的字段必须是一个包含两项的数组。一项必须声明单个嵌入的位置和结构，而第二项应为 "{{..}}"

json

{
  "source": "rest",
  "response": {
    "data": [
      {
        "embedding": "{{embedding}}"
      },
      "{{..}}"
    ]
    …
  },
  …
}

使用 rest 嵌入器时，此字段为必填项。

此字段与所有其他嵌入器不兼容。

`distribution`

出于数学原因，语义搜索结果的 _rankingScore 往往紧密地围绕一个平均值分组，该平均值取决于所使用的嵌入器和模型。这可能会导致相关的语义命中与关键字搜索命中相比被低估，而不相关的语义命中被高估。

在配置嵌入器以使用仿射变换校正返回的语义命中的 _rankingScore 时，请使用 distribution

curl \
  -X PATCH 'MEILISEARCH_URL/indexes/INDEX_NAME/settings' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "embedders": {
      "default": {
        "source":  "huggingFace",
        "model": "MODEL_NAME",
        "distribution": {
          "mean": 0.7,
          "sigma": 0.3
        }
      }
    }
  }'

配置 distribution 需要一定量的反复试验，您必须在其中执行语义搜索并监视结果。根据其 rankingScore 和相关性，添加该索引的观察到的 mean 和 sigma 值。

distribution 是一个可选字段，与所有嵌入器来源兼容。它必须是一个包含两个字段的对象

mean：介于 0 和 1 之间的数字，表示在使用 distribution 设置之前“有些相关”命中的语义分数
sigma：介于 0 和 1 之间的数字，表示“非常相关”命中与“有些相关”命中之间，以及“有些相关”命中与“不相关命中”之间的 _rankingScore 的平均绝对差。

更改 distribution 不会触发重新索引操作。

`headers`

headers 必须是一个 JSON 对象，其键表示在发送给嵌入器的请求中要发送的其他标头的名称，其值表示这些其他标头的值。

默认情况下，Meilisearch 会随所有发送给 rest 嵌入器的请求发送以下标头

Authorization: Bearer EMBEDDER_API_KEY（仅当提供了 apiKey 时）
Content-Type: application/json

如果 headers 包含这些字段之一，则显式声明的值优先于默认值。

使用 rest 嵌入器时，此字段是可选的。

此字段与所有其他嵌入器不兼容。

`binaryQuantized`

设置为 true 时，通过使用 1 位值表示每个维度来压缩向量。这会降低语义搜索结果的相关性，但会大大减小数据库大小。

当处理大型 Meilisearch 项目时，此选项可能很有用。如果您的项目包含超过一百万个文档并使用超过 1400 个维度的模型，请考虑激活它。

二进制量化是一个不可逆的过程

激活 binaryQuantized 是不可逆的。 启用后，Meilisearch 会转换所有向量并丢弃所有不适合 1 位的向量数据。恢复向量原始值的唯一方法是在新的嵌入器中重新向量化整个索引。

`pooling`

配置 Meilisearch 应如何将各个标记合并为单个嵌入。

pooling 必须是以下字符串之一

"useModel"：Meilisearch 将从模型配置中获取池化方法。新嵌入器的默认值
"forceMean"：始终使用平均池化。在 Meilisearch <=v1.13 中创建的嵌入器的默认值
"forceCls"：始终使用 CLS 池化

如有疑问，请使用 "useModel"。"forceMean" 和 "forceCls" 是兼容性选项，对于某些嵌入器和模型可能是必需的。

对于具有 huggingFace 来源的嵌入器，pooling 是可选的。

pooling 对于所有其他嵌入器来源均无效。

`indexingEmbedder` 和 `searchEmbedder` 实验性

当使用复合嵌入器时，配置 Meilisearch 在向量化文档和搜索查询时应使用的单独嵌入器。

indexingEmbedder 通常受益于远程提供商的更高带宽和速度，因此它可以快速向量化大批文档。searchEmbedder 通常可能受益于本地处理查询的较低延迟。

这两个字段都必须是对象，并且接受与常规嵌入器相同的字段，但以下异常情况除外

indexingEmbedder 和 searchEmbedder 必须使用相同的模型来生成嵌入
indexingEmbedder 和 searchEmbedder 必须具有相同的 dimension 和 pooling 方法
source 对于 indexingEmbedder 和 searchEmbedder 都是必填项
子嵌入器都不能将 source 设置为 composite 或 userProvided
binaryQuantized 和 distribution 都不是有效的子嵌入器字段，并且必须始终在主嵌入器中声明
documentTemplate 和 documentTemplateMaxBytes 对于 searchEmbedder 是无效字段
documentTemplate 和 documentTemplateMaxBytes 对于 indexingEmbedder 是必填字段（如果适用于其来源）

当使用 composite 来源时，indexingEmbedder 和 searchEmbedder 是必填项。

indexingEmbedder 和 searchEmbedder 与所有其他嵌入器来源不兼容。

示例

curl \
  -X PATCH 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/embedders' \
  -H 'Content-Type: application/json' \
  --data-binary '{
    "default": {
      "source":  "openAi",
      "apiKey": "OPEN_AI_API_KEY",
      "model": "text-embedding-3-small",
      "documentTemplate": "A document titled '{{doc.title}}' whose description starts with {{doc.overview|truncatewords: 20}}"
    }
  }'

响应：`202 Accepted`

json

{
  "taskUid": 1,
  "indexUid": "kitchenware",
  "status": "enqueued",
  "type": "settingsUpdate",
  "enqueuedAt": "2024-05-11T09:33:12.691402Z"
}

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

重置嵌入器设置

DELETE/indexes/{index_uid}/settings/embedders

从您的索引中删除所有嵌入器。

要删除单个嵌入器，请使用更新嵌入器设置端点并将目标嵌入器设置为 null。

路径参数

名称	类型	描述
`index_uid` *	字符串	请求索引的`uid`

示例

curl \
  -X DELETE 'MEILISEARCH_URL/indexes/INDEX_NAME/settings/embedders'

响应：`202 Accepted`

json

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

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

编辑此页

这有帮助吗？

想要包含更多细节？提出问题在我们的公共文档仓库中。

设置

设置界面

设置对象

所有设置

获取设置

路径参数

示例

响应：200 Ok

更新设置

路径参数

正文

示例

警告

响应：202 Accepted

重置设置

路径参数

示例

响应：202 Accepted

字典

提示

获取字典

路径参数

示例

响应：200 OK

更新字典

路径参数

正文

示例

响应：202 Accepted

重置字典

路径参数

示例

响应：202 Accepted

显示的属性

获取显示的属性

路径参数

示例

响应：200 Ok

更新显示的属性

路径参数

正文

警告

示例

响应：202 Accepted

重置显示的属性

路径参数

示例

响应：202 Accepted

Distinct 属性

警告

获取 Distinct 属性

路径参数

示例

响应：200 Ok

更新 Distinct 属性

路径参数

正文

警告

示例

响应：202 Accepted

重置 Distinct 属性

路径参数

示例

响应：202 Accepted

Faceting

Faceting 对象

获取 Faceting 设置

路径参数

示例

响应：200 OK

更新 Faceting 设置

路径参数

正文

注意

示例

响应：202 Accepted

重置分面设置

路径参数

示例

响应：200 OK

响应：`200 Ok`

响应：`202 Accepted`

响应：`202 Accepted`

响应：`200 OK`

响应：`202 Accepted`

响应：`202 Accepted`

响应：`200 Ok`

响应：`202 Accepted`

响应：`202 Accepted`

响应：`200 Ok`

响应：`202 Accepted`

响应：`202 Accepted`

响应：`200 OK`

响应：`202 Accepted`

响应：`200 OK`

`attributePatterns`

`features`

响应：`200 Ok`

响应：`202 Accepted`

响应：`202 Accepted`

`locales` 和 `localizedAttributes`

`locales`

`attributePatterns`

响应：`200 OK`

响应：`202 Accepted`

响应：`202 Accepted`

响应：`200 OK`

响应：`202 Accepted`

响应：`202 Accepted`

响应：`200 OK`

响应：`202 Accepted`

响应：`202 Accepted`