langchain/docs
berkedilekoglu f907b62526
Scores are explained in vectorestore docs (#5613)
# Scores in Vectorestores' Docs Are Explained

Following vectorestores can return scores with similar documents by
using `similarity_search_with_score`:
- chroma
- docarray_hnsw
- docarray_in_memory
- faiss
- myscale
- qdrant
- supabase
- vectara
- weaviate

However, in documents, these scores were either not explained at all or
explained in a way that could lead to misunderstandings (e.g., FAISS).
For instance in FAISS document: if we consider the score returned by the
function as a similarity score, we understand that a document returning
a higher score is more similar to the source document. However, since
the scores returned by the function are distance scores, we should
understand that smaller scores correspond to more similar documents.

For the libraries other than Vectara, I wrote the scores they use by
investigating from the source libraries. Since I couldn't be certain
about the score metric used by Vectara, I didn't make any changes in its
documentation. The links mentioned in Vectara's documentation became
broken due to updates, so I replaced them with working ones.

VectorStores / Retrievers / Memory
  - @dev2049

my twitter: [berkedilekoglu](https://twitter.com/berkedilekoglu)

---------

Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>
2023-06-05 20:39:49 -07:00
..
_static docs: Big Mendable Improvements (#4964) 2023-05-19 15:31:48 -07:00
additional_resources docs: Added Deploying LLMs into production + a new ecosystem (#4047) 2023-06-05 12:47:27 -07:00
ecosystem docs: Added Deploying LLMs into production + a new ecosystem (#4047) 2023-06-05 12:47:27 -07:00
getting_started Update tutorials.md (#5761) 2023-06-05 20:37:11 -07:00
integrations docs: ecosystem/integrations update 5 (#5752) 2023-06-05 16:08:55 -07:00
modules Scores are explained in vectorestore docs (#5613) 2023-06-05 20:39:49 -07:00
reference Documentation fixes (linting and broken links) (#5563) 2023-06-01 13:06:17 -07:00
templates docs ecosystem/integrations update 3 (#5470) 2023-05-31 17:54:05 -07:00
tracing py tracer fixes (#5377) 2023-05-30 18:47:06 -07:00
use_cases minor refactor GenerativeAgentMemory (#5315) 2023-06-03 14:53:14 -07:00
conf.py docs: Mendable Search integration (#2803) 2023-04-13 21:52:25 -07:00
dependents.md docs: updated ecosystem/dependents (#5753) 2023-06-05 16:09:55 -07:00
index.rst docs: Added Deploying LLMs into production + a new ecosystem (#4047) 2023-06-05 12:47:27 -07:00
integrations.rst docs: ecosystem/integrations update 1 (#5219) 2023-05-29 07:25:17 -07:00
make.bat initial commit 2022-10-24 14:51:15 -07:00
Makefile Feature: linkcheck-action (#534) (#542) 2023-01-04 21:39:50 -08:00
reference.rst docs: Deployments page moved into Ecosystem/ (#4949) 2023-05-21 21:18:22 -07:00
requirements.txt Harrison/docs reqs (#2199) 2023-03-30 08:20:30 -07:00