ppsingh commited on
Commit
d5ea7c9
·
1 Parent(s): f5c5048

update Readme info and Disclaimer

Browse files
README.md CHANGED
@@ -18,4 +18,59 @@ short_description: Ask any questions to the Audit reports
18
  license: apache-2.0
19
  ---
20
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
21
  Check out the configuration reference at: https://huggingface.co/docs/hub/spaces-config-reference
 
18
  license: apache-2.0
19
  ---
20
 
21
+ System Name: Audit Assistant
22
+ Provider / Supplier: GIZ Data Service Center
23
+ As of: July 2025
24
+
25
+
26
+ 1. General Description of the System
27
+ Audit Assistant is an AI-powered tool for exploring and understanding Uganda's audit reports. This tool leverages advanced language models to help you get clear and structured answers based on audit publications. It combines a generative language assistant with a knowledge base implemented via Retrieval-Augmented Generation (RAG).
28
+
29
+
30
+ 2. Model's Used
31
+ Generative LLM
32
+ - Model Name: [meta-llama/Llama-3.1-8B-Instruct](https://huggingface.co/meta-llama/Llama-3.1-8B-Instruct)
33
+ - Model Source API: [Nebius AI](https://studio.nebius.com/)
34
+
35
+ Retriever/Embedding
36
+ - Model Name: [BAAI/bge-m3](https://huggingface.co/BAAI/bge-m3)
37
+ - Model Source: Local Instance
38
+
39
+ Re-ranker:
40
+ - Model Name: [BAAI/bge-reranker-v2-m3](https://huggingface.co/BAAI/bge-reranker-v2-m3)
41
+ - Model Source: Local Instance
42
+
43
+
44
+
45
+ 3. Model Training Data
46
+ All the models mentioned above are being consumed, without any fine-tuning or trianing being performed by the developer team fo audit assistant tool. And hence there os no training data had been sued by the development team of Audit Assistant tool.
47
+
48
+
49
+ 4. Knowledge Base (Retrieval Component)
50
+ • Data Sources: Public, non-personal audit reports relased by [**Office of the Auditor General (OAG) of Uganda**](https://www.oag.go.ug/welcome)
51
+ • Embedding Model: [BAAI/bge-m3](https://huggingface.co/BAAI/bge-m3)
52
+ • Embedding Dimension: 1024
53
+ • Vector Database: Qdrant (via API)
54
+ • Framework: Langchain (custom RAG pipeline)
55
+ • Top-k: 5 relevant text segments per query
56
+
57
+ 5. System Limitations and Non-Purposes
58
+ • The system does not make autonomous decisions.
59
+ • No processing of personal data except for the usage statistics as mentioned in Disclaimer.
60
+ • Results are intended for orientation only – not for legal or political advice.
61
+
62
+ 6. Transparency Towards Users
63
+ • The user interface clearly indicates the use of a generative AI model.
64
+ • An explanation of the RAG method is included.
65
+ • Feedback mechanism available (via https://huggingface.co/spaces/GIZ/audit_assistant/discussions/new).
66
+
67
+ 7. Monitoring, Feedback, and Incident Reporting
68
+ • User can provide feedback via UI by giving (Thumbs-up or down to AI-Generated answer). alternatively for more detailed feedback please use https://huggingface.co/spaces/GIZ/audit_assistant/discussions/new to report any issue.
69
+ • Technical development is carried out by the GIZ Data Service Center.
70
+ • No automated bias detection – but low risk due to content restrictions.
71
+
72
+
73
+ 8. Contact
74
+ For any questions, please contact via https://huggingface.co/spaces/GIZ/audit_assistant/discussions/new or send us email to dataservicecenter@giz.de
75
+
76
  Check out the configuration reference at: https://huggingface.co/docs/hub/spaces-config-reference
app.py CHANGED
@@ -421,7 +421,8 @@ Hello, I am Audit Q&A, an AI-powered conversational assistant designed to help y
421
  If you dont select any then the Consolidated report is relied upon to answer your question.
422
  - **Examples**: We have curated some example questions,select a particular question from category of questions.
423
  - **Sources**: This tab will display the relied upon paragraphs from the report, to help you in assessing or fact checking if the answer provided by Audit Q&A assitant is correct or not.
424
- ⚠️ For limitations of the tool please check **Disclaimer** tab.
 
425
  """
426
 
427
 
@@ -677,17 +678,23 @@ with gr.Blocks(title="Audit Q&A", css= "style.css", theme=theme,elem_id = "main-
677
  with gr.Column(scale=1):
678
  gr.Markdown("""
679
  - This chatbot is intended for specific use of answering the questions based on audit reports published by OAG, for any use beyond this scope we have no liability to response provided by chatbot.
680
- - We do not guarantee the accuracy, reliability, or completeness of any information provided by the chatbot and disclaim any liability or responsibility for actions taken based on its responses.
681
  - The chatbot may occasionally provide inaccurate or inappropriate responses, and it is important to exercise judgment and critical thinking when interpreting its output.
 
682
  - The chatbot responses should not be considered professional or authoritative advice and are generated based on patterns in the data it has been trained on.
683
  - The chatbot's responses do not reflect the opinions or policies of our organization or its affiliates.
684
  - Any personal or sensitive information shared with the chatbot is at the user's own risk, and we cannot guarantee complete privacy or confidentiality.
685
- - the chatbot is not deterministic, so there might be change in answer to same question when asked by different users or multiple times.
 
 
 
 
 
 
686
  - By using this chatbot, you agree to these terms and acknowledge that you are solely responsible for any reliance on or actions taken based on its responses.
 
687
  - **This is just a prototype and being tested and worked upon, so its not perfect and may sometimes give irrelevant answers**. If you are not satisfied with the answer, please ask a more specific question or report your feedback to help us improve the system.
688
- """)
689
-
690
-
691
 
692
 
693
  def show_feedback(logs):
 
421
  If you dont select any then the Consolidated report is relied upon to answer your question.
422
  - **Examples**: We have curated some example questions,select a particular question from category of questions.
423
  - **Sources**: This tab will display the relied upon paragraphs from the report, to help you in assessing or fact checking if the answer provided by Audit Q&A assitant is correct or not.
424
+ ⚠️ For limitations of the tool and collection of usage statistics and data please check **Disclaimer** tab.
425
+ ⚠️ By using this app, you acknowledge that we collect usage statistics (such as question asked, feedback given, session duration and device type) to understand performance and continuously improve the tool, based on our legitimate interest in enhancing our services.
426
  """
427
 
428
 
 
678
  with gr.Column(scale=1):
679
  gr.Markdown("""
680
  - This chatbot is intended for specific use of answering the questions based on audit reports published by OAG, for any use beyond this scope we have no liability to response provided by chatbot.
681
+ - We have implemented measures to ensure the technical robustness and security of our AI system, minimizing unexpected behaviour, however we do not guarantee the full reliability, or completeness of any information provided by the chatbot and disclaim any liability or responsibility for actions taken based on its responses.
682
  - The chatbot may occasionally provide inaccurate or inappropriate responses, and it is important to exercise judgment and critical thinking when interpreting its output.
683
+ - The use of AI within this application is transparent. When interacting with the AI, users are informed that they are engaging with an AI system
684
  - The chatbot responses should not be considered professional or authoritative advice and are generated based on patterns in the data it has been trained on.
685
  - The chatbot's responses do not reflect the opinions or policies of our organization or its affiliates.
686
  - Any personal or sensitive information shared with the chatbot is at the user's own risk, and we cannot guarantee complete privacy or confidentiality.
687
+ - The chatbot is not deterministic, so there might be change in answer to same question when asked by different users or multiple times.
688
+ - When you use this app, we collect certain information to understand its usage, analyze performance, and continuously improve the tool for future use. This includes:
689
+ - The questions you ask
690
+ - The AI-generated answers
691
+ - Feedback given towards to each response (in form of Thumbs-up and Thumbs-down), if any.
692
+ - Usage statistics such as session duration and device type.
693
+ We process this data based on our legitimate interest in continually enhancing the quality, security, and usability of the Audit Q&A assistant
694
  - By using this chatbot, you agree to these terms and acknowledge that you are solely responsible for any reliance on or actions taken based on its responses.
695
+ - User can read more about the technical information about the tool in [Readme](https://huggingface.co/spaces/GIZ/audit_assistant/blob/main/README.md) of this tool.
696
  - **This is just a prototype and being tested and worked upon, so its not perfect and may sometimes give irrelevant answers**. If you are not satisfied with the answer, please ask a more specific question or report your feedback to help us improve the system.
697
+ """)
 
 
698
 
699
 
700
  def show_feedback(logs):
auditqa/__pycache__/__init__.cpython-310.pyc CHANGED
Binary files a/auditqa/__pycache__/__init__.cpython-310.pyc and b/auditqa/__pycache__/__init__.cpython-310.pyc differ
 
auditqa/__pycache__/process_chunks.cpython-310.pyc CHANGED
Binary files a/auditqa/__pycache__/process_chunks.cpython-310.pyc and b/auditqa/__pycache__/process_chunks.cpython-310.pyc differ
 
auditqa/__pycache__/reader.cpython-310.pyc CHANGED
Binary files a/auditqa/__pycache__/reader.cpython-310.pyc and b/auditqa/__pycache__/reader.cpython-310.pyc differ
 
auditqa/__pycache__/reports.cpython-310.pyc CHANGED
Binary files a/auditqa/__pycache__/reports.cpython-310.pyc and b/auditqa/__pycache__/reports.cpython-310.pyc differ
 
auditqa/__pycache__/retriever.cpython-310.pyc CHANGED
Binary files a/auditqa/__pycache__/retriever.cpython-310.pyc and b/auditqa/__pycache__/retriever.cpython-310.pyc differ
 
auditqa/__pycache__/sample_questions.cpython-310.pyc CHANGED
Binary files a/auditqa/__pycache__/sample_questions.cpython-310.pyc and b/auditqa/__pycache__/sample_questions.cpython-310.pyc differ
 
auditqa/__pycache__/utils.cpython-310.pyc CHANGED
Binary files a/auditqa/__pycache__/utils.cpython-310.pyc and b/auditqa/__pycache__/utils.cpython-310.pyc differ