File size: 9,649 Bytes
9be2851
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
# Grocify Chat Agent - API Test Examples

This file contains example API requests for testing the Grocify Chat Agent.

## Base URL

- Local: `http://localhost:8000`
- Production: `https://your-space-url.hf.space`

---

## 1. Health Check

### GET /

```bash

curl -X GET "http://localhost:8000/"

```

**Expected Response:**
```json

{

  "service": "Grocify Chat Agent",

  "version": "2.0.0",

  "status": "healthy",

  "features": {

    "rag": true,

    "tool_calling": true,

    "voice": true,

    "multilingual": true,

    "sentiment_analysis": true

  }

}

```

---

## 2. Simple Chat

### POST /chat

```bash

curl -X POST "http://localhost:8000/chat" \

  -H "Content-Type: application/json" \

  -d '{

    "user_message": "Hello! I need help with my order",

    "locale": "en-IN"

  }'

```

**Expected Response:**
```json

{

  "session_id": "generated-uuid",

  "response": {

    "reply_text": "Hello! I'd be happy to help you with your order...",

    "confidence": 0.85,

    "sources": [],

    "actions": [],

    "structured_response": null,

    "escalation": null

  },

  "timestamp": "2025-10-15T10:30:00Z"

}

```

---

## 3. Product Search

### POST /chat

```bash

curl -X POST "http://localhost:8000/chat" \

  -H "Content-Type: application/json" \

  -d '{

    "user_message": "Find Diwali gifts under 3000 for someone who likes skincare",

    "locale": "en-IN"

  }'

```

**Expected Response:**
```json

{

  "session_id": "uuid",

  "response": {

    "reply_text": "I found 3 great Diwali gift options for skincare lovers under ₹3000...",

    "confidence": 0.92,

    "sources": [

      {

        "id": "doc_1",

        "title": "Product Catalog",

        "location": "vector_db"

      }

    ],

    "actions": [

      {

        "tool_name": "product_search",

        "tool_input": {

          "query": "skincare",

          "max_price": 3000,

          "tags": ["gifting", "diwali"]

        }

      }

    ],

    "structured_response": {

      "type": "product_carousel",

      "items": [

        {

          "id": "SKIN002",

          "title": "Organic Skincare Gift Set",

          "price": 1899,

          "currency": "INR",

          "image": "https://example.com/skincare.jpg",

          "cta": "View details",

          "url": "https://grocify.com/products/SKIN002"

        }

      ]

    }

  }

}

```

---

## 4. Order Tracking

### POST /chat

```bash

curl -X POST "http://localhost:8000/chat" \

  -H "Content-Type: application/json" \

  -d '{

    "user_message": "Where is my order #12345?",

    "session_id": "existing-session-id",

    "locale": "en-IN"

  }'

```

**Expected Response:**
```json

{

  "session_id": "existing-session-id",

  "response": {

    "reply_text": "Your order #12345 is currently Out for Delivery...",

    "confidence": 0.95,

    "structured_response": {

      "type": "order_card",

      "order_id": "12345",

      "status": "Out for Delivery",

      "eta": "Oct 18, 2025, 2:00 PM IST",

      "tracking_url": "https://carrier/track/DLV123"

    }

  }

}

```

---

## 5. Coupon Validation

### POST /chat

```bash

curl -X POST "http://localhost:8000/chat" \

  -H "Content-Type: application/json" \

  -d '{

    "user_message": "Is coupon DIWALI25 valid?",

    "locale": "en-IN"

  }'

```

**Expected Response:**
```json

{

  "response": {

    "reply_text": "Yes! Coupon DIWALI25 is valid and gives you 25% off on all products. It expires on October 30, 2025.",

    "confidence": 0.98,

    "structured_response": {

      "type": "promotion_card",

      "coupon": "DIWALI25",

      "discount": "25% off",

      "description": "Valid on all products",

      "expires": "2025-10-30",

      "cta": "Apply Coupon"

    }

  }

}

```

---

## 6. Escalation Trigger

### POST /chat

```bash

curl -X POST "http://localhost:8000/chat" \

  -H "Content-Type: application/json" \

  -d '{

    "user_message": "I want to speak to a human agent",

    "locale": "en-IN"

  }'

```

**Expected Response:**
```json

{

  "response": {

    "reply_text": "I understand you'd like to speak with someone. Let me connect you with one of our team members...",

    "confidence": 0.9,

    "escalation": {

      "escalate": true,

      "queue": "support",

      "priority": "normal",

      "agent_brief": {

        "summary": "Escalation triggered: explicit_request...",

        "user_identifiers": {

          "session_id": "uuid",

          "locale": "en-IN"

        },

        "suggested_actions": [

          "Review conversation history",

          "Verify user identity"

        ]

      }

    }

  }

}

```

---

## 7. Multilingual (Hindi)

