mtyrrell commited on
Commit
ecf9255
·
1 Parent(s): 3ce59a7

guidance tab

Browse files
Files changed (1) hide show
  1. app.py +35 -0
app.py CHANGED
@@ -486,7 +486,42 @@ with gr.Blocks(title="Audit Q&A", css= "style.css", theme=theme,elem_id = "main-
486
 
487
  """)
488
 
 
 
 
 
489
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
490
  # static tab for disclaimer
491
  with gr.Tab("Disclaimer",elem_classes = "max-height other-tabs"):
492
  with gr.Row():
 
486
 
487
  """)
488
 
489
+ # ---- New Guidelines Tab ----
490
+ with gr.Tab("Guidelines", elem_classes="max-height other-tabs"):
491
+ gr.Markdown("""
492
+ # Guidelines
493
 
494
+ Welcome to Audit Q&A, your AI-powered assistant for exploring and understanding audit reports. This tool leverages advanced language models to help you get clear and structured answers based on audit publications.
495
+
496
+ ## Crafting Effective Prompts
497
+
498
+ - **Be Clear and Specific**: Clearly state your question and include details such as report type, year, or specific sections if applicable.
499
+ - **Provide Adequate Context**: Mention the report category or even specific subsections that could help the model better understand your question.
500
+ - **Avoid Ambiguity**: Use direct, focused language; for example, instead of asking "What are the findings?" try "What are the key findings regarding revenue compliance in the Kampala Region? (Note - it helps to combine this approach with filters - see below)"
501
+
502
+ ## Best Practices
503
+
504
+ - Start with a simple, focused question.
505
+ - Follow up with additional context if your initial query is too broad.
506
+ - Experiment with different phrasings to get the most accurate answers.
507
+ - Use the source citations as a reference to validate the provided information.
508
+
509
+ ## Utilizing Filters
510
+
511
+ - **Report Category & Subtype**: Use the "Reports" tab to choose your preferred report category and refine your query by selecting a specific sub-type. This will help narrow down the context for your question.
512
+ - **Year Selection**: Choose one or more years from the "Year" filter to target your query to specific time periods.
513
+ - **Specific Reports**: Optionally, select specific reports using the dropdown to focus on a particular document or set of documents.
514
+
515
+ ## Useful Resources
516
+
517
+ - Short Course: Generative AI for Everyone (3 hours) https://www.deeplearning.ai/courses/generative-ai-for-everyone/
518
+ - Short Course: Advanced Prompting with OpenAI O1 (1 hour) https://www.deeplearning.ai/courses/ai-for-everyone/
519
+ - Short Course: Introduction to AI with IBM (13 hours) https://www.coursera.org/learn/introduction-to-ai
520
+
521
+
522
+ Enjoy using Audit Q&A and happy prompting!
523
+ """)
524
+
525
  # static tab for disclaimer
526
  with gr.Tab("Disclaimer",elem_classes = "max-height other-tabs"):
527
  with gr.Row():