AI Initiative logoAI Initiative
Reading room / Amigo

AMIGO Service

Source account of AMIGO Service.

Technical source document
This is the retained source text, not a new validation of its claims. Numerical results and comparative claims require the accompanying source review before public reuse.

Read the connected case study or article →

Author not established in the source · Date not established

Provenance, authorship and editorial notes

AMIGO Service

Id

ideas-readme-amigo

Project

Amigo

Source path

amigo-service/README.md

Source sha256

43e06826a1b31bbc21c1149ceb773eb3dfd70c852e1839d91d24f54ee2f6ef23

Repo head
Not recorded
Date
Not recorded
Author
Not recorded
Document status

Technical source document

Publication status

Retained source / publication not established

Summary

Source account of AMIGO Service.

Topics

No entries recorded.

Related ids

No entries recorded.

Evidence concerns
  • Retained source claims are not a fresh implementation or runtime certification.
  • Historical concept and design language must not be presented as delivered functionality.
Headings
  • AMIGO Service
  • Overview
  • Product Vision
  • What AMIGO Does
  • Target Users
  • Pricing
  • Architecture
  • Tech Stack
  • Service Details
  • API Endpoints
  • Project Structure
  • Development Setup
  • Prerequisites
  • Installation
  • Docker Setup (Alternative)
  • Configuration
  • Environment Variables
  • Server
  • Database
  • Redis
  • JWT
  • LLM
  • Connectors
  • Optional: Maestro Integration (Bundle only)
  • Feature Flags
  • Database Schema
  • Core Tables
  • API Documentation
  • Development Roadmap
  • Week 1 (Current)
  • Week 2-3
  • Week 4-5
  • Week 6
  • Week 7-10
  • Week 11-12
  • Testing
  • Unit Tests
  • Integration Tests
  • Coverage
  • Target Coverage
  • Deployment
  • Deployment Modes
  • Production Checklist
  • Monitoring & Observability
  • Health Checks
  • Metrics (Prometheus)
  • SLOs
  • Security
  • Authentication
  • Data Protection
  • Compliance
  • Contributing
  • Branch Strategy
  • Commit Conventions
  • Pull Request Process
  • Architecture Reference
  • Support & Documentation
  • License
Opening excerpt

**Version:** 1.0.0
**Status:** 🚧 In Development
**Start Date:** 2025-10-14

AMIGO Service

Version: 1.0.0
Status: 🚧 In Development
Start Date: 2025-10-14


Overview

AMIGO (AI-powered personal companion) is a standalone product that learns your unique communication style, remembers your context, and acts as your digital alter-ego. It helps individual professionals save time on routine communications and never miss important updates.

This is a SEPARATE product from Maestro. It can be deployed standalone or bundled with Maestro for enhanced value.


Product Vision

What AMIGO Does

Target Users

Pricing


Architecture

Tech Stack

Service Details

API Endpoints

/amigo/v1/health              GET   - Health check
/amigo/v1/auth/register       POST  - User registration
/amigo/v1/auth/login          POST  - User login
/amigo/v1/auth/refresh        POST  - Refresh JWT token
/amigo/v1/profile             GET   - Get user profile
/amigo/v1/profile             PUT   - Update profile
/amigo/v1/briefs/today        GET   - Get today's brief
/amigo/v1/drafts              GET   - List drafts
/amigo/v1/drafts              POST  - Create draft
/amigo/v1/drafts/:id          GET   - Get draft details
/amigo/v1/drafts/:id/approve  POST  - Approve draft
/amigo/v1/drafts/:id/send     POST  - Send draft (via Maestro HITL if bundle)
/amigo/v1/memory              GET   - Query memories
/amigo/v1/memory              POST  - Store memory
/amigo/v1/connectors          GET   - List integrations
/amigo/v1/connectors/:type    POST  - Connect integration (GitHub, Jira, Calendar)
/amigo/v1/feedback            POST  - Submit feedback (RLHF learning loop)

Project Structure

