Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/wiki.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# PapiAI Core - Project Wiki

## Project Overview
PapiAI Core is a framework-agnostic, type-safe PHP 8.2+ library designed to simplify the creation of AI agents. It provides a robust abstraction layer over various LLM providers (currently supporting Anthropic Claude and Google Gemini), enabling developers to build agentic workflows with structured outputs, tool calling, and event-driven streaming without being tied to a specific framework like Laravel or Symfony. The goal is to offer a lightweight yet powerful foundation for integrating AI capabilities into any PHP application.

## Roadmap

### Phase 1: Foundation (Current)
- [x] Core Agent and Tool architecture
- [x] Provider abstractions (Anthropic, Google)
- [x] Type-safe Schema definitions for structured output
- [x] Event-driven streaming support
- [x] Basic observability hooks

### Phase 2: Expansion (Next)
- [ ] OpenAI Provider integration
- [ ] Conversation History and Memory management
- [ ] Middleware support for request/response modification
- [ ] Enhanced error handling and retry mechanisms

### Phase 3: Advanced Features
- [ ] Multi-agent orchestration and delegation
- [ ] Vector database integration for RAG (Retrieval-Augmented Generation)
- [ ] CLI tools for scaffolding agents and tools
- [ ] Pre-built toolkits for common APIs (GitHub, Slack, etc.)
63 changes: 63 additions & 0 deletions papi-core/docs/WIKI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# PapiAI Project Wiki

## 1. Project Overview

**PapiAI** is a modern, framework-agnostic PHP library designed for building robust AI agents. It provides a unified interface to interact with various Large Language Models (LLMs) like Anthropic Claude and Google Gemini, making it easy to integrate AI capabilities into any PHP application (Laravel, Symfony, or standalone).

### Key Philosophy
- **Simplicity**: Clean, intuitive API for creating agents.
- **Type Safety**: Built on PHP 8.2+ with strict typing.
- **Modularity**: Core logic is separated from specific provider implementations.

## 2. Architecture

The project is structured around a few key abstractions:

### Core Components (`papi-ai/papi-core`)
- **Agent**: The main entry point. It orchestrates interactions between the user, the LLM provider, and available tools.
- **ProviderInterface**: The contract that all LLM providers must implement. It standardizes:
- `chat()`: Standard request/response.
- `stream()`: Real-time streaming responses.
- Capabilities: `supportsTool()`, `supportsVision()`, `supportsStructuredOutput()`.
- **Tool**: encapsulations of functions or class methods that the AI can "call" to perform actions (e.g., fetching weather, querying a database).
- **Schema**: A fluent builder (Zod-like) for defining structured output requirements, ensuring the AI returns data in a predictable format.

### Providers
Specific implementations are handled in separate packages to keep the core lightweight:
- `papi-ai/anthropic`: Adapter for Anthropic's Claude models.
- `papi-ai/google`: Adapter for Google's Gemini models.
- `papi-ai/openai`: (Planned/In-progress) Adapter for OpenAI.

## 3. Getting Started

### Installation
Install the core package and your desired provider:

```bash
composer require papi-ai/core
composer require papi-ai/anthropic
```

### Basic Usage
Here is how to create a simple agent using Claude:

```php
use PapiAI\Core\Agent;
use PapiAI\Anthropic\AnthropicProvider;

$agent = new Agent(
provider: new AnthropicProvider(apiKey: $_ENV['ANTHROPIC_API_KEY']),
model: 'claude-3-5-sonnet-20240620',
instructions: 'You are a helpful coding assistant.'
);

$response = $agent->run('Refactor this class for me...');
echo $response->text;
```

## 4. Advanced Features

- **Tool Calling**: Define PHP functions or class methods as tools. The Agent handles the LLM's request to execute them.
- **Structured Output**: Enforce JSON schemas on responses for reliable data extraction.
- **Streaming**: Subscribe to event streams for real-time UI updates.
- **Observability**: Hooks available for logging and monitoring agent performance.
Loading