apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-04-26 17:26:26 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
plano/demos/network_agent/README.md
Salman Paracha 42d4a28e13
updated all demo READMes and minor doc changes (#154) 
* updated all demo READMes and minor doc changes

* minor typo fixes

* updated main Readme

* fixed README and docs

* fixed README and docs

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
2024-10-08 23:58:55 -07:00

2.3 KiB
Raw Blame History

Network Agent Demo

This demo illustrates how Arch can be used to perform function calling with network-related tasks. In this demo, you act as a network assistant that provides factual information, without offering advice on manufacturers or purchasing decisions.

The assistant can perform several key operations, including rebooting devices, answering general networking questions, and retrieving device statistics. By default, the system prompt ensures that the assistant's responses are factual and neutral.

Available Functions:

  • Reboot Devices: Allows rebooting specific devices or device groups, with an optional time range for scheduling the reboot.

    • Parameters:
      • device_ids (required): A list of device IDs to reboot.
      • time_range (optional): Specifies the time range in days, defaulting to 7 days if not provided.

  • Network Q/A: Handles general Q&A related to networking. This function is the default target for general networking queries.

  • Device Summary: Retrieves statistics for specific devices within a given time range.

    • Parameters:
      • device_ids (required): A list of device IDs for which statistics will be retrieved.
      • time_range (optional): Specifies the time range in days for gathering statistics, with a default of 7 days.

Starting the demo

  1. Create .env file and set OpenAI key using env var OPENAI_API_KEY
  2. Start Arch 
    archgw up [path to arch_config.yaml]
  3. Start Network Agent 
    docker compose up
  4. Navigate to http://localhost:18080/
  5. You can type in queries like "show me device statics for the past 7 days"

Observability

Arch gateway publishes stats endpoint at http://localhost:19901/stats. In this demo we are using grafana to pull stats from arch and we are using grafana to visalize the stats in dashboard. To see grafana dashboard follow instructions below,

  1. Start grafana and prometheus using following command 
    docker compose --profile monitoring up
  2. Navigate to http://localhost:3000/ to open grafana UI (use admin/grafana as credentials)
  3. From grafana left nav click on dashboards and select "Arch" to view the arch gateway stats

Here is sample interaction, image