File tree Expand file tree Collapse file tree
docs-website/reference/haystack-api Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -112,3 +112,19 @@ Asynchronously checks if any document associated with the specified cache field
112112- <code >dict\[ str, Any\] </code > – A dictionary with two keys:
113113- ` hits ` - Documents that matched with at least one of the items.
114114- ` misses ` - Items that were not present in any documents.
115+
116+ #### close
117+
118+ ``` python
119+ close() -> None
120+ ```
121+
122+ Release the synchronous resources of the underlying Document Store.
123+
124+ #### close_async
125+
126+ ``` python
127+ close_async() -> None
128+ ```
129+
130+ Release the asynchronous resources of the underlying Document Store.
Original file line number Diff line number Diff line change @@ -127,3 +127,19 @@ but can be used with `await` in async code.
127127
128128- <code >ValueError</code > – If the specified document store is not found.
129129- <code >TypeError</code > – If the specified document store does not implement ` write_documents_async ` .
130+
131+ #### close
132+
133+ ``` python
134+ close() -> None
135+ ```
136+
137+ Release the synchronous resources of the underlying Document Store.
138+
139+ #### close_async
140+
141+ ``` python
142+ close_async() -> None
143+ ```
144+
145+ Release the asynchronous resources of the underlying Document Store.
Original file line number Diff line number Diff line change @@ -140,6 +140,22 @@ continuing up the hierarchy until no more merges are possible.
140140
141141- <code >dict\[ str, list\[ Document\]\] </code > – List of documents (could be a mix of different hierarchy levels)
142142
143+ #### close
144+
145+ ``` python
146+ close() -> None
147+ ```
148+
149+ Release the synchronous resources of the underlying Document Store.
150+
151+ #### close_async
152+
153+ ``` python
154+ close_async() -> None
155+ ```
156+
157+ Release the asynchronous resources of the underlying Document Store.
158+
143159## filter_retriever
144160
145161### FilterRetriever
@@ -245,6 +261,22 @@ Asynchronously run the FilterRetriever on the given input data.
245261
246262- <code >dict\[ str, Any\] </code > – A list of retrieved documents.
247263
264+ #### close
265+
266+ ``` python
267+ close() -> None
268+ ```
269+
270+ Release the synchronous resources of the underlying Document Store.
271+
272+ #### close_async
273+
274+ ``` python
275+ close_async() -> None
276+ ```
277+
278+ Release the asynchronous resources of the underlying Document Store.
279+
248280## in_memory/bm25_retriever
249281
250282### InMemoryBM25Retriever
@@ -1325,6 +1357,22 @@ document from the document store.
13251357 document surrounding them. The documents are sorted by the ` split_idx_start `
13261358 meta field.
13271359
1360+ #### close
1361+
1362+ ``` python
1363+ close() -> None
1364+ ```
1365+
1366+ Release the synchronous resources of the underlying Document Store.
1367+
1368+ #### close_async
1369+
1370+ ``` python
1371+ close_async() -> None
1372+ ```
1373+
1374+ Release the asynchronous resources of the underlying Document Store.
1375+
13281376## text_embedding_retriever
13291377
13301378### TextEmbeddingRetriever
You can’t perform that action at this time.
0 commit comments