mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-16 22:05:20 +00:00
Second phase of the AI feature. Users can now open a slide-in chat drawer from the SiteHeader and ask natural-language questions about their company's invoices, customers, payments, and expenses. The LLM invokes pre-defined read-only tool functions (scoped to the current company at execute time) to fetch data and synthesize answers.
**Database** — new ai_conversations and ai_messages tables. Messages are stored in OpenAI's chat format so AiAssistantService serializes a conversation into an API request with zero translation. Columns: role, content, tool_call_id, tool_calls JSON, model, tokens_in, tokens_out. Conversations are scoped (company_id, user_id) — one user's chats are invisible to everyone else, even inside the same company. Foreign-key cascade deletes.
**Tool infrastructure** — AiTool abstract base + AiToolRegistry singleton (registered in a new AiServiceProvider). The base class enforces the security rule: every tool's execute() receives companyId and userId as injected parameters; tools' JSON schemas NEVER include a company_id field. An LLM physically cannot pass a company_id and escape tenancy. Modules can register their own tools by resolving the registry from their own ServiceProvider::boot().
**Nine built-in tools**: search_invoices, get_invoice, search_customers, get_customer, list_recent_payments, list_overdue_invoices, get_company_stats (aggregates for named periods), search_items, list_expense_categories. All read-only; no mutations. Each returns JSON-encodable data the LLM can parse.
**AiAssistantService orchestration loop** — the heart of Phase 2. Flow: persist user message → build payload from system prompt + recent history (40-message window) + new user message → call driver.chatCompletion with tools → if tool_calls, execute each one via the registry (with injected scope), persist tool result, loop → if plain text, persist and return. Hard cap at 5 iterations to prevent runaway LLMs. System prompt pins the assistant to this company's data and forbids mutation.
**Controllers + policy + rate limit** — POST /api/v1/ai/chat runs the orchestration loop. GET/PATCH/DELETE /api/v1/ai/conversations for CRUD. AiConversationPolicy enforces user_id+company_id match on every action. A new 'ai' RateLimiter in RouteServiceProvider throttles to 30 req/min per (user, company). New 'use ai' Gate defined in AppServiceProvider returns true for any authenticated user — the per-company kill-switch still goes through AiConfigurationService::resolveForCompany.
**Frontend** — new features/company/ai/ folder with a Pinia store (ai-chat.store.ts) holding drawer state, current conversation, messages, and loading flags. AiChatDrawer.vue is a slide-in panel teleported to <body>, mounted globally in CompanyLayout.vue when bootstrap reports ai.enabled && ai.chat_enabled. Sub-components: AiChatMessage (user bubbles vs assistant bubbles), AiChatMessageInput (Enter submits, Shift+Enter newline), AiChatConversationList (sidebar with 'new chat' button, rename, delete). A SparklesIcon button in SiteHeader toggles the drawer.
**Driver test double** — tests use a ScriptedAiDriver registered via AiDriverFactory::register('scripted', ...) that returns pre-queued AiChatResponse objects. Feature tests cover: happy path (new conversation + message persistence), tool-call loop (multi-round-trip with search_invoices), runaway-loop cap, driver-throws path, ai_enabled=NO rejection, chat role disabled rejection, per-user conversation visibility, cross-user policy enforcement, cascade delete.
388 tests pass (was 372, +16 new). Pint clean. npm run build clean. Phase 3 (WYSIWYG text generation popup) is the remaining follow-up.
332 lines
12 KiB
PHP
332 lines
12 KiB
PHP
<?php
|
|
|
|
namespace App\Services\Ai;
|
|
|
|
use App\Models\AiConversation;
|
|
use App\Models\AiMessage;
|
|
use App\Models\Company;
|
|
use App\Models\User;
|
|
use App\Services\AiConfigurationService;
|
|
use App\Support\Ai\AiChatResponse;
|
|
use App\Support\Ai\AiException;
|
|
use Carbon\Carbon;
|
|
use InvalidArgumentException;
|
|
use Throwable;
|
|
|
|
/**
|
|
* Orchestrates a single turn of the chat assistant.
|
|
*
|
|
* The public surface is `chat(conversation, userMessage)` — it persists the
|
|
* user's message, runs the LLM → tool-calls → LLM loop until the model emits
|
|
* a plain-text reply (or we hit the hard cap), persists everything along the
|
|
* way, and returns the final assistant AiMessage.
|
|
*
|
|
* Per-phase-2 plan this is NON-STREAMING: the caller waits for the final
|
|
* response. Streaming is a future polish refactor — the storage shape and
|
|
* return type will be the same.
|
|
*/
|
|
class AiAssistantService
|
|
{
|
|
/** Hard cap on tool-call iterations per turn. Prevents runaway loops. */
|
|
public const MAX_TOOL_ITERATIONS = 5;
|
|
|
|
/** Cap on messages loaded from history to fit the model context window. */
|
|
private const HISTORY_WINDOW = 40;
|
|
|
|
public function __construct(
|
|
private readonly AiConfigurationService $aiConfiguration,
|
|
private readonly AiToolRegistry $toolRegistry,
|
|
) {}
|
|
|
|
/**
|
|
* Start a new conversation for the given user in the given company.
|
|
*/
|
|
public function startConversation(int $companyId, int $userId, ?string $firstMessage = null): AiConversation
|
|
{
|
|
return AiConversation::create([
|
|
'company_id' => $companyId,
|
|
'user_id' => $userId,
|
|
'title' => $firstMessage !== null ? $this->titleFromMessage($firstMessage) : null,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Process one user message within an existing conversation.
|
|
*
|
|
* Returns the final assistant AiMessage that should be shown to the user.
|
|
*
|
|
* @throws AiException When AI is disabled or the driver call fails unrecoverably.
|
|
*/
|
|
public function chat(AiConversation $conversation, string $userMessage): AiMessage
|
|
{
|
|
$driver = $this->aiConfiguration->makeDriver($conversation->company_id);
|
|
|
|
if ($driver === null) {
|
|
throw new AiException('AI is not enabled for this company', 'ai_disabled');
|
|
}
|
|
|
|
$resolved = $this->aiConfiguration->resolveForCompany($conversation->company_id);
|
|
if (empty($resolved['chat_enabled'])) {
|
|
throw new AiException('Chat is not enabled for this company', 'chat_disabled');
|
|
}
|
|
|
|
$model = (string) ($resolved['ai_chat_model'] ?? '');
|
|
if ($model === '') {
|
|
throw new AiException('No chat model configured', 'missing_model');
|
|
}
|
|
|
|
// Auto-title on first message.
|
|
if ($conversation->title === null) {
|
|
$conversation->title = $this->titleFromMessage($userMessage);
|
|
$conversation->model = $model;
|
|
}
|
|
|
|
// Persist the user's message first so it shows even if the LLM call fails.
|
|
$userRow = AiMessage::create([
|
|
'conversation_id' => $conversation->id,
|
|
'role' => AiMessage::ROLE_USER,
|
|
'content' => $userMessage,
|
|
]);
|
|
|
|
$conversation->touch(); // bump updated_at for "recent" ordering
|
|
|
|
$messages = $this->buildMessagesPayload($conversation);
|
|
$tools = $this->toolRegistry->schemas();
|
|
|
|
for ($iteration = 0; $iteration < self::MAX_TOOL_ITERATIONS; $iteration++) {
|
|
try {
|
|
$response = $driver->chatCompletion($messages, $model, $tools);
|
|
} catch (AiException $e) {
|
|
// Persist the error as an assistant message so the UI can render it.
|
|
return AiMessage::create([
|
|
'conversation_id' => $conversation->id,
|
|
'role' => AiMessage::ROLE_ASSISTANT,
|
|
'content' => "Error: {$e->getMessage()}",
|
|
'model' => $model,
|
|
]);
|
|
}
|
|
|
|
// Tool calls requested → execute each, append their results, loop.
|
|
if ($response->hasToolCalls()) {
|
|
$this->persistAssistantToolCallTurn($conversation, $response, $model);
|
|
$messages[] = $this->assistantToolCallMessage($response);
|
|
|
|
foreach ($response->toolCalls as $call) {
|
|
$toolResult = $this->safelyExecuteTool(
|
|
name: $call['name'],
|
|
arguments: $call['arguments'] ?? [],
|
|
companyId: $conversation->company_id,
|
|
userId: $conversation->user_id,
|
|
);
|
|
|
|
$resultJson = json_encode($toolResult, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
|
|
|
|
AiMessage::create([
|
|
'conversation_id' => $conversation->id,
|
|
'role' => AiMessage::ROLE_TOOL,
|
|
'content' => $resultJson,
|
|
'tool_call_id' => $call['id'] ?? null,
|
|
]);
|
|
|
|
$messages[] = [
|
|
'role' => 'tool',
|
|
'tool_call_id' => $call['id'] ?? '',
|
|
'content' => $resultJson,
|
|
];
|
|
}
|
|
|
|
// Loop — the LLM will receive the tool results on the next iteration.
|
|
continue;
|
|
}
|
|
|
|
// Plain text response — persist and return.
|
|
return AiMessage::create([
|
|
'conversation_id' => $conversation->id,
|
|
'role' => AiMessage::ROLE_ASSISTANT,
|
|
'content' => $response->message ?? '',
|
|
'model' => $model,
|
|
'tokens_in' => $response->usage['tokens_in'] ?? null,
|
|
'tokens_out' => $response->usage['tokens_out'] ?? null,
|
|
]);
|
|
}
|
|
|
|
// Exceeded the loop cap.
|
|
return AiMessage::create([
|
|
'conversation_id' => $conversation->id,
|
|
'role' => AiMessage::ROLE_ASSISTANT,
|
|
'content' => 'The assistant could not complete this request within the tool-call budget. Please try rephrasing.',
|
|
'model' => $model,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Build the OpenAI-format messages payload for the next LLM call.
|
|
*
|
|
* Starts with a fresh system prompt, then the recent message history
|
|
* trimmed to HISTORY_WINDOW items, then the message(s) that will drive
|
|
* the upcoming round-trip (already persisted by chat()).
|
|
*
|
|
* @return array<int, array<string, mixed>>
|
|
*/
|
|
protected function buildMessagesPayload(AiConversation $conversation): array
|
|
{
|
|
$payload = [
|
|
[
|
|
'role' => 'system',
|
|
'content' => $this->buildSystemPrompt($conversation),
|
|
],
|
|
];
|
|
|
|
$history = AiMessage::query()
|
|
->where('conversation_id', $conversation->id)
|
|
->orderByDesc('created_at')
|
|
->limit(self::HISTORY_WINDOW)
|
|
->get()
|
|
->reverse()
|
|
->values();
|
|
|
|
foreach ($history as $msg) {
|
|
$payload[] = $this->formatMessageForDriver($msg);
|
|
}
|
|
|
|
return $payload;
|
|
}
|
|
|
|
/**
|
|
* @return array<string, mixed>
|
|
*/
|
|
protected function formatMessageForDriver(AiMessage $msg): array
|
|
{
|
|
$base = ['role' => $msg->role];
|
|
|
|
if ($msg->role === AiMessage::ROLE_TOOL) {
|
|
$base['tool_call_id'] = $msg->tool_call_id ?? '';
|
|
$base['content'] = $msg->content ?? '';
|
|
|
|
return $base;
|
|
}
|
|
|
|
if ($msg->role === AiMessage::ROLE_ASSISTANT && $msg->tool_calls) {
|
|
$base['content'] = $msg->content;
|
|
$base['tool_calls'] = array_map(function (array $call): array {
|
|
return [
|
|
'id' => $call['id'] ?? '',
|
|
'type' => 'function',
|
|
'function' => [
|
|
'name' => $call['name'] ?? '',
|
|
'arguments' => json_encode($call['arguments'] ?? [], JSON_UNESCAPED_UNICODE),
|
|
],
|
|
];
|
|
}, $msg->tool_calls);
|
|
|
|
return $base;
|
|
}
|
|
|
|
$base['content'] = $msg->content ?? '';
|
|
|
|
return $base;
|
|
}
|
|
|
|
/**
|
|
* Compose the system prompt with company context.
|
|
*/
|
|
protected function buildSystemPrompt(AiConversation $conversation): string
|
|
{
|
|
$company = Company::find($conversation->company_id);
|
|
$user = User::find($conversation->user_id);
|
|
|
|
$companyName = $company?->name ?? 'this company';
|
|
$userName = $user?->name ?? 'the user';
|
|
$today = Carbon::now()->toDateString();
|
|
|
|
return <<<PROMPT
|
|
You are the InvoiceShelf assistant, embedded in an invoicing application. You help {$userName} answer questions about **{$companyName}**'s data: invoices, estimates, payments, expenses, customers, and items.
|
|
|
|
Today is {$today}.
|
|
|
|
Rules:
|
|
- Use the provided tools whenever the user asks about specific records. Do not invent data.
|
|
- Only answer questions about {$companyName}'s data. If asked about another company or unrelated topics, politely decline.
|
|
- You cannot modify data — you are read-only. If the user asks you to create/update/delete something, explain that they need to do it in the UI.
|
|
- Be concise. Format responses in Markdown.
|
|
- If a tool returns an error or empty result, say so plainly and suggest a next step.
|
|
PROMPT;
|
|
}
|
|
|
|
/**
|
|
* Persist the assistant's tool_calls-turn message (the one that requested tools).
|
|
*/
|
|
protected function persistAssistantToolCallTurn(
|
|
AiConversation $conversation,
|
|
AiChatResponse $response,
|
|
string $model,
|
|
): void {
|
|
AiMessage::create([
|
|
'conversation_id' => $conversation->id,
|
|
'role' => AiMessage::ROLE_ASSISTANT,
|
|
'content' => $response->message, // usually null on a tool_calls turn
|
|
'tool_calls' => $response->toolCalls,
|
|
'model' => $model,
|
|
'tokens_in' => $response->usage['tokens_in'] ?? null,
|
|
'tokens_out' => $response->usage['tokens_out'] ?? null,
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Format the assistant tool-call turn for the NEXT driver call, in OpenAI format.
|
|
*
|
|
* @return array<string, mixed>
|
|
*/
|
|
protected function assistantToolCallMessage(AiChatResponse $response): array
|
|
{
|
|
return [
|
|
'role' => 'assistant',
|
|
'content' => $response->message,
|
|
'tool_calls' => array_map(function (array $call): array {
|
|
return [
|
|
'id' => $call['id'] ?? '',
|
|
'type' => 'function',
|
|
'function' => [
|
|
'name' => $call['name'] ?? '',
|
|
'arguments' => json_encode($call['arguments'] ?? [], JSON_UNESCAPED_UNICODE),
|
|
],
|
|
];
|
|
}, $response->toolCalls),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Call a tool and trap any exception — we want tool failures to be visible
|
|
* to the LLM as structured errors, not to crash the whole turn.
|
|
*
|
|
* @param array<string, mixed> $arguments
|
|
*/
|
|
protected function safelyExecuteTool(
|
|
string $name,
|
|
array $arguments,
|
|
int $companyId,
|
|
int $userId,
|
|
): mixed {
|
|
try {
|
|
return $this->toolRegistry->execute($name, $arguments, $companyId, $userId);
|
|
} catch (InvalidArgumentException $e) {
|
|
return ['error' => 'unknown_tool', 'message' => $e->getMessage()];
|
|
} catch (Throwable $e) {
|
|
return ['error' => 'tool_execution_failed', 'message' => $e->getMessage()];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Derive a short conversation title from the first user message.
|
|
*/
|
|
protected function titleFromMessage(string $message): string
|
|
{
|
|
$trimmed = trim(preg_replace('/\s+/', ' ', $message) ?? '');
|
|
if (mb_strlen($trimmed) <= 60) {
|
|
return $trimmed;
|
|
}
|
|
|
|
return rtrim(mb_substr($trimmed, 0, 57)).'...';
|
|
}
|
|
}
|