### POST /chat

```bash

curl -X POST "http://localhost:8000/chat" \

  -H "Content-Type: application/json" \

  -d '{

    "user_message": "मुझे अपने ऑर्डर की जानकारी चाहिए",

    "locale": "hi-IN"

  }'

```

---

## 8. Get Session Details

### GET /session/{session_id}



```bash

curl -X GET "http://localhost:8000/session/abc123"

```



**Expected Response:**

```json

{

  "session_id": "abc123",
  "user_id": null,

  "created_at": "2025-10-15T10:00:00Z",
  "updated_at": "2025-10-15T10:30:00Z",

  "conversation": [

    {

      "role": "user",

      "content": "Hello",

      "timestamp": "2025-10-15T10:00:00Z"

    },

    {

      "role": "assistant",

      "content": "Hello! How can I help you?",

      "timestamp": "2025-10-15T10:00:05Z"

    }

  ],

  "escalation_count": 0,
  "failed_attempts": 0

}

```



---



## 9. Delete Session



### DELETE /session/{session_id}

```bash

curl -X DELETE "http://localhost:8000/session/abc123"

```

**Expected Response:**
```json

{

  "message": "Session deleted successfully",

  "session_id": "abc123"

}

```

---

## 10. List Available Tools

### GET /tools

```bash

curl -X GET "http://localhost:8000/tools"

```

**Expected Response:**
```json

{

  "tools": [

    {

      "name": "product_search",

      "description": "Search product catalog with filters like categories, tags, price range"

    },

    {

      "name": "order_lookup",

      "description": "Retrieve order status, tracking info, and ETA"

    },

    {

      "name": "promotions_check",

      "description": "Validate coupon codes and check promotion eligibility"

    },

    {

      "name": "sentiment_analysis",

      "description": "Analyze sentiment and emotion in user messages"

    },

    {

      "name": "crm_query",

      "description": "Retrieve user profile and history from CRM"

    }

  ]

}

```

---

## 11. Get Configuration

### GET /config

```bash

curl -X GET "http://localhost:8000/config"

```

**Expected Response:**
```json

{

  "llm_model": "gemini-2.0-flash",

  "supported_locales": ["en-IN", "hi-IN", "ta-IN", "te-IN", "mr-IN"],

  "default_locale": "en-IN",

  "features": {

    "voice": true,

    "sentiment_analysis": true,

    "tool_calling": true,

    "auto_translation": true

  }

}

```

---

## 12. Add Documents to Knowledge Base

### POST /documents/add

```bash

curl -X POST "http://localhost:8000/documents/add" \

  -F "file=@new_faq.txt"

```

**Expected Response:**
```json

{

  "message": "Documents added successfully",

  "filename": "new_faq.txt",

  "chunks_added": 15

}

```

---

## Testing Tips

1. **Save Session ID**: Reuse the `session_id` from responses to maintain conversation context

2. **Test Edge Cases**: 
   - Invalid order IDs
   - Expired coupons
   - Out of stock products
   - Empty messages

3. **Test Multilingual**:
   - Send messages in different languages
   - Verify language detection
   - Check response translations

4. **Monitor Confidence**:
   - Low confidence (<0.5) may trigger escalation
   - High confidence (>0.8) indicates good understanding

5. **Test Structured Responses**:
   - Product searches should return carousels
   - Order queries should return order cards
   - Escalations should include agent brief

---

## Python Testing Script

```python

import requests

import json



BASE_URL = "http://localhost:8000"



def test_chat(message, session_id=None):

    payload = {

        "user_message": message,

        "locale": "en-IN"

    }

    if session_id:

        payload["session_id"] = session_id

    

    response = requests.post(f"{BASE_URL}/chat", json=payload)

    return response.json()



# Test simple chat

result = test_chat("Hello!")

print(json.dumps(result, indent=2))



# Test with session

session_id = result["session_id"]

result2 = test_chat("Find gifts under 2000", session_id)

print(json.dumps(result2, indent=2))

```

---

## JavaScript/Node.js Testing Script

```javascript

const axios = require('axios');



const BASE_URL = 'http://localhost:8000';



async function testChat(message, sessionId) {

  const payload = {

    user_message: message,

    locale: 'en-IN'

  };

  

  if (sessionId) {

    payload.session_id = sessionId;

  }

  

  const response = await axios.post(`${BASE_URL}/chat`, payload);

  return response.data;

}



// Test

(async () => {

  const result = await testChat('Hello!');

  console.log(JSON.stringify(result, null, 2));

  

  const sessionId = result.session_id;

  const result2 = await testChat('Find gifts under 2000', sessionId);

  console.log(JSON.stringify(result2, null, 2));

})();

```

---

For more examples and integration patterns, see [INTEGRATION_GUIDE.md](./INTEGRATION_GUIDE.md)