Skip to content

Commit e349a7f

Browse files
docs: complete docstring for DocumentJoiner code example (#8593)
* initial import * changing a method to static * reverting staticmethod
1 parent 2282c26 commit e349a7f

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

Diff for: haystack/components/joiners/document_joiner.py

+14-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,20 @@ class DocumentJoiner:
5454
### Usage example:
5555
5656
```python
57+
from haystack import Pipeline, Document
58+
from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
59+
from haystack.components.joiners import DocumentJoiner
60+
from haystack.components.retrievers import InMemoryBM25Retriever
61+
from haystack.components.retrievers import InMemoryEmbeddingRetriever
62+
from haystack.document_stores.in_memory import InMemoryDocumentStore
63+
5764
document_store = InMemoryDocumentStore()
65+
docs = [Document(content="Paris"), Document(content="Berlin"), Document(content="London")]
66+
embedder = SentenceTransformersDocumentEmbedder(model="sentence-transformers/all-MiniLM-L6-v2")
67+
embedder.warm_up()
68+
docs_embeddings = embedder.run(docs)
69+
document_store.write_documents(docs_embeddings['documents'])
70+
5871
p = Pipeline()
5972
p.add_component(instance=InMemoryBM25Retriever(document_store=document_store), name="bm25_retriever")
6073
p.add_component(
@@ -67,7 +80,7 @@ class DocumentJoiner:
6780
p.connect("embedding_retriever", "joiner")
6881
p.connect("text_embedder", "embedding_retriever")
6982
query = "What is the capital of France?"
70-
p.run(data={"query": query})
83+
p.run(data={"query": query, "text": query, "top_k": 1})
7184
```
7285
"""
7386

0 commit comments

Comments
 (0)