plano/README.md
Salman Paracha 13dff3089d
Adil/fix salman docs (#75)
* added the first set of docs for our technical docs

* more docuemtnation changes

* added support for prompt processing and updated life of a request

* updated docs to including getting help sections and updated life of a request

* committing local changes for getting started guide, sample applications, and full reference spec for prompt-config

* updated configuration reference, added sample app skeleton, updated favico

* fixed the configuration refernce file, and made minor changes to the intent detection. commit v1 for now

* Updated docs with use cases and example code, updated what is arch, and made minor changes throughout

* fixed imaged and minor doc fixes

* add sphinx_book_theme

* updated README, and make some minor fixes to documetnation

* fixed README.md

* fixed image width

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
Co-authored-by: Adil Hafeez <adil@katanemo.com>
2024-09-24 13:54:17 -07:00

2.3 KiB
Raw Blame History

Arch Gateway Logo

Build fast, robust, and personalized GenAI applications.

Arch is an intelligent Layer 7 gateway designed for generative AI apps, AI agents, and co-pilots that work with prompts. 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 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 the popular Envoy Distributed Proxy 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.

Demos

Complete

In progress

  • Network Co-pilot

Not Started

  • Show routing between different prompt targets (keyword search vs. top-k semantic search).
  • Show routing between different prompt-resolver vs RAG-based resolver targets.
  • Text Summarization Based on Lightweight vs. Thoughtful Dialogue using OpenAI
  • Show conversational and system observability metrics. This includes topic/intent detection
  • Show how we can help developers implement safeguards customized to their application requirements and responsible AI policies.

Dev setup

Pre-commit

Use instructions at pre-commit.com to set it up for your machine. Once installed make sure github hooks are setup, so that when you upstream your change pre-commit hooks can run and validate your change. Follow command below to setup github hooks,

$ brew install pre-commit
$ pre-commit install
pre-commit installed at .git/hooks/pre-commit