mirror of
https://github.com/katanemo/plano.git
synced 2026-04-26 01:06:25 +02:00
6fb63510b3
* removing unnecessar setup.py files * updated the cli for debug and access logs * ran the pre-commit locally to fix pull request * fixed bug where if archgw_process is None we didn't handle it gracefully * Apply suggestions from code review Co-authored-by: Adil Hafeez <adil@katanemo.com> * fixed changes based on PR * fixed version not found message * fixed message based on PR feedback * adding poetry lock * fixed pre-commit --------- Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local> Co-authored-by: Adil Hafeez <adil@katanemo.com>
134 lines
6.7 KiB
Markdown
134 lines
6.7 KiB
Markdown
<p>
|
||
<img src="docs/source/_static/img/arch-logo.png" alt="Arch Gateway Logo" title="Arch Gateway Logo">
|
||
</p>
|
||
|
||
## Build fast, robust, and personalized AI agents.
|
||
|
||
Arch is an intelligent [Layer 7](https://www.cloudflare.com/learning/ddos/what-is-layer-7/) gateway designed to protect, observe, and personalize LLM applications (agents, assistants, co-pilots) with your APIs.
|
||
|
||
Engineered with purpose-built LLMs, Arch handles the critical but undifferentiated tasks related to the handling and processing of prompts, including detecting and rejecting [jailbreak](https://github.com/verazuo/jailbreak_llms) attempts, intelligently calling "backend" APIs to fulfill the user's request represented in a prompt, routing to and offering disaster recovery between upstream LLMs, and managing the observability of prompts and LLM interactions in a centralized way.
|
||
|
||
Arch is built on (and by the core contributors of) [Envoy Proxy](https://www.envoyproxy.io/) with the belief that:
|
||
|
||
>Prompts are nuanced and opaque user requests, which require the same capabilities as traditional HTTP requests including secure handling, intelligent routing, robust observability, and integration with backend (API) systems for personalization – all outside business logic.*
|
||
|
||
**Core Features**:
|
||
- Built on [Envoy](https://envoyproxy.io): Arch runs alongside application servers, and builds on top of Envoy's proven HTTP management and scalability features to handle ingress and egress traffic related to prompts and LLMs.
|
||
- Function Calling for fast Agentic and RAG apps. Engineered with purpose-built [LLMs](https://huggingface.co/collections/katanemo/arch-function-66f209a693ea8df14317ad68) to handle fast, cost-effective, and accurate prompt-based tasks like function/API calling, and parameter extraction from prompts.
|
||
- Prompt [Guard](https://huggingface.co/collections/katanemo/arch-guard-6702bdc08b889e4bce8f446d): Arch centralizes prompt guardrails to prevent jailbreak attempts and ensure safe user interactions without writing a single line of code.
|
||
- Traffic Management: Arch manages LLM calls, offering smart retries, automatic cutover, and resilient upstream connections for continuous availability.
|
||
- Standards-based Observability: Arch uses the W3C Trace Context standard to enable complete request tracing across applications, ensuring compatibility with observability tools, and provides metrics to monitor latency, token usage, and error rates, helping optimize AI application performance.
|
||
|
||
**Jump to our [docs](https://docs.archgw.com)** to learn how you can use Arch to improve the speed, security and personalization of your GenAI apps.
|
||
|
||
## Contact
|
||
To get in touch with us, please join our [discord server](https://discord.gg/rSRQ9fv7). We will be monitoring that actively and offering support there.
|
||
|
||
## Demos
|
||
* [Function Calling](demos/function_calling/README.md) - Walk through of the core function calling capabilities Arch offers
|
||
* [Insurance Agent](demos/insurance_agent/README.md) - Build a full insurance agent with Arch
|
||
* [Network Agent](demos/network_agent/README.md) - Build a networking co-pilot/agent agent with Arch
|
||
|
||
## Quickstart
|
||
|
||
Follow this guide to learn how to quickly set up Arch and integrate it into your generative AI applications.
|
||
|
||
### Prerequisites
|
||
|
||
Before you begin, ensure you have the following:
|
||
|
||
- `Docker` & `Python` installed on your system
|
||
- `API Keys` for LLM providers (if using external LLMs)
|
||
|
||
### Step 1: Install Arch
|
||
|
||
Arch's CLI allows you to manage and interact with the Arch gateway efficiently. To install the CLI, simply run the following command:
|
||
Tip: We recommend that developers create a new Python virtual environment to isolate dependencies before installing Arch. This ensures that archgw and its dependencies do not interfere with other packages on your system.
|
||
|
||
|
||
```console
|
||
$ python -m venv venv
|
||
$ source venv/bin/activate # On Windows, use: venv\Scripts\activate
|
||
$ pip install archgw
|
||
```
|
||
|
||
### Step 2: Configure Arch with your application
|
||
|
||
Arch operates based on a configuration file where you can define LLM providers, prompt targets, guardrails, etc.
|
||
Below is an example configuration to get you started:
|
||
|
||
```yaml
|
||
version: v0.1
|
||
|
||
listen:
|
||
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
|
||
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: Reboot specific devices or device groups
|
||
|
||
path: /agent/device_reboot
|
||
parameters:
|
||
- name: device_ids
|
||
type: list
|
||
description: A list of device identifiers (IDs) to reboot.
|
||
required: false
|
||
- 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.
|
||
endpoints:
|
||
app_server:
|
||
# 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
|
||
# max time to wait for a connection to be established
|
||
connect_timeout: 0.005s
|
||
```
|
||
### Step 3: Using OpenAI Client with Arch as an Egress Gateway
|
||
|
||
Make outbound calls via Arch
|
||
|
||
```python
|
||
import openai
|
||
|
||
# Set the OpenAI API base URL to the Arch gateway endpoint
|
||
openai.api_base = "http://127.0.0.1:12000/v1"
|
||
# No need to set a specific openai.api_key since it's configured in Arch's gateway
|
||
openai.api_key = "null"
|
||
|
||
# Use the OpenAI client as usual
|
||
response = openai.Completion.create(
|
||
model="text-davinci-003",
|
||
prompt="What is the capital of France?"
|
||
)
|
||
|
||
print("OpenAI Response:", response.choices[0].text.strip())
|
||
|
||
```
|
||
|
||
### [Observability](https://docs.archgw.com/guides/observability/observability.html)
|
||
Arch is designed to support best-in class observability by supporting open standards. Please read our [docs](https://docs.archgw.com/guides/observability/observability.html) on observability for more details on tracing, metrics, and logs
|
||
|
||
### Contribution
|
||
We would love feedback on our [Roadmap](https://github.com/orgs/katanemo/projects/1) and we welcome contributions to **Arch**!
|
||
Whether you're fixing bugs, adding new features, improving documentation, or creating tutorials, your help is much appreciated.
|
||
Please vist our [Contribution Guide](arch/CONTRIBUTING.md) for more details
|