update getting started guide and add llm gateway and prompt gateway samples (#330)

demos/currency_exchange/README.md

@@ -0,0 +1 @@
+This demo shows how you can use a publicly hosted rest api and interact it using arch gateway.

demos/currency_exchange/arch_config.yaml

@@ -0,0 +1,52 @@
+version: v0.1
+
+listener:
+  address: 0.0.0.0
+  port: 10000
+  message_format: huggingface
+  connect_timeout: 0.005s
+
+llm_providers:
+  - name: gpt-4o
+    access_key: $OPENAI_API_KEY
+    provider: openai
+    model: gpt-4o
+
+system_prompt: |
+  You are a helpful assistant.
+
+prompt_guards:
+  input_guards:
+    jailbreak:
+      on_exception:
+        message: Looks like you're curious about my abilities, but I can only provide assistance for currency exchange.
+
+prompt_targets:
+  - name: currency_exchange
+    description: Get currency exchange rate from USD to other currencies
+    parameters:
+      - name: currency_symbol
+        description: the currency that needs conversion
+        required: true
+        type: str
+        in_path: true
+    endpoint:
+      name: frankfurther_api
+      path: /v1/latest?base=USD&symbols={currency_symbol}
+    system_prompt: |
+      You are a helpful assistant. Show me the currency symbol you want to convert from USD.
+
+  - name: get_supported_currencies
+    description: Get list of supported currencies for conversion
+    endpoint:
+      name: frankfurther_api
+      path: /v1/currencies
+
+endpoints:
+  frankfurther_api:
+    endpoint: api.frankfurter.dev:443
+    protocol: https
+
+tracing:
+  random_sampling: 100
+  trace_arch_internal: true

demos/currency_exchange/docker-compose.yaml

@@ -0,0 +1,21 @@
+services:
+  chatbot_ui:
+    build:
+      context: ../shared/chatbot_ui
+    ports:
+      - "18080:8080"
+    environment:
+      # this is only because we are running the sample app in the same docker container environemtn as archgw
+      - CHAT_COMPLETION_ENDPOINT=http://host.docker.internal:10000/v1
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+    volumes:
+      - ./arch_config.yaml:/app/arch_config.yaml
+
+  jaeger:
+    build:
+      context: ../shared/jaeger
+    ports:
+      - "16686:16686"
+      - "4317:4317"
+      - "4318:4318"

demos/currency_exchange/run_demo.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+set -e
+
+# Function to start the demo
+start_demo() {
+  # Step 1: Check if .env file exists
+  if [ -f ".env" ]; then
+    echo ".env file already exists. Skipping creation."
+  else
+    # Step 2: Create `.env` file and set OpenAI key
+    if [ -z "$OPENAI_API_KEY" ]; then
+      echo "Error: OPENAI_API_KEY environment variable is not set for the demo."
+      exit 1
+    fi
+
+    echo "Creating .env file..."
+    echo "OPENAI_API_KEY=$OPENAI_API_KEY" > .env
+    echo ".env file created with OPENAI_API_KEY."
+  fi
+
+  # Step 3: Start Arch
+  echo "Starting Arch with arch_config.yaml..."
+  archgw up arch_config.yaml
+
+  # Step 4: Start Network Agent
+  echo "Starting Network Agent using Docker Compose..."
+  docker compose up -d  # Run in detached mode
+}
+
+# Function to stop the demo
+stop_demo() {
+  # Step 1: Stop Docker Compose services
+  echo "Stopping Network Agent using Docker Compose..."
+  docker compose down
+
+  # Step 2: Stop Arch
+  echo "Stopping Arch..."
+  archgw down
+}
+
+# Main script logic
+if [ "$1" == "down" ]; then
+  stop_demo
+else
+  # Default action is to bring the demo up
+  start_demo
+fi

demos/hr_agent/arch_config.yaml

@@ -34,6 +34,7 @@ prompt_targets:
       endpoint:
         name: app_server
         path: /agent/workforce
+        http_method: POST
       parameters:
         - name: staffing_type
           type: str
@@ -52,6 +53,7 @@ prompt_targets:
       endpoint:
         name: app_server
         path: /agent/slack_message
+        http_method: POST
       description: sends a slack message on a channel
       parameters:
         - name: slack_message

demos/insurance_agent/arch_config.yaml

@@ -29,6 +29,7 @@ prompt_targets:
     endpoint:
       name: app_server
       path: /policy/qa
+      http_method: POST
     description: Handle general Q/A related to insurance.
     default: true
 
@@ -37,6 +38,7 @@ prompt_targets:
     endpoint:
       name: app_server
       path: /policy/coverage
+      http_method: POST
     parameters:
     - name: policy_type
       type: str
@@ -48,6 +50,7 @@ prompt_targets:
     endpoint:
       name: app_server
       path: /policy/initiate
+      http_method: POST
     description: Start a policy coverage for car, boat, motorcycle or house.
     parameters:
     - name: policy_type
@@ -64,6 +67,7 @@ prompt_targets:
     endpoint:
       name: app_server
       path: /policy/claim
+      http_method: POST
     description: Update the notes on the claim
     parameters:
     - name: claim_id
@@ -79,6 +83,7 @@ prompt_targets:
     endpoint:
       name: app_server
       path: /policy/deductible
+      http_method: POST
     description: Update the deductible amount for a specific policy coverage.
     parameters:
     - name: policy_id

demos/network_agent/arch_config.yaml

@@ -22,6 +22,7 @@ prompt_targets:
       endpoint:
         name: app_server
         path: /agent/device_summary
+        http_method: POST
       parameters:
         - name: device_ids
           type: list
@@ -36,6 +37,7 @@ prompt_targets:
       endpoint:
         name: app_server
         path: /agent/device_reboot
+        http_method: POST
       parameters:
         - name: device_ids
           type: list

demos/weather_forecast/arch_config.yaml

@@ -60,6 +60,7 @@ prompt_targets:
     endpoint:
       name: weather_forecast_service
       path: /weather
+      http_method: POST
 
   - name: default_target
     default: true
@@ -67,6 +68,7 @@ prompt_targets:
     endpoint:
       name: weather_forecast_service
       path: /default_target
+      http_method: POST
     system_prompt: |
       You are a helpful assistant! Summarize the user's request and provide a helpful response.
     # if it is set to false arch will send response that it received from this prompt target to the user