Naoufal CHABAA commited on
Commit
480e442
Β·
1 Parent(s): 0199a4f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +63 -0
README.md CHANGED
@@ -14,3 +14,66 @@ tags:
14
  - tool
15
  - agent-course
16
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  - tool
15
  - agent-course
16
  ---
17
+
18
+ # Web Search Agent
19
+
20
+ A powerful AI-powered web agent that can search the web, summarize webpages, and provide time information across different timezones.
21
+
22
+ ## πŸš€ Demo
23
+
24
+ Try out the live demo on Hugging Face Spaces:
25
+ [Web Agent Demo](https://huggingface.co/spaces/naoufalcb/web_agent)
26
+
27
+ ## ✨ Features
28
+
29
+ - πŸ” Web Search: Search the internet using DuckDuckGo
30
+ - πŸ“ Webpage Summarization: Get concise summaries of web content
31
+ - πŸ•’ Timezone Information: Get current time in any timezone
32
+ - πŸ€– AI-Powered Responses: Using Azure's LLama model for intelligent interactions
33
+ - πŸ–₯️ User-Friendly Interface: Built with Gradio for easy interaction
34
+
35
+ ## πŸ› οΈ Installation
36
+
37
+ 1. Clone the repository
38
+ 2. Install the required dependencies:
39
+ ```bash
40
+ pip install -r requirements.txt
41
+ ```
42
+
43
+ 3. Create a `.env` file based on `.env.example` and add your Azure API credentials:
44
+ ```env
45
+ AZURE_ENDPOINT=your_endpoint
46
+ AZURE_API_KEY=your_api_key
47
+ ```
48
+
49
+ ## 🚦 Usage
50
+
51
+ Run the application:
52
+ ```bash
53
+ python app.py
54
+ ```
55
+
56
+ The web interface will be available at `http://localhost:7860`
57
+
58
+ ## πŸ”§ Tools Available
59
+
60
+ The agent comes with several built-in tools:
61
+
62
+ 1. **Web Search**: Search the internet using DuckDuckGo
63
+ 2. **Webpage Summarizer**: Get summaries of web content
64
+ 3. **Timezone Tool**: Get current time in any timezone
65
+ 4. **Final Answer Tool**: Provides conclusive responses to queries
66
+
67
+ ## 🀝 Contributing
68
+
69
+ Contributions are welcome! Please feel free to submit a Pull Request.
70
+
71
+ ## πŸ“ License
72
+
73
+ This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
74
+
75
+ ## πŸ”— References
76
+
77
+ - Built with [Gradio](https://gradio.app/)
78
+ - Uses [SmoLAgents](https://github.com/huggingface/smol-ai-agents) framework
79
+ - Azure AI for inference