{"id":28576174,"url":"https://github.com/philsv/aira","last_synced_at":"2025-10-29T07:24:39.847Z","repository":{"id":297134354,"uuid":"994966083","full_name":"philsv/aira","owner":"philsv","description":"Agentic Information Retrieval API","archived":false,"fork":false,"pushed_at":"2025-06-04T01:08:10.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-04T08:42:41.462Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/philsv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-02T18:58:59.000Z","updated_at":"2025-06-04T01:08:11.000Z","dependencies_parsed_at":"2025-06-04T08:52:58.966Z","dependency_job_id":null,"html_url":"https://github.com/philsv/aira","commit_stats":null,"previous_names":["philsv/aira"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philsv%2Faira","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philsv%2Faira/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philsv%2Faira/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philsv%2Faira/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/philsv","download_url":"https://codeload.github.com/philsv/aira/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philsv%2Faira/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259166973,"owners_count":22815593,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-10T23:08:23.231Z","updated_at":"2025-10-29T07:24:39.779Z","avatar_url":"https://github.com/philsv.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aira - Agentic Information Retrieval Assistant\n\nAira is a demo AI-powered document chat application that allows users to interact with documents using natural language.\n\n## Prerequisites\n\n- Python 3.11+\n- [uv](https://docs.astral.sh/uv/) package manager\n- Node.js 18+ (for frontend development)\n- npm package manager\n- Docker or Docker Desktop (Windows users)\n- Make (for managing tasks)\n\n## 🚀 Quick Start\n\n### 1. Clone the repository:\n\n```bash\ngit clone https://github.com/philsv/aira.git\ncd aira\n```\n\n### 2. Install dependencies:\n\n```bash\nmake install\n```\n\n### 3. Environment Configuration\n\nCopy the environment template and configure your services:\n\n```bash\ncp .env.template .env\n```\n\nEdit the `.env` file with your service configurations:\n\n#### Required Environment Variables\n\n**OpenAI Configuration** (for embeddings):\n\n```bash\nOPENAI_API_KEY=your_openai_api_key_here\nEMBED_MODEL=text-embedding-ada-002\nMODEL_DIMENSIONS=1536\n```\n\n**xAI Configuration** (for chat completions):\n\n```bash\nXAI_API_KEY=your_xai_api_key_here\nXAI_MODEL=grok-3-mini\n```\n\n**Qdrant Vector Database**:\n\n```bash\nQDRANT_HOST=host.docker.internal\nQDRANT_PORT=6333\n```\n\n**AWS S3 Storage**:\n\n```bash\nS3_BUCKET=your_s3_bucket_name\nS3_ACCESS_KEY=your_s3_access_key\nS3_SECRET_KEY=your_s3_secret_key\nS3_REGION=your_s3_region\n```\n\n**LangSmith Tracing** (optional):\n\n```bash\nLANGSMITH_API_KEY=your_langsmith_api_key\nLANGSMITH_PROJECT=aira-project\n```\n\n**Server Configuration**:\n\n```bash\nUVICORN_HOST=0.0.0.0\nUVICORN_PORT=8000\n```\n\n### 4. Deploy the application in docker:\n\nEnsure Docker is running, then build and start the application:\n\n```bash\nmake deploy\n```\n\n## 🛠️ Development\n\nStart the backend server locally:\n\n```bash\nmake server\n```\n\n### Dependency Management\n\nThis project uses `uv` for fast Python package management. Dependencies are defined in [requirements.in](requirements.in).\n\nTo update dependencies:\n\n```bash\nmake requirements\n```\n\n### Testing\n\nRun the test suite:\n\n```bash\nmake test\n```\n\n## Accessing the Application\n\nThe API will be available at:\n\n- **API Server**: http://localhost:8000\n- **Interactive Docs**: http://localhost:8000/docs\n- **ReDoc**: http://localhost:8000/redoc\n- **OpenAPI JSON**: http://localhost:8000/openapi.json\n\nTo access the chat, run:\n\n- **Frontend App**: http://localhost:3000\n\nTo access the qdrant dashboard, run:\n\n- **Qdrant Dashboard**: http://localhost:6333/dashboard\n\nTo access the fumadocs documentation, run:\n\n- **Documentations**: http://localhost:3007\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilsv%2Faira","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphilsv%2Faira","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilsv%2Faira/lists"}