petter2025's picture
Update README.md
e607227 verified
|
raw
history blame
1.98 kB
---
title: Agentic Reliability Framework (ARF) v4 API
emoji: 🤖
colorFrom: blue
colorTo: green
sdk: docker
python_version: '3.10'
app_file: app.py
pinned: false
---
# Agentic Reliability Framework (ARF) v4 API
This Space hosts the **ARF v4 API** with an optional Gradio dashboard. It provides endpoints for risk assessment, decision history, and incident evaluation, as used by the [ARF frontend](https://arf-frontend-sandy.vercel.app).
The API is built with FastAPI and mounted under the `/api` subpath, while the Gradio dashboard is served at the root (`/`).
## 🚀 Endpoints
All API endpoints are prefixed with `/api`. Interactive documentation is available at `/api/docs`.
| Method | Path | Description |
|--------|------|-------------|
| `GET` | `/api/health` | Health check |
| `GET` | `/api/v1/get_risk` | Current system risk (demo) |
| `GET` | `/api/v1/history` | Recent decisions |
| `POST` | `/api/v1/incidents/evaluate` | Evaluate an incident (placeholder) |
| `POST` | `/api/v1/feedback` | Record outcome of a decision |
## 🧪 Try It
- **Swagger UI**: [https://a-r-f-agentic-reliability-framework-api.hf.space/api/docs](https://a-r-f-agentic-reliability-framework-api.hf.space/api/docs)
- **Gradio dashboard**: [https://a-r-f-agentic-reliability-framework-api.hf.space/](https://a-r-f-agentic-reliability-framework-api.hf.space/)
## 🔧 Local Development
To run this Space locally with Docker:
```bash
docker build -t arf-api .
docker run -p 7860:7860 arf-api
```
Or without Docker, using Python directly:
```python
pip install -r requirements.txt
uvicorn app:fastapi_app --reload --port 7860
```
The API will be available at http://localhost:7860/api and the Gradio UI at http://localhost:7860.
📚 About ARF
------------
Agentic Reliability Framework is an open‑source advisory engine for cloud infrastructure governance, powered by Bayesian inference. Learn more at [github.com/arf-foundation](https://github.com/arf-foundation).