Aasher commited on
Commit
e2137c4
·
1 Parent(s): 14f5f58

Add a Readme file and a License

Browse files
Files changed (2) hide show
  1. .github/README.md +44 -0
  2. LICENSE +19 -0
.github/README.md ADDED
@@ -0,0 +1,44 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Gem - Your Shopping Agent
2
+
3
+ **Gem** is an intelligent, friendly, and personalized AI shopping agent designed to help you find the perfect products on Amazon. Engage in a natural conversation, and Gem will guide you through the shopping process with smart recommendations, advanced filtering, and a personalized touch.
4
+
5
+ This project is built using the **[Agno](https://github.com/agno-agi/agno)** framework, which provides a production-ready runtime called **AgentOS** to manage and serve the AI agent securely.
6
+
7
+ ## Frontend UI
8
+
9
+ This repository contains the **backend service** for the Gem Agent. The official chat interface for interacting with the agent is available in a separate repository.
10
+
11
+ ➡️ **[GemAI Frontend Repository](https://github.com/aasherkamal216/GemAI_Frontend)**
12
+
13
+ ## Features
14
+
15
+ - **Conversational Search:** Simply chat with Gem about what you're looking for. No more rigid keyword searches.
16
+ - **Visual Search:** Upload images and let Gem find similar products on Amazon.
17
+ - **Advanced Filtering:** Effortlessly narrow down results by price range, category, ratings, best-sellers, and active deals.
18
+ - **Intelligent Reranking:** Uses Cohere's state-of-the-art reranking model to sort products based on true relevance to your query, not just keywords.
19
+ - **Personalized Experience:** Gem remembers your preferences across conversations, providing a tailored shopping journey every time.
20
+ - **Secure & Scalable:** Built on **AgentOS**, which runs as a secure FastAPI application within your own infrastructure.
21
+ - **Dockerized:** Fully containerized for easy, consistent, and reproducible deployment anywhere.
22
+
23
+ ## How It Works
24
+
25
+ The agent follows a sophisticated workflow to deliver highly relevant product recommendations:
26
+
27
+ 1. **User Interaction**: A user sends a request (e.g., "I need running shoes under $100") from the frontend to the secure AgentOS API endpoint.
28
+ 2. **Agent Processing**: The request is routed to the `shopping-agent`, which is powered by **Google Gemini**. The agent analyzes the user's intent based on its core instructions (`app/prompts.py`).
29
+ 3. **Tool Execution**: The agent identifies the need to search for products and calls the `fetch_products` tool.
30
+ 4. **Product Search**: The tool queries a **RapidAPI Amazon Search** endpoint to retrieve a list of candidate products.
31
+ 5. **Relevance Reranking**: The initial results are passed to the **Cohere Rerank** model. This step is crucial, as it re-orders the products to prioritize those that are most semantically relevant to the user's specific query.
32
+ 6. **Memory & Context**: The agent uses a **Groq-powered Memory Manager** with a **Redis** backend to recall user preferences (e.g., "user prefers Nike") and maintain conversation history.
33
+ 7. **Response Generation**: The Gemini model synthesizes the reranked product data and its memory to generate a friendly, conversational response, highlighting the best options and asking clarifying questions.
34
+
35
+ ## Tech Stack
36
+
37
+ - **Framework:** [Agno](https://github.com/agno-agi/agno)
38
+ - **Core LLM:** Google Gemini (`gemini-2.5-flash`)
39
+ - **Memory Manager LLM:** Groq (`openai/gpt-oss-120b`)
40
+ - **Reranking Model:** Cohere (`rerank-v3.5`)
41
+ - **Backend Server:** FastAPI (via AgentOS)
42
+ - **Database:** Redis (for session history and agentic memory)
43
+ - **Containerization:** Docker
44
+ - **Product Search API:** Amazon Search via RapidAPI
LICENSE ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Copyright (c) 2025 Aasher Kamal
2
+
3
+ All Rights Reserved.
4
+
5
+ NOTICE TO USER: This is a proprietary software product protected by copyright laws.
6
+ The software is provided for specific, authorized use only.
7
+
8
+ Permission is not granted to any person obtaining a copy of this software and
9
+ associated documentation files (the "Software") to use, copy, modify, merge,
10
+ publish, distribute, sublicense, and/or sell copies of the Software.
11
+
12
+ Any unauthorized use, reproduction, modification, or distribution of this Software
13
+ is strictly prohibited and may result in severe civil and criminal penalties, and
14
+ will be prosecuted to the maximum extent possible under the law.
15
+
16
+ The above copyright notice and this permission notice shall be included in all
17
+ copies or substantial portions of the Software where applicable.
18
+
19
+ For all licensing inquiries, please contact aasherkamal786@gmail.com