Getting Started

Getting Started#

This section gets you started with a very simple configuration and provides some example configurations.

The fastest way to get started using Arch is installing pre-built binaries. You can also build it from source.

Step 1: Install the Arch CLI#

Arch’s CLI allows you to manage and interact with the Arch gateway efficiently. To install the CLI, simply run the following command:

pip install archgw

This will install the archgw command-line tool globally on your system.

Step 2: Start Arch Gateway#

archgw up --quick-start

Configuration#

Today, only support a static bootstrap configuration file for simplicity today:

version: "0.1-beta"
listener:
  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
  messages: tuple | hugging-face-messages-api

system_prompts:
  - name: network_assistant
    content: You are a network assistant that just offers facts about the operational health of the network

llm_providers:
    - name: "OpenAI"
      access_key: $OPEN_AI_KEY
      model: gpt-4o
      default: true
    - name: "Mistral"
      access_key: $MISTRAL_KEY
      model: mixtral8-7B

prompt_endpoints:
  - "http://127.0.0.2"
  - "http://127.0.0.1"

prompt_guards:
   input-guard:
     - name: #jailbreak
       on-exception-message: Looks like you are curious about my abilities. But I can only

prompt_targets:
   - name: information_extraction
     type: RAG
     description: this prompt handles all information extractions scenarios
     path: /agent/summary

   - name: reboot_network_device
     path: /agent/action
     description: used to help network operators with perform device operations like rebooting a device.
     parameters:
error_target: #handle errors from Bolt or upstream LLMs
    name: “error_handler”
    path: /errors
Contents