API 参考
搜索
/search 路由允许您搜索已索引的文档。此路由包含大量参数，您可以使用它们自定义返回的搜索结果。
Meilisearch 暴露了两个路由来执行搜索
在给定索引中搜索匹配特定查询的文档。 当需要 API 密钥时，这是执行搜索的首选端点，因为它允许缓存 预检请求。缓存预检请求**显著提高了搜索速度**。
响应：
在给定索引中搜索匹配特定查询的文档。
此端点只应在不需要 API 密钥时使用。如果需要 API 密钥，请改用 POST 路由。
响应：
预期值：任何字符串
默认值：
这将为您提供一个文档列表，其中包含您的查询词至少在一个属性中。
否定搜索可以与短语搜索一起使用
预期值：任何正整数
默认值：
预期值：任何正整数或零
默认值：
预期值：任何正整数
默认值：
预期值：任何正整数
默认值：
预期值：一个字符串或字符串数组形式的筛选表达式
默认值：
您可以将相同的筛选器写成一个数组
然后您可以在搜索查询中使用该筛选器
使用
如果您的文档包含
如果任何参数无效或缺失，Meilisearch 将返回
预期值：
默认值：
如果匹配文档中没有一个分面具有数值，则该分面不包含在
响应显示了
在分面搜索指南中了解有关分面分布的更多信息。
预期值：
默认值：
预期值：
默认值：
预期值：属性数组或
默认值：
您将收到以下响应，其中裁剪文本在
预期值：正整数
默认值：
预期值：字符串
默认值：
预期值：属性数组或
默认值：
然后，文本的高亮版本将在每个返回文档中包含的
预期值：字符串
默认值：分别为
您可以在
预期值：
默认值：
匹配词在字段中的开头由
您将收到以下响应，其中
预期值：以数组形式或逗号分隔字符串形式编写的属性列表
默认值：
使用
使用
处理包含地理位置数据的文档时，您可以使用
使用
您可以在我们的专用指南中阅读有关基于位置排序的更多信息。
预期值：
默认值：
使用上述代码示例，Meilisearch 将首先返回包含所有三个单词的文档。如果结果不满足请求的
上述代码示例将只返回包含所有三个单词的文档。
在一个包含许多文档包含“shirt”一词的数据集中，上述代码示例将优先处理包含“white”的文档。
预期值：
默认值：
预期值：
默认值：
预期值：介于
默认值：
预期值：以数组形式编写的可搜索属性列表
默认值：
结果不包括在其他字段（如
预期值：包含两个字段：
默认值：
预期值：数字数组
默认值：
在响应中显示
参数：
预期值：
默认值：
预期值：支持的 ISO-639 语言环境 数组
默认值：
预期值：对象
默认值：
在执行多模态搜索时，指定用于填充搜索片段的数据。
- 一个 POST 路由：这是使用 API 身份验证时的首选路由，因为它允许 预检请求 缓存和更好的性能
- 一个 GET 路由：不建议使用此路由，除非您有充分理由（例如特定的缓存能力）
使用 POST 在索引中搜索
POST
/indexes/{index_uid}/search
默认情况下，此端点最多返回 1000 个结果。如果您想抓取数据库，请改用 获取文档端点。
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
index_uid * | 字符串 | 请求索引的 uid |
请求体
| 搜索参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
q | 字符串 | "" | 查询字符串 |
offset | 整数 | 0 | 要跳过的文档数量 |
limit | 整数 | 20 | 返回的最大文档数量 |
hitsPerPage | 整数 | 1 | 每页返回的最大文档数量 |
page | 整数 | 1 | 请求特定页码的结果 |
filter | 字符串或字符串数组 | null | 按属性值筛选查询 |
facets | 字符串数组 | null | 显示每个分面的匹配计数 |
distinct | 字符串 | null | 将搜索限制为指定属性具有唯一值的文档 |
attributesToRetrieve | 字符串数组 | ["*"] | 在返回的文档中显示的属性 |
attributesToCrop | 字符串数组 | null | 其值需要裁剪的属性 |
cropLength | 整数 | 10 | 裁剪值的最大长度（以词为单位） |
cropMarker | 字符串 | "…" | 标记裁剪边界的字符串 |
attributesToHighlight | 字符串数组 | null | 高亮属性中包含的匹配词 |
highlightPreTag | 字符串 | "<em>" | 插入到高亮词开头的字符串 |
highlightPostTag | 字符串 | "</em>" | 插入到高亮词末尾的字符串 |
showMatchesPosition | 布尔值 | false | 返回匹配词的位置 |
sort | 字符串数组 | null | 按属性值对搜索结果排序 |
matchingStrategy | 字符串 | last（最后） | 用于匹配文档中查询词的策略 |
showRankingScore | 布尔值 | false | 显示文档的全局排名得分 |
showRankingScoreDetails | 布尔值 | false | 添加详细的全局排名得分字段 |
rankingScoreThreshold | 数字 | null | 排除排名得分较低的结果 |
attributesToSearchOn | 字符串数组 | ["*"] | 将搜索限制在指定的属性上 |
hybrid | 对象 | null | 根据查询关键字和含义返回结果 |
vector | 数字数组 | null | 使用自定义查询向量进行搜索 |
retrieveVectors | 布尔值 | false | 返回文档向量数据 |
locales | 字符串数组 | null | 明确指定查询中使用的语言 |
media | 对象 | null | 使用多模态内容执行 AI 驱动的搜索查询 |
响应
| 名称 | 类型 | 描述 |
|---|---|---|
hits | 对象数组 | 查询结果 |
offset | 数字 | 跳过的文档数量 |
limit | 数字 | 要获取的文档数量 |
estimatedTotalHits | 数字 | 匹配的总数（估算） |
totalHits | 数字 | 匹配的总数（精确） |
totalPages | 数字 | 搜索结果页的总数（精确） |
hitsPerPage | 数字 | 每页的结果数量 |
page | 数字 | 当前搜索结果页 |
facetDistribution（分面分布） | 对象 | 给定分面的分布 |
facetStats（分面统计） | 对象 | 每个分面的数字 min 和 max 值 |
processingTimeMs | 数字 | 查询处理时间 |
query | 字符串 | 原始查询 |
搜索结果的总数（精确和估算）
默认情况下，Meilisearch 只返回查询中搜索结果总数的估算值：estimatedTotalHits。这是因为 Meilisearch 优先考虑相关性和性能，而不是提供详尽的搜索结果数量。在使用 estimatedTotalHits 时，请使用 offset 和 limit 在搜索结果之间导航。 如果您需要搜索结果的总数，请在查询中使用 hitsPerPage 和 page 搜索参数。此查询的响应将 estimatedTotalHits 替换为 totalHits，并包含一个根据您的 hitsPerPage 计算出的搜索结果页数的额外字段：totalPages。使用 totalHits 和 totalPages 可能会导致性能略有下降，但在创建带数字的页面选择器等 UI 元素时建议使用。 estimatedTotalHits 和 totalHits 都不能超过 索引的 maxTotalHits 设置 中配置的限制。 您可以在我们的 专用指南中阅读有关分页的更多信息。示例
响应：200 Ok
使用 GET 在索引中搜索
GET
/indexes/{index_uid}/search
此端点只接受 字符串筛选表达式。
默认情况下，此端点最多返回 1000 个结果。如果您想抓取数据库，请改用 获取文档端点。
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
index_uid * | 字符串 | 请求索引的 uid |
查询参数
| 搜索参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
q | 字符串 | "" | 查询字符串 |
offset | 整数 | 0 | 要跳过的文档数量 |
limit | 整数 | 20 | 返回的最大文档数量 |
hitsPerPage | 整数 | 1 | 每页返回的最大文档数量 |
page | 整数 | 1 | 请求特定页码的结果 |
filter | 字符串或字符串数组 | null | 按属性值筛选查询 |
facets | 字符串数组 | null | 显示每个分面的匹配计数 |
distinct | 字符串 | null | 将搜索限制为指定属性具有唯一值的文档 |
attributesToRetrieve | 字符串数组 | ["*"] | 在返回的文档中显示的属性 |
attributesToCrop | 字符串数组 | null | 其值需要裁剪的属性 |
cropLength | 整数 | 10 | 裁剪值的最大长度（以词为单位） |
cropMarker | 字符串 | "…" | 标记裁剪边界的字符串 |
attributesToHighlight | 字符串数组 | null | 高亮属性中包含的匹配词 |
highlightPreTag | 字符串 | "<em>" | 插入到高亮词开头的字符串 |
highlightPostTag | 字符串 | "</em>" | 插入到高亮词末尾的字符串 |
showMatchesPosition | 布尔值 | false | 返回匹配词的位置 |
sort | 字符串数组 | null | 按属性值对搜索结果排序 |
matchingStrategy | 字符串 | last（最后） | 用于匹配文档中查询词的策略 |
showRankingScore | 布尔值 | false | 显示文档的全局排名得分 |
showRankingScoreDetails | 布尔值 | false | 添加详细的全局排名得分字段 |
rankingScoreThreshold | 数字 | null | 排除排名得分较低的结果 |
attributesToSearchOn | 字符串数组 | ["*"] | 将搜索限制在指定的属性上 |
hybrid | 对象 | null | 根据查询关键字和含义返回结果 |
vector | 数字数组 | null | 使用自定义查询向量进行搜索 |
retrieveVectors | 布尔值 | false | 返回文档向量数据 |
locales | 字符串数组 | null | 明确指定查询中使用的语言 |
响应
| 名称 | 类型 | 描述 |
|---|---|---|
hits | 对象数组 | 查询结果 |
offset | 数字 | 跳过的文档数量 |
limit | 数字 | 要获取的文档数量 |
estimatedTotalHits | 数字 | 匹配的总数（估算） |
totalHits | 数字 | 匹配的总数（精确） |
totalPages | 数字 | 搜索结果页的总数（精确） |
hitsPerPage | 数字 | 每页的结果数量 |
page | 数字 | 当前搜索结果页 |
facetDistribution（分面分布） | 对象 | 给定分面的分布 |
facetStats（分面统计） | 对象 | 每个分面的数字 min 和 max 值 |
processingTimeMs | 数字 | 查询处理时间 |
query | 字符串 | 原始查询 |
示例
响应：200 Ok
搜索参数
下面详尽描述了当前在使用搜索端点时可用的每个搜索参数。除非另有说明，所有参数都适用于GET /indexes/{index_uid}/search、POST /indexes/{index_uid}/search 和 /multi-search 路由。
如果 使用
GET 路由执行搜索，所有参数都必须经过 URL 编码。在使用 POST 路由或我们的某个 SDK 时，这不是必需的。查询 (q)
参数：q预期值：任何字符串
默认值：
null 设置搜索词。Meilisearch 只考虑任何给定搜索查询的前十个词。这是为了提供 快速的输入即搜索体验 所必需的。
示例
您可以通过设置q 参数来搜索提及 shifu 的电影。
查询词标准化
查询词会经过一个标准化过程，该过程会删除 非间距标记。因此，Meilisearch 在返回结果时会有效地忽略重音和变音符号。例如，搜索"sábia" 会返回包含 "sábia"、"sabiá" 和 "sabia" 的文档。 标准化还会将所有字母转换为小写。搜索 "Video" 返回的结果与搜索 "video"、"VIDEO" 或 "viDEO" 相同。占位符搜索
当未指定q 时，Meilisearch 执行占位符搜索。占位符搜索返回索引中所有可搜索的文档，并根据使用的任何搜索参数进行修改，并根据该索引的 自定义排名规则 进行排序。由于没有查询词，因此 内置排名规则 不适用。 如果索引没有排序或自定义排名规则，则结果将按照其内部数据库位置的顺序返回。占位符搜索在构建 分面搜索界面 时特别有用，因为它允许用户查看目录并更改排序规则，而无需输入查询。
短语搜索
如果您将搜索词括在双引号 (") 中，Meilisearch 将只返回包含这些词的文档，并按给定顺序排列。这称为短语搜索。 短语搜索不区分大小写，并忽略 软分隔符，例如 -、, 和 :。在短语搜索中使用硬分隔符会将其有效地拆分为多个单独的短语搜索："Octavia.Butler" 将返回与 "Octavia" "Butler" 相同的结果。 您可以将短语搜索和普通查询组合在一个搜索请求中。在这种情况下，Meilisearch 将首先获取与给定短语完全匹配的所有文档，然后 继续其默认行为。示例
否定搜索
在单词或短语前面使用减号（-）运算符将其从搜索结果中排除。
示例
以下查询返回所有不包含“escape”一词的文档偏移量
参数：offset预期值：任何正整数
默认值：
0 设置搜索结果中的起始点，有效地跳过给定数量的文档。 使用 offset 和 limit 的查询只返回搜索结果总数的估计值。 您可以通过组合 offset 和 limit 的查询来 分页搜索结果。将
offset 设置为大于 索引的 maxTotalHits 的值将返回一个空数组。示例
如果您想跳过查询中的第一个结果，请将offset 设置为 1
限制
参数：limit预期值：任何正整数或零
默认值：
20 设置单个查询返回的最大文档数。 您可以通过组合 offset 和 limit 的查询来 分页搜索结果。一个搜索查询不能返回超过
maxTotalHits 中配置的结果，即使 limit 的值大于 maxTotalHits 的值。示例
如果您希望查询只返回两个文档，请将limit 设置为 2
每页结果数
参数：hitsPerPage预期值：任何正整数
默认值：
20 设置单个查询返回的最大文档数。此参数配置的值决定了总页数：如果 Meilisearch 找到总共 20 个查询匹配，并且您的 hitsPerPage 设置为 5，则 totalPages 为 4。 包含 hitsPerPage 的查询是详尽的，不返回 estimatedTotalHits。相反，响应体将包含 totalHits 和 totalPages。 如果您将 hitsPerPage 设置为 0，Meilisearch 将处理您的请求，但不返回任何文档。在这种情况下，响应体将包含 totalHits 的详尽值。响应体还将包含 totalPages，但其值将为 0。 您可以使用 hitsPerPage 和 page 来 分页搜索结果。hitsPerPage 和 page 优先于 offset 和 limit。如果查询包含 hitsPerPage 或 page，则传递给 offset 和 limit 的任何值都将被忽略。hitsPerPage 和 page 是资源密集型选项，可能会对搜索性能产生负面影响。如果 maxTotalHits 设置为高于其默认值，则这种情况尤其可能发生。示例
以下示例返回查询的前 15 个结果页码
参数：page预期值：任何正整数
默认值：
1 请求特定结果页。页数使用 hitsPerPage 搜索参数计算。 包含 page 的查询是详尽的，不返回 estimatedTotalHits。相反，响应体将包含两个新字段：totalHits 和 totalPages。 如果您将 page 设置为 0，Meilisearch 将处理您的请求，但不返回任何文档。在这种情况下，响应体将包含 facetDistribution、totalPages 和 totalHits 的详尽值。 您可以使用 hitsPerPage 和 page 来 分页搜索结果。hitsPerPage 和 page 优先于 offset 和 limit。如果查询包含 hitsPerPage 或 page，则传递给 offset 和 limit 的任何值都将被忽略。hitsPerPage 和 page 是资源密集型选项，可能会对搜索性能产生负面影响。如果 maxTotalHits 设置为高于其默认值，则这种情况尤其可能发生。示例
以下示例返回搜索结果的第二页筛选
参数：filter预期值：一个字符串或字符串数组形式的筛选表达式
默认值：
[] 使用筛选表达式来优化搜索结果。用作筛选条件的属性必须添加到 filterableAttributes 列表 中。 有关更多信息，请阅读我们的关于如何使用筛选器和构建筛选表达式的指南。示例
您可以使用逻辑连接词以字符串语法编写筛选表达式使用 _geoRadius 和 _geoBoundingBox 筛选结果
如果您的文档包含 _geo 数据，您可以使用 _geoRadius 和 _geoBoundingBox 内置筛选规则来根据其地理位置筛选结果。
_geoRadius 根据中心点和半径建立一个圆形区域。此筛选规则需要三个参数：lat、lng 和 distance_in_meters。lat 和 lng 应为表示地理坐标的浮点数。distance_in_meters 表示您希望结果所在区域的半径，应为整数。invalid_search_filter 错误。
分面
参数：facets预期值：
attribute 数组或 ["*"]默认值：
null 返回每个给定分面匹配当前搜索查询的文档数量。此参数可以取两个值
- 属性数组：
facets=["attributeA", "attributeB", …] - 星号——这将返回
filterableAttributes中存在的所有分面的计数
facets 为每个分面字段返回最多 100 个分面值。您可以使用 faceting 索引设置 的 maxValuesPerFacet 属性更改此值。 当设置 facets 时，搜索结果对象包含 facetDistribution 和 facetStats 字段。如果在
facets 中使用的属性未添加到 filterableAttributes 列表中，则将被忽略。facetDistribution（分面分布）
facetDistribution 包含在给定分面值中匹配文档的数量。每个分面都表示为一个对象
facetDistribution 包含针对传递给 facets 参数的每个属性的对象。每个对象包含该属性的返回值以及匹配该值的文档计数。Meilisearch 不返回空分面。
facetStats（分面统计）
facetStats 包含每个分面中所有文档的最低 (min) 和最高 (max) 数值。只考虑数值
facetStats 对象中。facetStats 忽略字符串值，即使字符串包含数字。
示例
给定一个电影评级数据库，以下代码示例返回每个类型中Batman 电影的数量以及最低和最高评级
genres 和 rating 的分面分布。由于 rating 是一个数值字段，您可以在 facetStats 中获取其最小值和最大值。
搜索时区分属性
参数：distinct预期值：
filterableAttributes 列表中存在的 attribute默认值：
null 将 filterableAttributes 列表中的一个属性定义为不同属性。不同属性表示共享指定字段相同值的文档是等效的，并且只应在搜索结果中返回最相关的文档。 此行为类似于 distinctAttribute 索引设置，但可以在搜索时配置。distinctAttribute 作为默认的不同属性值，您可以使用 distinct 覆盖。示例
要检索的属性
参数：attributesToRetrieve预期值：
attribute 数组或 ["*"]默认值：
["*"] 配置在返回的文档中将检索哪些属性。 如果未指定值，attributesToRetrieve 将使用 displayedAttributes 列表，该列表默认包含文档中找到的所有属性。如果属性已从
displayedAttributes 中移除，则 attributesToRetrieve 将默默地忽略它，并且该字段不会出现在您的返回文档中。示例
要仅获取overview 和 title 字段，请将 attributesToRetrieve 设置为 ["overview", "title"]。
要裁剪的属性
参数：attributesToCrop预期值：属性数组或
["*"]默认值：
null 将返回结果中选定字段裁剪为 cropLength 参数指示的长度。当设置 attributesToCrop 时，每个返回的文档都包含一个名为 _formatted 的额外字段。此对象包含选定属性的裁剪版本。 默认情况下，裁剪边界由省略号字符 (…) 标记。您可以使用 cropMarker 搜索参数更改此设置。 或者，您可以为赋予 attributesToCrop 的任何属性指示自定义裁剪长度：attributesToCrop=["attributeNameA:5", "attributeNameB:9"]。如果已配置，这些值优先于 cropLength。 您可以提供 ["*"] 作为通配符而不是提供单个属性：attributesToCrop=["*"]。这会导致 _formatted 包含 attributesToRetrieve 中所有属性的裁剪值。裁剪算法
假设您有一个包含以下字符串的字段：Donatello is a skilled and smart turtle. Leonardo is the most skilled turtle. Raphael is the strongest turtle. Meilisearch 在裁剪时会尽量尊重句子边界。例如，如果您的搜索词是 Leonardo 且您的 cropLength 为 6，Meilisearch 将优先保持句子完整并返回：Leonardo is the most skilled turtle. 如果查询只包含一个搜索词，Meilisearch 将围绕该词的第一次出现进行裁剪。如果您搜索 turtle 且您的 cropLength 为 7，Meilisearch 将返回该词的第一个实例：Donatello is a skilled and smart turtle. 如果查询包含多个搜索词，Meilisearch 将围绕最大数量的唯一匹配项进行裁剪，优先考虑彼此更接近且遵循原始查询顺序的词。如果您搜索 skilled turtle 且 cropLength 为 6，Meilisearch 将返回 Leonardo is the most skilled turtle。 如果 Meilisearch 在字段中找不到任何查询词，裁剪将从该字段的第一个词开始。如果您搜索 Michelangelo 且 cropLength 为 4，并且此字符串存在于另一个字段中，Meilisearch 将返回 Donatello is a skilled …。示例
如果您使用shifu 作为搜索查询并将 cropLength 参数的值设置为 5
_formatted 对象中
裁剪长度
参数：cropLength预期值：正整数
默认值：
10 配置使用 attributesToCrop 时，裁剪值中要显示的单词总数。如果未配置 attributesToCrop，则 cropLength 对返回的结果没有影响。 查询词被计入裁剪值的长度。如果 cropLength 设置为 2 并且您搜索一个词（例如 shifu），裁剪后的字段将总共包含两个词（例如 "…Shifu informs…"）。 停用词也计入此数字。如果 cropLength 设置为 2 并且您搜索一个词（例如 grinch），裁剪结果可能包含一个停用词（例如 "…the Grinch…"）。 如果 attributesToCrop 使用 attributeName:number 语法指定属性的自定义裁剪长度，则该值优先于 cropLength。裁剪标记
参数：cropMarker预期值：字符串
默认值：
"…" 在使用 attributesToCrop 参数时，设置一个字符串来标记裁剪边界。裁剪标记将插入到裁剪的两侧。如果未配置 attributesToCrop，则 cropMarker 对返回的搜索结果没有影响。 如果 cropMarker 设置为 null 或空字符串，则返回结果中不包含任何标记。 裁剪标记只在内容被移除时添加。例如，如果裁剪文本包含字段值的第一个词，则裁剪标记不会添加到裁剪结果的开头。示例
搜索shifu 时，您可以使用 cropMarker 更改默认的 …
要高亮的属性
参数：attributesToHighlight预期值：属性数组或
["*"]默认值：
null 高亮指定属性中的匹配查询词。attributesToHighlight 只适用于以下类型的值：字符串、数字、数组、对象。 设置此参数后，返回的文档将包含一个 _formatted 对象，其中包含高亮词。 您可以将 ["*"] 用作通配符，而不是属性列表：attributesToHighlight=["*"]。在这种情况下，attributesToRetrieve 中存在的所有属性都将分配给 attributesToHighlight。 默认情况下，高亮元素用 <em> 和 </em> 标签括起来。您可以使用 highlightPreTag 和 highlightPostTag 搜索参数 更改此设置。
attributesToHighlight 将高亮添加到 attributesToHighlight 数组中的所有属性中的匹配项，即使这些属性未设置为 searchableAttributes。示例
以下查询高亮overview 属性中存在的匹配项
_formatted 对象中找到
高亮标签
参数：highlightPreTag 和 highlightPostTag预期值：字符串
默认值：分别为
"<em>" 和 "</em>" highlightPreTag 和 highlightPostTag 分别配置要插入到由 attributesToHighlight 高亮显示的单词之前和之后的字符串。如果未配置 attributesToHighlight，则 highlightPreTag 和 highlightPostTag 对返回的搜索结果没有影响。 可以使用 highlightPreTag 和 highlightPostTag 将词括在任何文本字符串之间，而不仅仅是 HTML 标签："<em>"、"<strong>"、"*" 和 "__" 都是同样支持的值。 如果 highlightPreTag 或 highlightPostTag 设置为 null 或空字符串，则在高亮词的开头或结尾分别不插入任何内容。示例
以下查询将高亮匹配项括在带class 属性的 <span> 标签中
_formatted 属性中找到高亮的查询词
尽管不一定要同时使用
highlightPreTag 和 highlightPostTag，但请务必确保标签正确匹配。在上面的示例中，不设置 highlightPostTag 将导致格式错误的 HTML：<span>Winter Feast</em>。显示匹配位置
参数：showMatchesPosition预期值：
true 或 false默认值：
false 向搜索响应添加一个 _matchesPosition 对象，其中包含查询词在所有字段中每次出现的位置。当您需要比我们 内置高亮 更强的控制时，这很有用。showMatchesPosition 仅适用于字符串、数字以及字符串和数字数组。showMatchesPosition 返回所有属性中匹配查询词的位置，即使这些属性未设置为 searchableAttributes。start 指示，其长度由 length 指示。
start 和 length 以字节而不是字符数测量。例如，ü 表示两个字节但一个字符。示例
如果您将showMatchesPosition 设置为 true 并搜索 winter feast
_matchesPosition 对象中包含有关匹配项的信息。请注意 Meilisearch 如何因为空格而分别搜索 winter 和 feast
排序
参数：sort预期值：以数组形式或逗号分隔字符串形式编写的属性列表
默认值：
null 在查询时根据指定的属性和指示的顺序对搜索结果进行排序。 列表中每个属性后必须跟一个冒号 (:) 和首选的排序顺序：升序 (asc) 或降序 (desc)。属性顺序很重要。列表中的第一个属性将优先于后面的属性。例如，
sort="price:asc,author:desc 在排序结果时将 price 优先于 author。POST 路由时，sort 期望一个字符串数组。 使用 GET 路由时，sort 期望列表为逗号分隔字符串。 在我们的专用指南中阅读有关排序搜索结果的更多信息。示例
您可以搜索从最便宜到最贵的科幻书籍使用 _geoPoint 排序结果
处理包含地理位置数据的文档时，您可以使用 _geoPoint 根据文档与特定地理位置的距离对结果进行排序。 _geoPoint 是一个排序函数，需要两个浮点数表示位置的纬度和经度。您还必须指定排序应是升序 (asc) 还是降序 (desc)：_geoPoint 的查询将始终包含一个 geoDistance 字段，其中包含文档位置与 _geoPoint 之间的距离（以米为单位）。
匹配策略
参数：matchingStrategy预期值：
last、all 或 frequency默认值：
last 定义用于匹配文档中查询词的策略。last（最后）
last 首先返回包含所有查询词的文档。如果包含所有查询词的结果不足以满足请求的 limit，Meilisearch 将一次删除一个查询词，从查询末尾开始。
limit，它还将返回仅包含前两个词 big fat 的文档，然后是仅包含 big 的文档。
all（全部）
all 只返回包含所有查询词的文档。即使没有足够的文档来满足请求的 limit，Meilisearch 也不会匹配更多文档。
frequency（频率）
frequency 首先返回包含所有查询词的文档。如果包含所有查询词的结果不足以满足请求的限制，Meilisearch 将一次删除一个查询词，从数据集中最常出现的词开始。frequency 有效地为在结果集中不那么频繁出现的词赋予更高的权重。
排名分数
参数：showRankingScore预期值：
true 或 false默认值：
false 向每个文档添加一个全局排名得分字段，_rankingScore。_rankingScore 是一个介于 0.0 和 1.0 之间的数值。_rankingScore 越高，文档越相关。 sort 排名规则不影响 _rankingScore。相反，文档顺序由它们排序的字段值决定。文档的排名得分不会因同一索引中其他文档的得分而改变。例如，如果文档 A 的某个查询词的得分是
0.5，则无论文档 B、C 或 D 的得分如何，此值都保持不变。示例
以下代码示例在movies 中搜索 dragon 时返回 _rankingScore
排名得分详情
参数：showRankingScoreDetails预期值：
true 或 false默认值：
false 向每个文档添加一个详细的全局排名得分字段 _rankingScoreDetails。_rankingScoreDetails 是一个对象，其中包含每个活动排名规则的嵌套对象。排名得分详情对象
每个排名规则在其自己的对象中详细说明其得分。字段因排名规则而异。words
order：此排名规则应用的顺序score：此规则的排名得分matchingWords：文档中匹配查询的单词数maxMatchingWords：文档中可匹配查询的最大单词数
typo
order：此特定排名规则应用的顺序score：此规则的排名得分typoCount：为使文档匹配查询词而更正的错别字数maxTypoCount：接受的最大错别字数
proximity
order：此排名规则应用的顺序score：此规则的排名得分
attribute
order：此排名规则应用的顺序score：此规则的排名得分attributeRankingOrderScore：根据匹配属性的最大属性排名顺序计算的得分queryWordDistanceScore：根据查询词位置与匹配属性中词位置之间的距离计算的得分
exactness
order：此排名规则应用的顺序score：此规则的排名得分matchType：exactMatch、matchesStart或noExactMatchexactMatch：文档包含一个属性，该属性与所有查询词完全匹配，且它们之间没有其他词，并且顺序与给定顺序相同matchesStart：文档包含一个属性，其中所有查询词的顺序与原始查询相同noExactMatch：文档包含一个属性，其中至少有一个查询词与原始查询匹配
matchingWords：当matchType为noExactMatch时，属性中的精确匹配数maxMatchingWords：当matchType为noExactMatch时，属性中的最大精确匹配数
field_name:direction
sort 排名规则不会在得分详细信息对象中显示为单个字段。相反，每个排序属性都显示为其自己的字段，后跟冒号 (:) 和排序方向：attribute:direction。
order：此排名规则应用的顺序value：用于排序的字段值
_geoPoint(lat:lng):direction
order：此排名规则应用的顺序value：用于排序的字段值distance：与 _geoDistance 相同
vectorSort(target_vector)
order：此特定排名规则应用的顺序value：用于排序文档的向量similarity：目标向量和值向量之间的相似度得分。1.0 表示完美相似度，0.0 表示完美不相似度
示例
以下代码示例在movies 中搜索 dragon 时返回 _rankingScoreDetail
排名得分阈值
参数：rankingScoreThreshold预期值：介于
0.0 和 1.0 之间的数字默认值：
null 排除低于指定排名得分的结果。该阈值适用于所有搜索类型，包括全文搜索、语义搜索和混合搜索。 排除的结果不计入 estimatedTotalHits、totalHits 和分面分布。将
rankingScoreThreshold 与 page 和 hitsPerPage 一起使用会强制 Meilisearch 评估所有匹配文档的排名得分，以返回准确的 totalHits。这可能会对搜索性能产生负面影响。使用 limit 和 offset 的查询在使用 rankingScoreThreshold 时可避免此开销。示例
以下查询仅返回排名得分大于0.2 的结果
在搜索时自定义搜索属性
参数：attributesToSearchOn预期值：以数组形式编写的可搜索属性列表
默认值：
["*"] 配置查询以仅在指定的属性中查找词。 您可以向 attributesToSearchOn 传递通配符值 (["*"]) 和 null，而不是属性列表。在这两种情况下，Meilisearch 都将在所有可搜索属性中搜索匹配项。传递给
attributesToSearchOn 的属性也必须存在于 searchableAttributes 列表中。attributesToSearchOn 中属性的顺序不影响相关性。
示例
以下查询返回其overview 包含 "adventure" 的文档
title 或 genre）中包含 "adventure" 的文档，即使这些字段存在于 searchableAttributes 列表中。
混合搜索
参数：hybrid预期值：包含两个字段：
embedder 和 semanticRatio 的对象默认值：
null 配置 Meilisearch 根据查询的含义和上下文返回搜索结果。 hybrid 必须是一个对象。它接受两个字段：embedder 和 semanticRatio。 embedder 必须是一个字符串，指示使用 /settings 端点配置的嵌入器。执行 AI 驱动的搜索时必须指定有效的嵌入器。 semanticRatio 必须是一个介于 0.0 和 1.0 之间的数字，表示关键字搜索和语义搜索结果之间的比例。0.0 导致 Meilisearch 只返回关键字结果。1.0 导致 Meilisearch 只返回基于含义的结果。默认为 0.5。示例
向量
参数：vector预期值：数字数组
默认值：
null 使用自定义向量执行搜索查询。必须是与自定义向量维度对应的数字数组。 使用 userProvided 嵌入器执行搜索时，vector 是强制性的。您还可以使用 vector 覆盖嵌入器的自动向量生成。 vector 维度必须与嵌入器的维度匹配。如果查询未指定
q，但包含 vector 且 hybrid.semanticRatio 大于 0，则 Meilisearch 执行纯语义搜索。如果 q 缺失且 semanticRatio 明确设置为 0，则 Meilisearch 执行不含任何向量搜索结果的占位符搜索。示例
在响应中显示 _vectors
参数：retrieveVectors预期值：
true 或 false默认值：
false 返回带有搜索结果的文档嵌入数据。如果为 true，Meilisearch 将在每个 文档的 _vectors 字段 中显示向量数据。示例
查询语言环境
参数：locales预期值：支持的 ISO-639 语言环境 数组
默认值：
[] 默认情况下，Meilisearch 会自动检测查询的语言。使用此参数明确声明查询的语言。 如果 locales 与 本地化属性索引设置 不匹配，则此参数优先。locales 和 localizedAttributes 的目标相同：当 Meilisearch 的语言自动检测不按预期工作时，明确声明搜索中使用的语言。如果您认为 Meilisearch 由于查询文本而检测到不正确的语言，请使用 locales 明确设置搜索语言。如果您认为 Meilisearch 由于文档而检测到不正确的语言，请使用 localizedAttributes 在索引级别明确设置文档语言。为了完全控制 Meilisearch 在索引和搜索时检测语言的方式，请同时设置 locales 和 localizedAttributes。示例
媒体 实验性
参数：media预期值：对象
默认值：
null
这是一项实验性功能。请使用 Meilisearch Cloud UI 或实验性功能端点来激活它
media 必须是一个对象，其字段必须对应于一个 搜索片段 所需的数据。media 必须匹配单个搜索片段。如果 media 匹配多个片段或根本没有搜索片段，Meilisearch 将返回错误。 使用 media 时必须指定嵌入器。media 与 vector 不兼容。