Getting Started - Vizra ADK Documentation

✨

Welcome to Your AI Journey!

Building AI agents has never been easier! In just a few steps, you'll have your own intelligent agent up and running. Let's make something amazing together! 🎯

📦 Installation via Composer

Let's kick things off! First, we'll add Vizra ADK to your Laravel project:

Terminal

composer require vizra/vizra-adk

⚡ Running the Install Command

Great job! Now let's set everything up with our magical installation command:

Terminal

php artisan vizra:install

🎉 What happens next is pretty cool!

This command works its magic by:

✓ Publishing the configuration file to config/vizra.php
✓ Running database migrations to store your agent conversations
✓ Publishing assets for the beautiful web interface
✓ Creating example agents and tools to inspire you!

💡 Pro Tip!

Starting fresh? You can skip the examples if you want a clean slate:

Terminal

php artisan vizra:install --no-examples

🌐 Accessing the Web Interface

Here comes the fun part! Vizra ADK includes a gorgeous web interface for testing and monitoring your agents. Check it out at:

Browser URL

http://your-app.test/vizra

🎨 Your AI Command Center Includes:

💬

Chat Interface

Test your agents with real conversations

🔍

Trace Viewer

Debug like a pro with detailed execution traces

📊

Evaluation Runner

Test agent quality at scale

📈

Dashboard

Monitor performance and metrics

🤖 Creating Your First Agent

Now for the exciting part - let's create your very first AI agent! It's as easy as running one command:

Terminal

php artisan vizra:make:agent CustomerSupportAgent

✨ Boom! You just created an AI agent!

Your shiny new agent lives at app/Agents/CustomerSupportAgent.php

Here's what your agent looks like:

app/Agents/CustomerSupportAgent.php

<?php

namespace App\Agents;

use Vizra\VizraADK\Agents\BaseLlmAgent;

class CustomerSupportAgent extends BaseLlmAgent
{
    protected string $name = 'customer_support';

    protected string $description = 'Helps customers with their inquiries';

    protected string $instructions = 'You are a helpful customer support agent...';
}

🎉 That's it! Your agent is ready!

Vizra ADK uses auto-discovery - your agents are automatically registered and ready to use as soon as you create them! No manual registration needed.

All agents in your app/Agents directory are discovered automatically.

🎮 Testing Your Agent

Time to see your agent in action! Let's have a conversation:

Terminal

php artisan vizra:chat customer_support

💬 Or Use It In Your Code!

Your agent is ready to help users programmatically too:

Your Application Code

use App\Agents\CustomerSupportAgent;

$response = CustomerSupportAgent::ask('How do I reset my password?')
    ->forUser($user);

echo $response->content;

🎯 What's Next?

🎉 Congratulations!

You've successfully installed Vizra ADK and created your first AI agent! You're officially on your way to building amazing AI-powered applications. Keep that momentum going!

Ready to dive deeper? Here are your next adventures:

⚙️ Configuration →

Fine-tune Vizra ADK to match your project's needs perfectly

🧠 Understanding Agents →

Master the art of building intelligent AI agents

Happy building! 🚀