Merge branch 'main' into adil/add_acm_demo

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/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/shared/logfire/Dockerfile

@@ -0,0 +1,5 @@
+FROM otel/opentelemetry-collector:latest
+
+COPY otel-collector-config.yaml /etc/otel-collector-config.yaml
+
+ENTRYPOINT ["/otelcol", "--config=/etc/otel-collector-config.yaml"]

demos/shared/logfire/otel-collector-config.yaml

@@ -0,0 +1,24 @@
+receivers:
+  otlp:
+    protocols:
+      grpc:
+        endpoint: 0.0.0.0:4317
+      http:
+        endpoint: 0.0.0.0:4318
+
+exporters:
+  otlphttp:
+    endpoint: "https://logfire-api.pydantic.dev"
+    headers:
+      Authorization: "${LOGFIRE_API_KEY}"
+
+processors:
+  batch:
+    timeout: 5s
+
+service:
+  pipelines:
+    traces:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlphttp]

demos/weather_forecast/README.md

@@ -1,27 +1,63 @@
 # Function calling
+
 This demo shows how you can use Arch's core function calling capabilites.
 
 # Starting the demo
+
 1. Please make sure the [pre-requisites](https://github.com/katanemo/arch/?tab=readme-ov-file#prerequisites) are installed correctly
 2. Start Arch
 
-3.
-   ```sh
+3. ```sh
    sh run_demo.sh
    ```
 4. Navigate to http://localhost:18080/
 5. You can type in queries like "how is the weather?"
 
 # Observability
+
 Arch gateway publishes stats endpoint at http://localhost:19901/stats. In this demo we are using prometheus 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
    ```yaml
    docker compose --profile monitoring up
    ```
-1. Navigate to http://localhost:3000/ to open grafana UI (use admin/grafana as credentials)
-1. From grafana left nav click on dashboards and select "Intelligent Gateway Overview" to view arch gateway stats
-
+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 "Intelligent Gateway Overview" to view arch gateway stats
 
 Here is a sample interaction,
 <img width="575" alt="image" src="https://github.com/user-attachments/assets/e0929490-3eb2-4130-ae87-a732aea4d059">
+
+## Tracing
+
+To see a tracing dashboard follow instructions below,
+
+1. For Jaeger, you can either use the default run_demo.sh script or run the following command:
+
+```sh
+sh run_demo.sh jaeger
+```
+
+2. For Logfire, first make sure to add a LOGFIRE_API_KEY to the .env file. You can either use the default run_demo.sh script or run the following command:
+
+```sh
+sh run_demo.sh logfire
+```
+
+3. For Signoz, you can either use the default run_demo.sh script or run the following command:
+
+```sh
+sh run_demo.sh signoz
+```
+
+If using Jaeger, navigate to http://localhost:16686/ to open Jaeger UI
+
+If using Signoz, navigate to http://localhost:3301/ to open Signoz UI
+
+If using Logfire, navigate to your logfire dashboard that you got the write key from to view the dashboard
+
+### Stopping Demo
+
+1. To end the demo, run the following command:
+   ```sh
+   sh run_demo.sh down
+   ```

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

demos/weather_forecast/docker-compose-jaeger.yaml

@@ -0,0 +1,41 @@
+services:
+  weather_forecast_service:
+    build:
+      context: ./
+    environment:
+      - OLTP_HOST=http://jaeger:4317
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+    ports:
+      - "18083:80"
+
+  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"
+
+  prometheus:
+    build:
+      context: ../shared/prometheus
+
+  grafana:
+    build:
+      context: ../shared/grafana
+    ports:
+      - "3000:3000"

demos/weather_forecast/docker-compose-logfire.yaml

@@ -0,0 +1,46 @@
+services:
+  weather_forecast_service:
+    build:
+      context: ./weather_forecast_service
+    environment:
+      - OLTP_HOST=http://otel-collector:4317
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+    ports:
+      - "18083:80"
+
+  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 environment 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
+
+  otel-collector:
+    build:
+      context: ../shared/logfire/
+    ports:
+      - "4317:4317"
+      - "4318:4318"
+    volumes:
+      - ../shared/logfire/otel-collector-config.yaml:/etc/otel-collector-config.yaml
+    env_file:
+      - .env
+    environment:
+      - LOGFIRE_API_KEY
+
+  prometheus:
+    build:
+      context: ../shared/prometheus
+
+  grafana:
+    build:
+      context: ../shared/grafana
+    ports:
+      - "3000:3000"

demos/weather_forecast/docker-compose-signoz.yaml

@@ -4,7 +4,7 @@ include:
 services:
   weather_forecast_service:
     build:
-      context: ../shared/weather_forecast_service
+      context: ./weather_forecast_service
     environment:
       - OLTP_HOST=http://otel-collector:4317
     extra_hosts:

demos/weather_forecast/docker-compose.yaml

@@ -1,7 +1,7 @@
 services:
   weather_forecast_service:
     build:
-      context: ../shared/weather_forecast_service
+      context: ./
     environment:
       - OLTP_HOST=http://jaeger:4317
     extra_hosts:

demos/weather_forecast/run_demo.sh

@@ -1,47 +1,95 @@
 #!/bin/bash
 set -e
 
+# Function to load environment variables from the .env file
+load_env() {
+  if [ -f ".env" ]; then
+    export $(grep -v '^#' .env | xargs)
+  fi
+}
+
+# Function to determine the docker-compose file based on the argument
+get_compose_file() {
+  case "$1" in
+    jaeger)
+      echo "docker-compose-jaeger.yaml"
+      ;;
+    logfire)
+      echo "docker-compose-logfire.yaml"
+      ;;
+    signoz)
+      echo "docker-compose-signoz.yaml"
+      ;;
+    *)
+      echo "docker-compose.yaml"
+      ;;
+  esac
+}
+
 # Function to start the demo
 start_demo() {
-  # Step 1: Check if .env file exists
+  # Step 1: Determine the docker-compose file
+  COMPOSE_FILE=$(get_compose_file "$1" 2>/dev/null)
+
+  # Step 2: 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
+    # Step 3: Check for required environment variables
     if [ -z "$OPENAI_API_KEY" ]; then
       echo "Error: OPENAI_API_KEY environment variable is not set for the demo."
       exit 1
     fi
+    if [ "$1" == "logfire" ] && [ -z "$LOGFIRE_API_KEY" ]; then
+      echo "Error: LOGFIRE_API_KEY environment variable is required for Logfire."
+      exit 1
+    fi
 
+    # Create .env file
     echo "Creating .env file..."
     echo "OPENAI_API_KEY=$OPENAI_API_KEY" > .env
-    echo ".env file created with OPENAI_API_KEY."
+    if [ "$1" == "logfire" ]; then
+      echo "LOGFIRE_API_KEY=$LOGFIRE_API_KEY" >> .env
+    fi
+    echo ".env file created with required API keys."
   fi
 
-  # Step 3: Start Arch
+  load_env
+
+  if [ "$1" == "logfire" ] && [ -z "$LOGFIRE_API_KEY"]; then
+    echo "Error: LOGFIRE_API_KEY environment variable is required for Logfire."
+    exit 1
+  fi
+
+  # Step 4: 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
+  # Step 5: Start Network Agent with the chosen Docker Compose file
+  echo "Starting Network Agent with $COMPOSE_FILE..."
+  docker compose -f "$COMPOSE_FILE" 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
+  echo "Stopping all Docker Compose services..."
 
-  # Step 2: Stop Arch
+  # Stop all services by iterating through all configurations
+  for compose_file in ./docker-compose*.yaml; do
+    echo "Stopping services in $compose_file..."
+    docker compose -f "$compose_file" down
+  done
+
+  # Stop Arch
   echo "Stopping Arch..."
   archgw down
 }
 
 # Main script logic
 if [ "$1" == "down" ]; then
+  # Call stop_demo with the second argument as the demo to stop
   stop_demo
 else
-  # Default action is to bring the demo up
-  start_demo
+  # Use the argument (jaeger, logfire, signoz) to determine the compose file
+  start_demo "$1"
 fi

demos/weather_forecast_signoz/README.md

@@ -1,29 +0,0 @@
-# Function calling
-This demo shows how you can use Arch's core function calling capabilites.
-
-# Starting the demo
-1. Please make sure the [pre-requisites](https://github.com/katanemo/arch/?tab=readme-ov-file#prerequisites) are installed correctly
-2. Start Arch
-
-3.
-   ```sh
-   sh run_demo.sh
-   ```
-4. Navigate to http://localhost:18080/
-5. You can type in queries like "how is the weather?"
-
-# Observability
-Arch gateway publishes stats endpoint at http://localhost:19901/stats. In this demo we are using prometheus 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
-   ```yaml
-   docker compose --profile monitoring up
-   ```
-1. Navigate to http://localhost:3000/ to open grafana UI (use admin/grafana as credentials)
-1. From grafana left nav click on dashboards and select "Intelligent Gateway Overview" to view arch gateway stats
-
-
-Here is a sample interaction,
-<img width="575" alt="image" src="https://github.com/user-attachments/assets/e0929490-3eb2-4130-ae87-a732aea4d059">
-
-1. Signoz UI: http://localhost:3301

demos/weather_forecast_signoz/arch_config.yaml

@@ -1,72 +0,0 @@
-version: "0.1-beta"
-
-listener:
-  address: 0.0.0.0
-  port: 10000
-  message_format: huggingface
-  connect_timeout: 0.005s
-
-endpoints:
-  weather_forecast_service:
-    endpoint: host.docker.internal:18083
-    connect_timeout: 0.005s
-
-overrides:
-  # confidence threshold for prompt target intent matching
-  prompt_target_intent_matching_threshold: 0.6
-
-llm_providers:
-  - name: gpt-4o-mini
-    access_key: $OPENAI_API_KEY
-    provider: openai
-    model: gpt-4o-mini
-    default: true
-
-  - name: gpt-3.5-turbo-0125
-    access_key: $OPENAI_API_KEY
-    provider: openai
-    model: gpt-3.5-turbo-0125
-
-  - name: gpt-4o
-    access_key: $OPENAI_API_KEY
-    provider: openai
-    model: gpt-4o
-
-system_prompt: |
-  You are a helpful assistant.
-
-prompt_targets:
-  - name: weather_forecast
-    description: Check weather information for a given city.
-    parameters:
-      - name: city
-        description: the name of the city
-        required: true
-        type: str
-      - name: days
-        description: the number of days
-        type: int
-        required: true
-      - name: units
-        description: the temperature unit, e.g., Celsius and Fahrenheit
-        type: str
-        default: Fahrenheit
-    endpoint:
-      name: weather_forecast_service
-      path: /weather
-
-  - name: default_target
-    default: true
-    description: This is the default target for all unmatched prompts.
-    endpoint:
-      name: weather_forecast_service
-      path: /default_target
-    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
-    # if true arch will forward the response to the default LLM
-    auto_llm_dispatch_on_response: false
-
-tracing:
-  random_sampling: 100
-  # trace_arch: true