From 1926cbd5fe8b195808d62c8c08e6accd62a0f83d Mon Sep 17 00:00:00 2001
From: agnieszka-m <amarzec13@gmail.com>
Date: Mon, 5 Aug 2024 13:03:56 +0200
Subject: [PATCH] Update docstrings

---
 .../opensearch/embedding_retriever.py         | 35 ++++++++++---------
 1 file changed, 19 insertions(+), 16 deletions(-)

diff --git a/integrations/opensearch/src/haystack_integrations/components/retrievers/opensearch/embedding_retriever.py b/integrations/opensearch/src/haystack_integrations/components/retrievers/opensearch/embedding_retriever.py
index eba5596f2..7f3d4cbf8 100644
--- a/integrations/opensearch/src/haystack_integrations/components/retrievers/opensearch/embedding_retriever.py
+++ b/integrations/opensearch/src/haystack_integrations/components/retrievers/opensearch/embedding_retriever.py
@@ -16,9 +16,9 @@
 @component
 class OpenSearchEmbeddingRetriever:
     """
-    Uses a vector similarity metric to retrieve documents from the OpenSearchDocumentStore.
+    Retrieves documents from the OpenSearchDocumentStore using a vector similarity metric.
 
-    Needs to be connected to the OpenSearchDocumentStore to run.
+     Must be connected to the OpenSearchDocumentStore to run.
     """
 
     def __init__(
@@ -34,12 +34,14 @@ def __init__(
         """
         Create the OpenSearchEmbeddingRetriever component.
 
-        :param document_store: An instance of OpenSearchDocumentStore.
-        :param filters: Filters applied to the retrieved Documents. Defaults to None.
-            Filters are applied during the approximate kNN search to ensure that top_k matching documents are returned.
-        :param top_k: Maximum number of Documents to return, defaults to 10
-        :param filter_policy: Policy to determine how filters are applied.
-        :param custom_query: The query containing a mandatory `$query_embedding` and an optional `$filters` placeholder
+        :param document_store: An instance of OpenSearchDocumentStore to use with the Retriever.
+        :param filters: Filters applied when fetching documents from the document store.
+            Filters are applied during the approximate kNN search to ensure the Retriever returns `top_k` matching documents.
+        :param top_k: Maximum number of documents to return.
+        :param filter_policy: Policy to determine how filters are applied. Possible options:
+        - `merge`: Runtime filters are merged with initialization filters.
+        - `replace`: Runtime filters replace initialization filters. Use this policy to change the filtering scope.
+        :param custom_query: The custom OpenSearch query containing a mandatory `$query_embedding` and an optional `$filters` placeholder.
 
             **An example custom_query:**
 
@@ -63,14 +65,15 @@ def __init__(
             }
             ```
 
-        **For this custom_query, a sample `run()` could be:**
+        For this `custom_query`, an example `run()` could be:
 
         ```python
         retriever.run(query_embedding=embedding,
                         filters={"years": ["2019"], "quarters": ["Q1", "Q2"]})
         ```
         :param raise_on_failure:
-            Whether to raise an exception if the API call fails. Otherwise log a warning and return an empty list.
+            If `True`, raises an exception if the API call fails.
+            If `False`, logs a warning and returns an empty list.
 
         :raises ValueError: If `document_store` is not an instance of OpenSearchDocumentStore.
         """
@@ -137,11 +140,11 @@ def run(
         Retrieve documents using a vector similarity metric.
 
         :param query_embedding: Embedding of the query.
-        :param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
-                        the `filter_policy` chosen at retriever initialization. See init method docstring for more
-                        details.
-        :param top_k: Maximum number of Documents to return.
-        :param custom_query: The query containing a mandatory `$query_embedding` and an optional `$filters` placeholder
+        :param filters: Filters applied when fetching documents from the document store.
+            Filters are applied during the approximate kNN search to ensure the Retriever returns `top_k` matching documents.
+            The way runtime filters are applied depends on the `filter_policy` selected when initializing the Retriever.
+        :param top_k: Maximum number of documents to return.
+        :param custom_query: A custom OpenSearch query containing a mandatory `$query_embedding` and an optional `$filters` placeholder.
 
             **An example custom_query:**
 
@@ -165,7 +168,7 @@ def run(
             }
             ```
 
-        **For this custom_query, a sample `run()` could be:**
+        For this `custom_query`, an example `run()` could be:
 
         ```python
         retriever.run(query_embedding=embedding,