Ubik80 commited on
Commit
c17e7d9
·
verified ·
1 Parent(s): 9d0f14d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +24 -1
README.md CHANGED
@@ -10,4 +10,27 @@ pinned: false
10
  short_description: A smolagent-powered assistant - FAQs in a fintech company
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  short_description: A smolagent-powered assistant - FAQs in a fintech company
11
  ---
12
 
13
+
14
+ This project is a smart FAQ assistant powered by [SmolAgents](https://github.com/hwchase17/smol-agent) and Langchain.
15
+ It is designed to simulate a realistic use case in a **fintech company**, providing:
16
+
17
+ - Context-aware answers to internal FAQs
18
+ - Hybrid reasoning: Retrieval-Augmented Generation + web search
19
+ - Real-time observability and traceability with Langfuse
20
+ - Access to Hugging Face and OpenAI APIs
21
+
22
+ 🚀 Built with `gradio`, this assistant can be queried directly in-browser.
23
+
24
+ ---
25
+
26
+ ## How it works
27
+
28
+ 1. Internal documents (FAQs) are indexed with BM25 for fast lookup
29
+ 2. The agent (CodeAgent) uses tools like:
30
+ - `faq_retriever` for internal knowledge
31
+ - `web_search` for latest external info
32
+ 3. Langfuse tracks every run, tool call, and cost
33
+ 4. Hugging Face Hub APIs are used to serve and deploy the model
34
+
35
+ > This project is great for developers who want to learn how to build real-world, agentic applications using open-source tools and minimal code.
36
+