doc: add example function calling requests

HeyPuter · Jan 24, 2025 · db9597a · db9597a
1 parent aae18e6
commit db9597a
Showing 1 changed file with 77 additions and 1 deletion.
diff --git a/src/backend/src/modules/puterai/doc/requests.md b/src/backend/src/modules/puterai/doc/requests.md
@@ -59,4 +59,80 @@ URL.createObjectURL(await (await fetch("http://api.puter.localhost:4100/drivers/
   }),
   "method": "POST",
 })).blob());
-```
+```
+
+### Tool Use
+
+```javascript
+await puter.ai.chat('What\'s the weather like in Vancouver?', {
+    tools: [
+        {
+            type: 'function',
+            'function': {
+                name: 'get_weather',
+                description: 'A string describing the weather',
+                parameters: {
+                    type: 'object',
+                    properties: {
+                        location: {
+                            type: 'string',
+                            description: 'city',
+                        },
+                    },
+                    required: ['location'],
+                    additionalProperties: false,
+                },
+                strict: true
+            },
+        }
+    ]
+})
+```
+
+```javascript
+await puter.ai.chat([
+    { content: `What's the weather like in Vancouver?` },
+    {
+            "role": "assistant",
+            "content": null,
+            "tool_calls": [
+                {
+                    "id": "call_vcfEOmDczXq7KGMirPGGiNEe",
+                    "type": "function",
+                    "function": {
+                        "name": "get_weather",
+                        "arguments": "{\"location\":\"Vancouver\"}"
+                    }
+                }
+            ],
+            "refusal": null
+    },
+    {
+        role: 'tool',
+        tool_call_id: 'call_vcfEOmDczXq7KGMirPGGiNEe',
+        content: 'Sunny with a chance of rain'
+    },
+], {
+    tools: [
+        {
+            type: 'function',
+            'function': {
+                name: 'get_weather',
+                description: 'A string describing the weather',
+                parameters: {
+                    type: 'object',
+                    properties: {
+                        location: {
+                            type: 'string',
+                            description: 'city',
+                        },
+                    },
+                    required: ['location'],
+                    additionalProperties: false,
+                },
+                strict: true
+            },
+        }
+    ]
+})
+```