Fix errors and improve Doc (#143)

* Fix link issues and add icons

* Improve Doc

* fix test

* making minor modifications to shuguangs' doc changes

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
Co-authored-by: Adil Hafeez <adil@katanemo.com>

docs/source/build_with_arch/includes/agent/function-calling-agent.yaml

@@ -1,39 +1,36 @@
-version: "0.1-beta"
+version: v0.1
+
 listen:
-  address: 127.0.0.1 | 0.0.0.0
-  port_value: 8080 #If you configure port 443, you'll need to update the listener with tls_certificates
-
-system_prompt: |
-  You are a network assistant that just offers facts; not advice on manufacturers or purchasing decisions.
+  address: 0.0.0.0 # or 127.0.0.1
+  port: 10000
+  # Defines how Arch should parse the content from application/json or text/pain Content-type in the http request
+  message_format: huggingface
 
+# Centralized way to manage LLMs, manage keys, retry logic, failover and limits in a central way
 llm_providers:
-  - name: "OpenAI"
-    provider: "openai"
+  - name: OpenAI
+    provider: openai
     access_key: OPENAI_API_KEY
     model: gpt-4o
+    default: true
     stream: true
 
+# default system prompt used by all prompt targets
+system_prompt: You are a network assistant that just offers facts; not advice on manufacturers or purchasing decisions.
+
 prompt_targets:
   - name: reboot_devices
-    description: >
-      This prompt target handles user requests to reboot devices.
-      It ensures that when users request to reboot specific devices or device groups, the system processes the reboot commands accurately.
-
-      **Examples of user prompts:**
-
-      - "Please reboot device 12345."
-      - "Restart all devices in tenant group tenant-XYZ
-      - "I need to reboot devices A, B, and C."
+    description: Reboot specific devices or device groups
 
     path: /agent/device_reboot
     parameters:
-      - name: "device_ids"
-        type: list  # Options: integer | float | list | dictionary | set
-        description: "A list of device identifiers (IDs) to reboot."
+      - name: device_ids
+        type: list
+        description: A list of device identifiers (IDs) to reboot.
         required: false
-      - name: "device_group"
-        type: string  # Options: string | integer | float | list | dictionary | set
-        description: "The name of the device group to reboot."
+      - name: device_group
+        type: str
+        description: The name of the device group to reboot
         required: false
 
 # Arch creates a round-robin load balancing between different endpoints, managed via the cluster subsystem.
@@ -42,6 +39,6 @@ endpoints:
     # value could be ip address or a hostname with port
     # this could also be a list of endpoints for load balancing
     # for example endpoint: [ ip1:port, ip2:port ]
-    endpoint: "127.0.0.1:80"
+    endpoint: 127.0.0.1:80
     # max time to wait for a connection to be established
     connect_timeout: 0.005s

docs/source/build_with_arch/includes/agent/parameter_handling.py

@@ -2,7 +2,8 @@ from flask import Flask, request, jsonify
 
 app = Flask(__name__)
 
-@app.route('/agent/device_summary', methods=['POST'])
+
+@app.route("/agent/device_summary", methods=["POST"])
 def get_device_summary():
     """
     Endpoint to retrieve device statistics based on device IDs and an optional time range.
@@ -10,14 +11,16 @@ def get_device_summary():
     data = request.get_json()
 
     # Validate 'device_ids' parameter
-    device_ids = data.get('device_ids')
+    device_ids = data.get("device_ids")
     if not device_ids or not isinstance(device_ids, list):
-        return jsonify({'error': "'device_ids' parameter is required and must be a list"}), 400
+        return jsonify(
+            {"error": "'device_ids' parameter is required and must be a list"}
+        ), 400
 
     # Validate 'time_range' parameter (optional, defaults to 7)
-    time_range = data.get('time_range', 7)
+    time_range = data.get("time_range", 7)
     if not isinstance(time_range, int):
-        return jsonify({'error': "'time_range' must be an integer"}), 400
+        return jsonify({"error": "'time_range' must be an integer"}), 400
 
     # Simulate retrieving statistics for the given device IDs and time range
     # In a real application, you would query your database or external service here
@@ -25,17 +28,16 @@ def get_device_summary():
     for device_id in device_ids:
         # Placeholder for actual data retrieval
         stats = {
-            'device_id': device_id,
-            'time_range': f'Last {time_range} days',
-            'data': f'Statistics data for device {device_id} over the last {time_range} days.'
+            "device_id": device_id,
+            "time_range": f"Last {time_range} days",
+            "data": f"Statistics data for device {device_id} over the last {time_range} days.",
         }
         statistics.append(stats)
 
-    response = {
-        'statistics': statistics
-    }
+    response = {"statistics": statistics}
 
     return jsonify(response), 200
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     app.run(debug=True)