langchain/docs/modules/indexes/vectorstores/examples
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
..
analyticdb.ipynb docs: improved vectorstore notebooks (#3724) 2023-04-28 19:26:50 -07:00
annoy.ipynb docs: vectorstores, different updates and fixes (#4939) 2023-05-18 15:35:47 -07:00
atlas.ipynb docs: vectorstores, different updates and fixes (#4939) 2023-05-18 15:35:47 -07:00
chroma.ipynb Scores are explained in vectorestore docs (#5613) 2023-06-05 20:39:49 -07:00
clickhouse.ipynb Integrate Clickhouse as Vector Store (#5650) 2023-06-05 13:32:04 -07:00
deeplake.ipynb docs: vectorstores, different updates and fixes (#4939) 2023-05-18 15:35:47 -07:00
docarray_hnsw.ipynb Scores are explained in vectorestore docs (#5613) 2023-06-05 20:39:49 -07:00
docarray_in_memory.ipynb Scores are explained in vectorestore docs (#5613) 2023-06-05 20:39:49 -07:00
elasticsearch.ipynb Es knn index search 5346 (#5569) 2023-06-02 08:40:35 -07:00
faiss.ipynb Scores are explained in vectorestore docs (#5613) 2023-06-05 20:39:49 -07:00
lancedb.ipynb Rename and fix typo in lancedb (#5425) 2023-05-30 00:24:17 -07:00
matchingengine.ipynb Add matching engine vectorstore (#3350) 2023-05-31 02:28:02 -07:00
milvus.ipynb Update the milvus example (#4706) 2023-05-15 16:16:57 -07:00
mongodb_atlas_vector_search.ipynb removing client+namespace in favor of collection (#5610) 2023-06-03 16:27:31 -07:00
myscale.ipynb Scores are explained in vectorestore docs (#5613) 2023-06-05 20:39:49 -07:00
opensearch.ipynb OpenSearch top k parameter fix (#5216) 2023-05-25 09:51:23 -07:00
pgvector.ipynb Created fix for 5475 (#5659) 2023-06-03 16:47:52 -07:00
pinecone.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
qdrant.ipynb Scores are explained in vectorestore docs (#5613) 2023-06-05 20:39:49 -07:00
redis.ipynb docs: vectorstores, different updates and fixes (#4939) 2023-05-18 15:35:47 -07:00
sklearn.ipynb Add SKLearnVectorStore (#5305) 2023-05-28 08:17:42 -07:00
supabase.ipynb Scores are explained in vectorestore docs (#5613) 2023-06-05 20:39:49 -07:00
tair.ipynb docs: vectorstores, different updates and fixes (#4939) 2023-05-18 15:35:47 -07:00
tigris.ipynb feat: Support for Tigris Vector Database for vector search (#5703) 2023-06-05 20:39:16 -07:00
typesense.ipynb Add Typesense vector store (#1674) 2023-05-23 23:20:45 -07:00
vectara.ipynb Scores are explained in vectorestore docs (#5613) 2023-06-05 20:39:49 -07:00
weaviate.ipynb Scores are explained in vectorestore docs (#5613) 2023-06-05 20:39:49 -07:00
zilliz.ipynb Update the milvus example (#4706) 2023-05-15 16:16:57 -07:00