2024-10-08 13:18:34 -07:00
.. _overview:
2024-10-06 16:54:34 -07:00
Overview
============
2025-06-17 08:16:42 -07:00
`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.
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.
2025-03-20 13:57:33 -07:00
2024-10-06 16:54:34 -07:00
In this documentation, you will learn how to quickly set up Arch to trigger API calls via prompts, apply prompt guardrails without writing any application-level logic,
simplify the interaction with upstream LLMs, and improve observability all while simplifying your application development process.
2025-01-10 16:38:48 -08:00
.. figure :: /_static/img/arch_network_diagram_high_level.png
:width: 100%
:align: center
High-level network flow of where Arch Gateway sits in your agentic stack. Designed for both ingress and egress prompt traffic.
2024-10-06 16:54:34 -07:00
Get Started
-----------
This section introduces you to Arch and helps you get set up quickly:
.. grid :: 3
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `apps` Overview
2024-10-06 16:54:34 -07:00
:link: overview.html
Overview of Arch and Doc navigation
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `book` Intro to Arch
2024-10-06 16:54:34 -07:00
:link: intro_to_arch.html
Explore Arch's features and developer workflow
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `rocket` Quickstart
2024-10-06 16:54:34 -07:00
:link: quickstart.html
Learn how to quickly set up and integrate
Concepts
--------
Deep dive into essential ideas and mechanisms behind Arch:
.. grid :: 3
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `package` Tech Overview
:link: ../concepts/tech_overview/tech_overview.html
2024-10-06 16:54:34 -07:00
Learn about the technology stack
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `webhook` LLM Provider
:link: ../concepts/llm_provider.html
2024-10-06 16:54:34 -07:00
Explore Arch’ s LLM integration options
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `workflow` Prompt Target
:link: ../concepts/prompt_target.html
2024-10-06 16:54:34 -07:00
Understand how Arch handles prompts
Guides
------
Step-by-step tutorials for practical Arch use cases and scenarios:
.. grid :: 3
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `shield-check` Prompt Guard
:link: ../guides/prompt_guard.html
2024-10-06 16:54:34 -07:00
Instructions on securing and validating prompts
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `code-square` Function Calling
2024-10-06 16:54:34 -07:00
:link: ../guides/function_calling.html
A guide to effective function calling
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `issue-opened` Observability
:link: ../guides/observability/observability.html
2024-10-06 16:54:34 -07:00
Learn to monitor and troubleshoot Arch
Build with Arch
---------------
For developers extending and customizing Arch for specialized needs:
.. grid :: 2
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `dependabot` Agentic Workflow
2024-10-06 16:54:34 -07:00
:link: ../build_with_arch/agent.html
Discover how to create and manage custom agents within Arch
2024-10-08 13:18:34 -07:00
.. grid-item-card :: :octicon: `stack` RAG Application
2024-10-06 16:54:34 -07:00
:link: ../build_with_arch/rag.html
Integrate RAG for knowledge-driven responses