amigo-service/
├── src/
│   ├── api/                  # FastAPI routes
│   │   ├── __init__.py
│   │   ├── auth.py
│   │   ├── profile.py
│   │   ├── briefs.py
│   │   ├── drafts.py
│   │   ├── memory.py
│   │   ├── connectors.py
│   │   └── feedback.py
│   ├── services/             # Business logic
│   │   ├── __init__.py
│   │   ├── persona_service.py
│   │   ├── memory_service.py
│   │   ├── briefing_service.py
│   │   ├── drafting_service.py
│   │   ├── connector_service.py
│   │   └── feedback_service.py
│   ├── models/               # Pydantic models
│   │   ├── __init__.py
│   │   ├── user.py
│   │   ├── profile.py
│   │   ├── brief.py
│   │   ├── draft.py
│   │   ├── memory.py
│   │   └── connector.py
│   ├── database/             # SQLAlchemy models & migrations
│   │   ├── __init__.py
│   │   ├── models.py
│   │   └── session.py
│   ├── llm/                  # LLM integration
│   │   ├── __init__.py
│   │   ├── openai_client.py
│   │   └── anthropic_client.py
│   ├── utils/                # Utilities
│   │   ├── __init__.py
│   │   ├── auth.py           # JWT utils
│   │   ├── security.py       # Password hashing
│   │   └── dlp.py            # DLP/redaction
│   ├── config.py             # Configuration
│   └── main.py               # FastAPI app entry point
├── tests/
│   ├── __init__.py
│   ├── test_auth.py
│   ├── test_profile.py
│   ├── test_briefs.py
│   ├── test_drafts.py
│   ├── test_memory.py
│   └── conftest.py
├── alembic/                  # Database migrations
│   ├── versions/
│   ├── env.py
│   └── script.py.mako
├── docker/
│   ├── Dockerfile
│   └── docker-compose.yml
├── scripts/
│   └── init_db.py            # Database initialization
├── .env.example
├── .gitignore
├── pyproject.toml            # Poetry dependencies
├── pytest.ini
└── README.md                 # This file

Development Setup

Prerequisites

Installation

1. Clone and setup:
``bash
cd amigo-service
python3 -m venv venv
source venv/bin/activate
pip install poetry
poetry install
``

2. Database setup:
```bash
# Create database
createdb amigo_db

# Enable pgvector extension
psql amigo_db -c "CREATE EXTENSION IF NOT EXISTS vector;"

# Run migrations
alembic upgrade head
```

3. Environment configuration:
``bash
cp .env.example .env
# Edit .env with your settings
``

4. Run the service:
``bash
uvicorn src.main:app --host 0.0.0.0 --port 3100 --reload
``

5. Run tests:
``bash
pytest
``

Docker Setup (Alternative)

docker-compose up -d

Configuration

Environment Variables

# Server
PORT=3100
HOST=0.0.0.0
ENV=development  # development | staging | production

# Database
DATABASE_URL=postgresql://amigo_user:password@local-service/amigo_db

# Redis
REDIS_URL=redis://local-service/0

# JWT
JWT_SECRET=your-secret-key-here
JWT_ALGORITHM=HS256
JWT_EXPIRY_MINUTES=15
REFRESH_TOKEN_EXPIRY_DAYS=7

# LLM
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...
LLM_PROVIDER=openai  # openai | anthropic

# Connectors
GITHUB_CLIENT_ID=...
GITHUB_CLIENT_SECRET=...
JIRA_CLIENT_ID=...
JIRA_CLIENT_SECRET=...
GOOGLE_CLIENT_ID=...
GOOGLE_CLIENT_SECRET=...

# Optional: Maestro Integration (Bundle only)
MAESTRO_API_URL=local-service
MAESTRO_ENABLED=false

# Feature Flags
ENABLE_EMAIL_INTEGRATION=false
ENABLE_SLACK_INTEGRATION=false

Database Schema

Core Tables

See src/database/models.py for complete schema.


API Documentation

Once running, visit:


Development Roadmap

Week 1 (Current)

Week 2-3

Week 4-5

Week 6

Week 7-10

Week 11-12


Testing

Unit Tests

pytest tests/

Integration Tests

pytest tests/ -m integration

Coverage

pytest --cov=src tests/

Target Coverage


Deployment

Deployment Modes

1. AMIGO-only (Standalone):
``bash
docker-compose -f docker-compose.amigo-only.yml up -d
``

2. Bundle (with Maestro):
``bash
docker-compose -f docker-compose.bundle.yml up -d
``

Production Checklist


Monitoring & Observability

Health Checks

``json
{
"status": "healthy",
"version": "1.0.0",
"timestamp": "2025-10-14T12:00:00Z",
"dependencies": {
"database": "healthy",
"redis": "healthy",
"llm": "healthy"
}
}
``

Metrics (Prometheus)

SLOs


Security

Authentication

Data Protection

Compliance


Contributing

Branch Strategy

Commit Conventions

Pull Request Process

1. Create feature branch from develop
2. Implement feature with tests
3. Ensure all tests pass (pytest)
4. Submit PR with description
5. Get approval from 1+ reviewer
6. Merge to develop


Architecture Reference

For complete technical specification, see:


Support & Documentation


License

Proprietary - All Rights Reserved


Last Updated: 2025-10-14
Maintainer: Engineering Team
Status: 🚧 In Active Development

Continue exploring