Sync Core Integrations API reference (opensearch) on Docusaurus

Author: anakin87

docs-website/reference/integrations-api/opensearch.md

@@ -129,6 +129,22 @@ Deserializes the component from a dictionary.
 
 - <code>OpenSearchBM25Retriever</code> – Deserialized component.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the synchronous resources of the underlying Document Store.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the asynchronous resources of the underlying Document Store.
+
 #### run
 
 ```python
@@ -376,6 +392,22 @@ Deserializes the component from a dictionary.
 
 - <code>OpenSearchEmbeddingRetriever</code> – Deserialized component.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the synchronous resources of the underlying Document Store.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the asynchronous resources of the underlying Document Store.
+
 #### run
 
 ```python
@@ -703,6 +735,22 @@ Deserializes the component from a dictionary.
 
 - <code>OpenSearchMetadataRetriever</code> – Deserialized component.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the synchronous resources of the underlying Document Store.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the asynchronous resources of the underlying Document Store.
+
 #### run
 
 ```python
@@ -884,7 +932,9 @@ docker run -d --name opensearch-nosec -p 9200:9200 -p 9600:9600 -e "discovery.ty
 
 ```python
 from haystack import Document
-from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
+# Requires: pip install sentence-transformers-haystack
+from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
+from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
 from haystack_integrations.components.retrievers.opensearch import OpenSearchHybridRetriever
 from haystack_integrations.document_stores.opensearch import OpenSearchDocumentStore
 
@@ -906,7 +956,6 @@ docs = [
 
 # Embed the documents and add them to the document store
 doc_embedder = SentenceTransformersDocumentEmbedder(model="sentence-transformers/all-MiniLM-L6-v2")
-doc_embedder.warm_up()
 docs = doc_embedder.run(docs)
 doc_store.write_documents(docs['documents'])
 
@@ -1042,6 +1091,22 @@ from_dict(data: dict[str, Any]) -> OpenSearchHybridRetriever
 
 Deserialize an OpenSearchHybridRetriever from a dictionary.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the synchronous resources of the underlying Document Store.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the asynchronous resources of the underlying Document Store.
+
 ## haystack_integrations.components.retrievers.opensearch.sql_retriever
 
 ### OpenSearchSQLRetriever
@@ -1105,6 +1170,22 @@ Deserializes the component from a dictionary.
 
 - <code>OpenSearchSQLRetriever</code> – Deserialized component.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the synchronous resources of the underlying Document Store.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the asynchronous resources of the underlying Document Store.
+
 #### run
 
 ```python
@@ -1319,6 +1400,22 @@ Deserializes the component from a dictionary.
 
 - <code>OpenSearchDocumentStore</code> – Deserialized component.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the associated synchronous resources.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the associated asynchronous resources.
+
 #### count_documents
 
 ```python

docs-website/reference_versioned_docs/version-2.18/integrations-api/opensearch.md

@@ -129,6 +129,22 @@ Deserializes the component from a dictionary.
 
 - <code>OpenSearchBM25Retriever</code> – Deserialized component.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the synchronous resources of the underlying Document Store.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the asynchronous resources of the underlying Document Store.
+
 #### run
 
 ```python
@@ -376,6 +392,22 @@ Deserializes the component from a dictionary.
 
 - <code>OpenSearchEmbeddingRetriever</code> – Deserialized component.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the synchronous resources of the underlying Document Store.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the asynchronous resources of the underlying Document Store.
+
 #### run
 
 ```python
@@ -703,6 +735,22 @@ Deserializes the component from a dictionary.
 
 - <code>OpenSearchMetadataRetriever</code> – Deserialized component.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the synchronous resources of the underlying Document Store.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the asynchronous resources of the underlying Document Store.
+
 #### run
 
 ```python
@@ -884,7 +932,9 @@ docker run -d --name opensearch-nosec -p 9200:9200 -p 9600:9600 -e "discovery.ty
 
 ```python
 from haystack import Document
-from haystack.components.embedders import SentenceTransformersTextEmbedder, SentenceTransformersDocumentEmbedder
+# Requires: pip install sentence-transformers-haystack
+from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersTextEmbedder
+from haystack_integrations.components.embedders.sentence_transformers import SentenceTransformersDocumentEmbedder
 from haystack_integrations.components.retrievers.opensearch import OpenSearchHybridRetriever
 from haystack_integrations.document_stores.opensearch import OpenSearchDocumentStore
 
@@ -906,7 +956,6 @@ docs = [
 
 # Embed the documents and add them to the document store
 doc_embedder = SentenceTransformersDocumentEmbedder(model="sentence-transformers/all-MiniLM-L6-v2")
-doc_embedder.warm_up()
 docs = doc_embedder.run(docs)
 doc_store.write_documents(docs['documents'])
 
@@ -1042,6 +1091,22 @@ from_dict(data: dict[str, Any]) -> OpenSearchHybridRetriever
 
 Deserialize an OpenSearchHybridRetriever from a dictionary.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the synchronous resources of the underlying Document Store.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the asynchronous resources of the underlying Document Store.
+
 ## haystack_integrations.components.retrievers.opensearch.sql_retriever
 
 ### OpenSearchSQLRetriever
@@ -1105,6 +1170,22 @@ Deserializes the component from a dictionary.
 
 - <code>OpenSearchSQLRetriever</code> – Deserialized component.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the synchronous resources of the underlying Document Store.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the asynchronous resources of the underlying Document Store.
+
 #### run
 
 ```python
@@ -1319,6 +1400,22 @@ Deserializes the component from a dictionary.
 
 - <code>OpenSearchDocumentStore</code> – Deserialized component.
 
+#### close
+
+```python
+close() -> None
+```
+
+Release the associated synchronous resources.
+
+#### close_async
+
+```python
+close_async() -> None
+```
+
+Release the associated asynchronous resources.
+
 #### count_documents
 
 ```python