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, **kwargs: Any) → List[Tuple[Document, float]][source]¶
Perform a similarity search with Yellowbrick
Parameters
query (str) – query string
k (int, optional) – Top K neighbors to retrieve. Defaults to 4.
NOTE – Please do not let end-user fill this and always be aware
of SQL injection.
Returns
List of (Document, similarity)
Return type
List[Document]
similarity_search_with_score_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Tuple[Document, float]][source]¶
Perform a similarity search with Yellowbrick with vector
Parameters
embedding (List[float]) – query embedding
k (int, optional) – Top K neighbors to retrieve. Defaults to 4.
NOTE – Please do not let end-user fill this and always be aware
of SQL injection.
Returns
List of Documents and scores
Return type
List[Document, float]