Return docs and relevance scores in the range [0, 1].
0 is dissimilar, 1 is most similar.
Parameters
query – input text
k – Number of Documents to return. Defaults to 4.
**kwargs – kwargs to be passed to similarity search. Should include:
score_threshold: Optional, a floating point value between 0 to 1 to
filter the resulting set of retrieved docs
Returns
List of Tuples of (doc, similarity_score)
similarity_search_with_score(query: str, k: int = 4, filter: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶
Return meilisearch documents most similar to the query, along with scores.
Parameters
query (str) – Query text for which to find similar documents.
k (int) – Number of documents to return. Defaults to 4.
filter (Optional[Dict[str, str]]) – Filter by metadata.
Defaults to None.
Returns
List of Documents most similar to the query
text and score for each.
Return type
List[Document]
Examples using Meilisearch¶
Meilisearch