added doc string to function rerank and gen_augmented_prompt_via_websearch

utils.py

@@ -69,8 +69,8 @@ def gen_augmented_prompt_via_websearch(
     vendor,
     n_crawl,
     top_k,
-    pre_context,
-    post_context,
+    pre_context="",
+    post_context="",
     pre_prompt="",
     post_prompt="",
     pass_prev=False,
@@ -78,24 +78,25 @@ def gen_augmented_prompt_via_websearch(
     chunk_size=512,
 ):
     """
-
+    Generates an augmented prompt and a list of links by performing a web search and reranking the results.
 
     Args:
-        prompt (str, required):
-        vendor ('Google'|'Bing'): enum
-        n_crawl (int): _description_
-        top_k (int): _description_
-        pre_context (str): _description_
-        post_context (str): _description_
-        pre_prompt (str, optional): _description_. Defaults to "".
-        post_prompt (str, optional): _description_. Defaults to "".
-        pass_prev (bool, optional): _description_. Defaults to False.
-        prev_output (str, optional): _description_. Defaults to "".
-        chunk_size (int, optional): _description_. Defaults to 512.
+        prompt (str, required): The prompt for the web search.
+        vendor (str): The search engine to use, either 'Google' or 'Bing'.
+        n_crawl (int): The number of search results to retrieve.
+        top_k (int): The number of top reranked results to return.
+        pre_context (str): The pre-context to be included in the augmented prompt.
+        post_context (str): The post-context to be included in the augmented prompt.
+        pre_prompt (str, optional): The pre-prompt to be included in the augmented prompt. Defaults to "".
+        post_prompt (str, optional): The post-prompt to be included in the augmented prompt. Defaults to "".
+        pass_prev (bool, optional): Whether to include the previous output in the augmented prompt. Defaults to False.
+        prev_output (str, optional): The previous output to be included in the augmented prompt. Defaults to "".
+        chunk_size (int, optional): The size of each chunk for reranking. Defaults to 512.
 
     Returns:
-        _type_: _description_
+        tuple: A tuple containing the augmented prompt and a list of links.
     """
+
     search_results = []
     if vendor == "Google":
         search_results = googleSearchClient.search(prompt, n_crawl)