Skip to content

Commit b6a8210

Browse files
docs: sync Haystack API reference on Docusaurus (#12187)
Co-authored-by: julian-risch <4181769+julian-risch@users.noreply.github.com>
1 parent 984fc43 commit b6a8210

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

docs-website/reference/haystack-api/retrievers_api.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1318,7 +1318,8 @@ document from the document store.
13181318

13191319
- **retrieved_documents** (<code>list\[Document\]</code>) – List of retrieved documents from the previous retriever.
13201320
- **window_size** (<code>int | None</code>) – The number of documents to retrieve before and after the relevant one. This will overwrite
1321-
the `window_size` parameter set in the constructor.
1321+
the `window_size` parameter set in the constructor. It must be greater than 0; values of
1322+
0 and negative values are rejected.
13221323

13231324
**Returns:**
13241325

@@ -1346,7 +1347,8 @@ document from the document store.
13461347

13471348
- **retrieved_documents** (<code>list\[Document\]</code>) – List of retrieved documents from the previous retriever.
13481349
- **window_size** (<code>int | None</code>) – The number of documents to retrieve before and after the relevant one. This will overwrite
1349-
the `window_size` parameter set in the constructor.
1350+
the `window_size` parameter set in the constructor. It must be greater than 0; values of
1351+
0 and negative values are rejected.
13501352

13511353
**Returns:**
13521354

0 commit comments

Comments
 (0)