Skip to content

Commit 5e65572

Browse files
salmanapSalman Paracha
andauthored
updating the messaging to call ourselves the edge and AI gateway for … (#527)
* updating the messaging to call ourselves the edge and AI gateway for agents * updating README to tidy up some language * updating README to tidy up some language * updating README to tidy up some language --------- Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-329.local>
1 parent 14f19f0 commit 5e65572

6 files changed

Lines changed: 25 additions & 33 deletions

File tree

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
<div align="center">
55

66

7-
_The proxy server and the universal data plane for AI-native apps._<br><br>
8-
Arch handles the *pesky low-level work* in building AI agents like clarifying vague user inputs, routing prompts to the right agents, calling tools for simple tasks, and unifying access to large language models (LLMs) - all without locking you into a framework. Move faster by focusing on the high-level logic of your agents.
7+
_Arch is a proxy server designed as a modular edge and AI gateway for agentic apps_<br><br>
8+
Arch handles the *pesky low-level work* in building agentic apps — like applying guardrails, clarifying vague user input, routing prompts to the right agent, and unifying access to any LLM. It’s a language and framework friendly infrastructure layer designed to help you build and ship agentic apps faster.
99

1010

1111
[Quickstart](#Quickstart)
@@ -80,7 +80,7 @@ Arch's CLI allows you to manage and interact with the Arch gateway efficiently.
8080
> 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.
8181
8282
```console
83-
$ python -m venv venv
83+
$ python3.12 -m venv venv
8484
$ source venv/bin/activate # On Windows, use: venv\Scripts\activate
8585
$ pip install archgw==0.3.4
8686
```
@@ -148,13 +148,10 @@ endpoints:
148148
```sh
149149

150150
$ archgw up arch_config.yaml
151-
2024-12-05 16:56:27,979 - cli.main - INFO - Starting archgw cli version: 0.1.5
152-
...
151+
2024-12-05 16:56:27,979 - cli.main - INFO - Starting archgw cli version: 0.3.4
153152
2024-12-05 16:56:28,485 - cli.utils - INFO - Schema validation successful!
154153
2024-12-05 16:56:28,485 - cli.main - INFO - Starting arch model server and arch gateway
155-
...
156154
2024-12-05 16:56:51,647 - cli.core - INFO - Container is healthy!
157-
158155
```
159156

160157
Once the gateway is up you can start interacting with at port 10000 using openai chat completion API.
-141 KB
Loading

docs/source/concepts/llm_provider.rst

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -35,28 +35,23 @@ make outbound LLM calls.
3535
Adding custom LLM Provider
3636
--------------------------
3737

38-
We support any OpenAI compliant LLM for example mistral, openai, ollama etc. We offer first class support for openai and ollama. You can easily configure an LLM that communicates over the OpenAI API interface, by following the below guide.
38+
We support any OpenAI compliant LLM for example mistral, openai, ollama etc. We also offer first class support for OpenAI, Anthropic, DeepSeek, Mistral, Groq, and Ollama based models.
39+
You can easily configure an LLM that communicates over the OpenAI API interface, by following the below guide.
3940

4041
For example following code block shows you how to add an ollama-supported LLM in the `arch_config.yaml` file.
4142

4243
.. code-block:: yaml
43-
44-
- name: local-llama
44+
llm_providers:
45+
- model: some_custom_llm_provider/llama3.2
4546
provider_interface: openai
46-
model: llama3.2
47-
endpoint: host.docker.internal:11434
48-
47+
base_url: http://host.docker.internal:11434
4948
50-
For example following code block shows you how to add mistral llm provider in the `arch_config.yaml` file.
49+
And in the following code block shows you how to add mistral llm provider in the `arch_config.yaml` file.
5150

5251
.. code-block:: yaml
53-
54-
- name: mistral-ai
55-
provider_interface: openai
56-
model: ministral-3b-latest
57-
endpoint: api.mistral.ai:443
58-
protocol: https
59-
52+
llm_providers:
53+
- name: mistral/ministral-3b-latest
54+
access_key: $MISTRAL_API_KEY
6055
6156
Example: Using the OpenAI Python SDK
6257
------------------------------------
@@ -65,15 +60,15 @@ Example: Using the OpenAI Python SDK
6560
6661
from openai import OpenAI
6762
68-
# Initialize the Arch client
69-
client = OpenAI(base_url="http://127.0.0.12000/")
63+
# Initialize the Arch client
64+
client = OpenAI(base_url="http://127.0.0.1:2000/")
7065
71-
# Define your LLM provider and prompt
72-
llm_provider = "openai"
73-
prompt = "What is the capital of France?"
66+
# Define your model and messages
67+
model = "llama3.2"
68+
messages = [{"role": "user", "content": "What is the capital of France?"}]
7469
75-
# Send the prompt to the LLM through Arch
76-
response = client.completions.create(llm_provider=llm_provider, prompt=prompt)
70+
# Send the messages to the LLM through Arch
71+
response = client.chat.completions.create(model=model, messages=messages)
7772
78-
# Print the response
79-
print("LLM Response:", response)
73+
# Print the response
74+
print("LLM Response:", response.choices[0].message.content)

docs/source/get_started/intro_to_arch.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Arch is designed to solve these problems by providing a unified, out-of-process
2020
High-level network flow of where Arch Gateway sits in your agentic stack. Designed for both ingress and egress prompt traffic.
2121

2222

23-
Arch is an AI-native proxy server and the universal data plane for AI built by the contributors of Envoy Proxy with the belief that:
23+
`Arch <https://github.com/katanemo/arch>`_ is a modular edge and AI gateway for AI-native apps - built by the contributors of Envoy Proxy with the belief that:
2424

2525
*Prompts are nuanced and opaque user requests, which require the same capabilities as traditional HTTP requests
2626
including secure handling, intelligent routing, robust observability, and integration with backend (API)

docs/source/get_started/overview.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Overview
55
============
6-
`Arch <https://github.com/katanemo/arch>`_ is an AI-native proxy server and the universal data plane for AI - one that is natively designed to handle and process AI prompts, not just network traffic.
6+
`Arch <https://github.com/katanemo/arch>`_ is a modular edge and AI gateway for AI-native apps - one that is natively designed to handle and process prompts, not just network traffic.
77

88
Built by contributors to the widely adopted `Envoy Proxy <https://www.envoyproxy.io/>`_, Arch helps you move faster by handling the pesky *low-level* work in AI agent development—fast input clarification, intelligent agent routing, seamless prompt-to-tool integration, and unified LLM access and observability—all without locking you into a framework.
99

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Welcome to Arch!
1414

1515
<a href="https://www.producthunt.com/posts/arch-3?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-arch&#0045;3" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=565761&theme=dark&period=daily&t=1742433071161" alt="Arch - Build&#0032;fast&#0044;&#0032;hyper&#0045;personalized&#0032;agents&#0032;with&#0032;intelligent&#0032;infra | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
1616

17-
`Arch <https://github.com/katanemo/arch>`_ is an AI-native proxy server and the universal data plane for AI - one that is natively designed to handle and process AI prompts, not just network traffic.
17+
`Arch <https://github.com/katanemo/arch>`_ is a modular edge and AI gateway for AI-native apps - one that is natively designed to handle and process prompts, not just network traffic.
1818

1919
Built by contributors to the widely adopted `Envoy Proxy <https://www.envoyproxy.io/>`_, Arch helps you move faster by handling the pesky *low-level* work in AI agent development—fast input clarification, intelligent agent routing, seamless prompt-to-tool integration, and unified LLM access and observability—all without locking you into a framework.
2020

0 commit comments

Comments
 (0)