Added Error Check

App raises error when it does not detect date elements.

filterminutes.py

@@ -1,4 +1,6 @@
 import logging
+import gradio as gr
+import numpy as np
 
 log = logging.getLogger('filter methods')
 logging.basicConfig(level=logging.INFO)
@@ -57,15 +59,23 @@ def search_with_filter(vector_store, query, filter_dict, target_k=5, init_k=100,
         step : int
             The size of the step when enlarging the search.
 
-    Returns: List of at least target_k Documents for post-processing
+    Returns: List of at least target_k Documents for post-processing.
 
     """
     context = filter_docs_by_meta(vector_store.similarity_search(query, k=init_k), filter_dict)
-    while len(context) < target_k:
+    len_docs_begin = len(context)
+    if len_docs_begin >= target_k:
+        log.info(f'Initial search contains {len_docs_begin} Documents. Expansion not required. ')
+        return context
+    CUT_THE_LOOP_N = 10
+    for top_k_docs in np.arange(init_k, CUT_THE_LOOP_N * init_k, step):
         log.info(f'Context contains {len(context)} documents')
-        log.info(f'Expanding search with k={init_k}')
-        init_k += step
-        context = filter_docs_by_meta(vector_store.similarity_search(query, k=init_k), filter_dict)
-    log.info(f'Done. Context contains {len(context)} Documents matching the filtering criteria')
+        log.info(f'Expanding search with k={top_k_docs}')
+        context = filter_docs_by_meta(vector_store.similarity_search(query, k=int(top_k_docs)), filter_dict)
+        if len(context) == target_k:
+            log.info(f'Success. Context contains {len(context)} Documents matching the filtering criteria')
+            return context
+    log.info(f'Failed to reach target number of documents after {CUT_THE_LOOP_N} loops,'
+             f' context contains {len(context)} Documents matching the filtering criteria')
     return context
 

public_app.py

@@ -1,4 +1,5 @@
 import logging
+import os
 
 from langchain import PromptTemplate, LLMChain
 from langchain.chains.question_answering import load_qa_chain
@@ -32,7 +33,7 @@ def load_chains(open_ai_key):
     return date_extractor, fed_chain
 
 
-def get_chain(query, api_key):
+def get_chain(query, api_key=os.environ['OPENAI_API_KEY']):
     """
     Detects the date, computes similarity, and answers the query using
     only documents corresponding to the date requested.
@@ -51,34 +52,39 @@ def get_chain(query, api_key):
     date_extractor, fed_chain = load_chains(api_key)
     logging.info('Extracting the date in numeric format..')
     date_response = date_extractor.run(query)
-    if date_response != 'False':
+    if date_response == 'False':
+        logging.info('No date elements found. Running the qa without filtering can output incorrect results.')
+        raise gr.Error('No date elements found. Please include temporal references in in your query.')
+    else:
         filter_date = json.loads(date_response)
-
         logging.info(f'Date parameters retrieved: {filter_date}')
         logging.info('Running the qa with filtered context..')
         filtered_context = search_with_filter(vs, query, init_k=200, step=300, target_k=7, filter_dict=filter_date)
-
         logging.info(20 * '-' + 'Metadata for the documents to be used' + 20 * '-')
         for doc in filtered_context:
             logging.info(doc.metadata)
-    else:
-        logging.info('No date elements found. Running the qa without filtering can output incorrect results.')
-        filtered_context = vs.similarity_search(query, k=7)
     return fed_chain({'input_documents': filtered_context[:7], 'question': query})['output_text']
 
 
 if __name__ == '__main__':
     app = gr.Interface(fn=get_chain,
-                        inputs=[gr.Textbox(lines=2, placeholder="Enter your query", label='Your query'),
-                                gr.Textbox(lines=1, placeholder="Your OpenAI API key here", label='OpenAI Key')],
-                        description='Query the public database in FRED from 1936-2023',
-                        outputs=gr.Textbox(lines=1,  label='Answer'),
-                        title='Chat with the FOMC meeting minutes',
-                        examples=[['What was the economic outlook from the staff presented in the meeting '
-                                   'of April 2009 with respect to labour market developments and industrial production?'],
-                                   ['Who were the voting members present in the meeting on March 2010?'],
-                                   ['How important was the pandemic of Covid-19 in the discussions during 2020?'],
-                                   ['What was the impact of the oil crisis for the economic outlook during 1973?']],
-                       cache_examples=False
-                        )
+                       inputs=[gr.Textbox(lines=2, placeholder="Enter your query", label='Your query'),
+                               gr.Textbox(lines=1, placeholder="Your OpenAI API key here", label='OpenAI Key')],
+                       description='Here, you can query the [minutes](www.federalreserve.gov) of the Federal '
+                                   'Open Market Committee meetings from March 1936 to May 2023. Click the examples'
+                                   ' below to see an illustration of the tool in action.',
+                       article='**Disclaimer**: This app is for demonstration purposes only, and it may take some '
+                               'time to load'
+                               'during periods of heavy load',
+                       analytics_enabled=True,
+                       outputs=gr.Textbox(lines=1, label='Answer'),
+                       title='Chat with the FOMC meeting minutes',
+                       examples=[['What was the economic outlook from the staff presented in the meeting '
+                                  'of April 2009 with respect to labour market developments and industrial production?'],
+                                 ['Who were the voting members present in the meeting on March 2010?'],
+                                 ['How important was the pandemic of Covid-19 in the discussions during 2020?'],
+                                 ['What was the impact of the oil crisis for the economic outlook during 1973?']],
+                       cache_examples=True
+                       )
+    app.queue()
     app.launch()