Vizra.ai |

Documentation

📋

Requirements Checklist

Let's make sure your environment is ready for the exciting journey ahead! 🚀

✅ Before We Begin...

Getting your environment ready is like preparing your workspace before starting a masterpiece! Let's check off these requirements together to ensure smooth sailing ahead. ðŸŽĻ

ðŸ–Ĩïļ System Requirements

First things first! Let's make sure your system has the essentials. Don't worry, these are pretty standard for modern Laravel development. 💊

PHP 8.2 or higher

We're using the latest PHP features to give you the best developer experience! Your agents will thank you for the performance boost. 🚄

Laravel 11.0 or 12.0

Built for the latest Laravel versions! We're always keeping up with Taylor's innovations to bring you cutting-edge features. ðŸŽŊ

Composer 2.x

The package manager that makes installation a breeze! If you're still on v1, now's a great time to upgrade. ⚡

🗄ïļ Database Requirements

Your AI agents need a cozy home for their memories! Let's pick the perfect database for your setup. 🏠

🐎 MySQL 5.7+ / 8.0+

Our top pick for production! Fast, reliable, and battle-tested.

Recommended

🐘 PostgreSQL 10+

Perfect for vector search with pgvector extension!

Great for RAG

ðŸŠķ SQLite 3.8.8+

Lightning-fast for local development and testing!

Dev Friendly

🊟 SQL Server 2017+

For teams already in the Microsoft ecosystem.

Enterprise Ready

ðŸ’Ą Pro Tip About SQLite

SQLite is fantastic for getting started quickly! But when your agents start handling serious workloads or need vector memory features, consider graduating to MySQL or PostgreSQL. Think of it as moving from a studio apartment to a proper house! ðŸĄ

ðŸĪ– LLM Provider Requirements

Time to choose the AI brains for your agents! You'll need at least one API key from these providers. Don't worry, you can always add more later! 🧠âœĻ

🌊

OpenAI

The OG of AI models!

  • ✓ GPT-4 Turbo
  • ✓ GPT-4
  • ✓ GPT-3.5 Turbo
🎭

Anthropic

Claude's got personality!

  • ✓ Claude 3 Opus
  • ✓ Claude 3 Sonnet
  • ✓ Claude 3 Haiku
💎

Google

Gemini shines bright!

  • ✓ Gemini 1.5 Pro
  • ✓ Gemini 1.5 Flash
  • ✓ Gemini 1.0 Pro

🎁 Optional Power-Ups

Want to supercharge your agents? These optional features will take them to the next level! 🚀

🧠 For Vector Memory & RAG

Give your agents photographic memory with semantic search capabilities! Perfect for building knowledge-aware assistants. 📚

Vector Search Engine

  • ⭐
    Meilisearch 1.0+

    Lightning-fast and easy to set up!

  • â€Ē
    PostgreSQL + pgvector

    Keep everything in one database

Embedding Providers

  • ✓ OpenAI Embeddings API
  • ✓ Cohere Embed API
  • ✓ Ollama (run locally!)

⚡ For Queue Processing

Handle heavy workloads like a pro! Background jobs keep your agents responsive even under pressure. 💊

Redis 5.0+ (Recommended)

The speed demon of queue drivers! Your agents will thank you.

Process Managers

Supervisor or Laravel Horizon to keep your workers running 24/7

ðŸ§Đ PHP Extensions

Last but not least! These PHP extensions are the building blocks your agents need. Good news: most of them come pre-installed! 🎉

BCMath
Ctype
cURL
DOM
Fileinfo
JSON
Mbstring
OpenSSL
PCRE
PDO
Tokenizer
XML

🔍 Quick Environment Check

Let's make sure everything's in place! Run this handy command to see your setup at a glance. ðŸ•ĩïļ

Terminal
php artisan about

ðŸ’Ą This magical command will show you all the juicy details: Laravel version, PHP version, loaded extensions, and more! It's like a health check-up for your development environment. ðŸĨ

🎉 All Set? Let's Go!

Your environment is ready, and your AI agents are waiting to be born! Time to dive into the exciting world of Vizra ADK. 🚀

Continue to Getting Started