langchain/docs/modules/indexes/retrievers/examples
Leonid Ganeline b96ab4b763
docs retriever improvements (#4430)
# Docs: improvements in the `retrievers/examples/` notebooks

Its primary purpose is to make the Jupyter notebook examples
**consistent** and more suitable for first-time viewers.
- add links to the integration source (if applicable) with a short
description of this source;
- removed `_retriever` suffix from the file names (where it existed) for
consistency;
- removed ` retriever` from the notebook title (where it existed) for
consistency;
- added code to install necessary Python package(s);
- added code to set up the necessary API Key.
- very small fixes in notebooks from other folders (for consistency):
  - docs/modules/indexes/vectorstores/examples/elasticsearch.ipynb
  - docs/modules/indexes/vectorstores/examples/pinecone.ipynb
  - docs/modules/models/llms/integrations/cohere.ipynb
- fixed misspelling in langchain/retrievers/time_weighted_retriever.py
comment (sorry, about this change in a .py file )

## Who can review
@dev2049
2023-05-17 15:29:22 -07:00
..
arxiv.ipynb Add arxiv retriever (#4538) 2023-05-11 22:48:38 -07:00
azure-cognitive-search-retriever.ipynb Add azure cognitive search retriever (#4467) 2023-05-10 15:27:27 -07:00
chatgpt-plugin.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
chroma_self_query.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
cohere-reranker.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
contextual-compression.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
databerry.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
elastic_search_bm25.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
knn.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
metal.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
pinecone_hybrid_search.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
self_query.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
svm.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
tf_idf.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
time_weighted_vectorstore.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
vectorstore.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
vespa.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
weaviate-hybrid.ipynb docs retriever improvements (#4430) 2023-05-17 15:29:22 -07:00
wikipedia.ipynb Typos (#4851) 2023-05-17 11:52:22 -04:00