Skip to content

Commit

Permalink
tag /similar as experimental
Browse files Browse the repository at this point in the history
  • Loading branch information
guimachiavelli committed Sep 19, 2024
1 parent 5e1df8b commit 9aba282
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .code-samples.meilisearch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1411,4 +1411,4 @@ experimental_search_parameter_reference_retrieve_vectors_1: |-
"hybrid": {
"embedder": "default"
}
}'
}'
6 changes: 5 additions & 1 deletion reference/api/similar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,16 @@ title: Similar documents — Meilisearch API reference
description: The /similar route accepts one search result and uses AI-powered search to return a number of similar documents.
---

# Similar documents
# Similar documents <NoticeTag type="experimental" label="experimental" />

The `/similar` route uses AI-powered search to return a number of documents similar to a target document.

Meilisearch exposes two routes for retrieving similar documents: `POST` and `GET`. In the majority of cases, `POST` will offer better performance and ease of use.

<Capsule intent="note" title="Activating `/similar`">
This is an experimental feature. To use it, you must first [enable and configure AI-powered search](/learn/ai_powered_search/getting_started_with_ai_search).
</Capsule>

## Get similar documents with `POST`

<RouteHighlighter method="POST" route="/indexes/{index_uid}/similar"/>
Expand Down

0 comments on commit 9aba282

Please sign in to comment.