mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-16 22:05:20 +00:00
e861fc1fc1
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.
86 lines
3.0 KiB
PHP
86 lines
3.0 KiB
PHP
<?php
|
|
|
|
namespace App\Services\Ai\Tools;
|
|
|
|
use App\Models\Invoice;
|
|
|
|
/**
|
|
* Fetch one invoice's full details by invoice_number, including items and taxes.
|
|
*/
|
|
class GetInvoiceTool extends AiTool
|
|
{
|
|
public function name(): string
|
|
{
|
|
return 'get_invoice';
|
|
}
|
|
|
|
public function description(): string
|
|
{
|
|
return 'Fetch full details for a single invoice by its invoice_number, including line items, taxes, totals, customer info, and dates. Use this after search_invoices when the user wants more detail on a specific invoice.';
|
|
}
|
|
|
|
public function parameterSchema(): array
|
|
{
|
|
return [
|
|
'type' => 'object',
|
|
'properties' => [
|
|
'invoice_number' => [
|
|
'type' => 'string',
|
|
'description' => 'The invoice_number to look up (e.g. "INV-000001").',
|
|
],
|
|
],
|
|
'required' => ['invoice_number'],
|
|
];
|
|
}
|
|
|
|
public function execute(array $arguments, int $companyId, int $userId): mixed
|
|
{
|
|
$invoice = Invoice::query()
|
|
->where('company_id', $companyId)
|
|
->where('invoice_number', (string) ($arguments['invoice_number'] ?? ''))
|
|
->with(['customer:id,name,email,phone', 'items', 'taxes'])
|
|
->first();
|
|
|
|
if (! $invoice) {
|
|
return ['error' => 'invoice_not_found'];
|
|
}
|
|
|
|
return [
|
|
'invoice' => [
|
|
'id' => $invoice->id,
|
|
'invoice_number' => $invoice->invoice_number,
|
|
'reference_number' => $invoice->reference_number,
|
|
'status' => $invoice->status,
|
|
'paid_status' => $invoice->paid_status,
|
|
'invoice_date' => $this->asDate($invoice->invoice_date),
|
|
'due_date' => $this->asDate($invoice->due_date),
|
|
'sub_total' => $invoice->sub_total,
|
|
'tax' => $invoice->tax,
|
|
'discount' => $invoice->discount,
|
|
'total' => $invoice->total,
|
|
'due_amount' => $invoice->due_amount,
|
|
'overdue' => (bool) $invoice->overdue,
|
|
'notes' => $invoice->notes,
|
|
'customer' => $invoice->customer ? [
|
|
'id' => $invoice->customer->id,
|
|
'name' => $invoice->customer->name,
|
|
'email' => $invoice->customer->email,
|
|
'phone' => $invoice->customer->phone,
|
|
] : null,
|
|
'items' => $invoice->items->map(fn ($item): array => [
|
|
'name' => $item->name,
|
|
'description' => $item->description,
|
|
'quantity' => $item->quantity,
|
|
'price' => $item->price,
|
|
'total' => $item->total,
|
|
])->all(),
|
|
'taxes' => $invoice->taxes->map(fn ($tax): array => [
|
|
'name' => $tax->name,
|
|
'percent' => $tax->percent,
|
|
'amount' => $tax->amount,
|
|
])->all(),
|
|
],
|
|
];
|
|
}
|
|
}
|