API 参考
相似文档
`/similar` 路由接受一个搜索结果,并使用 AI 驱动的搜索来返回一系列相似文档。
`/similar` 路由使用 AI 驱动的搜索来返回与目标文档相似的一系列文档。
Meilisearch 公开了两个用于检索相似文档的路由:`POST` 和 `GET`。在大多数情况下,`POST` 将提供更好的性能和易用性。
使用 `POST` 获取相似文档
POST
/indexes/{index_uid}/similar
检索与特定搜索结果相似的文档。
路径参数
名称 | 类型 | 描述 |
---|---|---|
index_uid * | 字符串 | 请求索引的 uid |
请求体
参数 | 类型 | 默认值 | 描述 |
---|---|---|---|
id | 字符串或数字 | null | 目标文档的标识符(必填) |
embedder | 字符串 | null | 计算推荐时使用的嵌入器。必填 |
attributesToRetrieve | 字符串数组 | ["*"] | 返回文档中要显示的属性 |
offset | 整数 | 0 | 要跳过的文档数量 |
limit | 整数 | 20 | 返回的最大文档数量 |
filter | 字符串 | null | 根据属性值过滤查询 |
showRankingScore | 布尔值 | false | 显示文档的全局排名分数 |
showRankingScoreDetails | 布尔值 | false | 显示详细的排名分数信息 |
rankingScoreThreshold | 数字 | null | 排除排名分数低的搜索结果 |
retrieveVectors | 布尔值 | false | 返回文档向量数据 |
示例
响应:`200 OK`
使用 `GET` 获取相似文档
GET
/indexes/{index_uid}/similar
检索与特定搜索结果相似的文档。
路径参数
名称 | 类型 | 描述 |
---|---|---|
index_uid * | 字符串 | 请求索引的 uid |
查询参数
参数 | 类型 | 默认值 | 描述 |
---|---|---|---|
id | 字符串或数字 | null | 目标文档的标识符(必填) |
embedder | 字符串 | "default" | 计算推荐时使用的嵌入器。必填 |
attributesToRetrieve | 字符串数组 | ["*"] | 返回文档中要显示的属性 |
offset | 整数 | 0 | 要跳过的文档数量 |
limit | 整数 | 20 | 返回的最大文档数量 |
filter | 字符串 | null | 根据属性值过滤查询 |
showRankingScore | 布尔值 | false | 显示文档的全局排名分数 |
showRankingScoreDetails | 布尔值 | false | 显示详细的排名分数信息 |
rankingScoreThreshold | 数字 | null | 排除排名分数低的搜索结果 |
retrieveVectors | 布尔值 | false | 返回文档向量数据 |