haystack icon indicating copy to clipboard operation
haystack copied to clipboard

Retrievers components: add "Overview" in docs

Open dfokina opened this issue 2 years ago • 0 comments

The goal is not to explain all the parameters available, but rather the things that users needs to prepare to be able to work with the component (API keys, understanding the data classes, understanding how to choose the parameters, having a provider account or any other other things). Some examples are in the AnswerBuilder docs or MetaFieldRanker.

### Tasks
- [ ] InMemoryBM25Retriever
- [ ] InMemoryEmbeddingRetriever
- [ ] AstraRetriever
- [ ] ChromaEmbeddingRetriever
- [ ] ChromaQueryRetriever
- [ ] ElasticsearchBM25Retriever
- [ ] ElasticsearchEmbeddingRetriever
- [ ] OpenSearchBM25Retriever
- [ ] OpenSearchEmbeddingRetriever
- [ ] PineconeDenseRetriever
- [ ] QdrantRetriever

dfokina avatar Jan 31 '24 13:01 dfokina