mirror of
https://github.com/we-promise/sure.git
synced 2026-04-12 08:37:22 +00:00
* feat: Add PDF import with AI-powered document analysis This enhances the import functionality to support PDF files with AI-powered document analysis. When a PDF is uploaded, it is processed by AI to: - Identify the document type (bank statement, credit card statement, etc.) - Generate a summary of the document contents - Extract key metadata (institution, dates, balances, transaction count) After processing, an email is sent to the user asking for next steps. Key changes: - Add PdfImport model for handling PDF document imports - Add Provider::Openai::PdfProcessor for AI document analysis - Add ProcessPdfJob for async PDF processing - Add PdfImportMailer for user notification emails - Update imports controller to detect and handle PDF uploads - Add PDF import option to the new import page - Add i18n translations for all new strings - Add comprehensive tests for the new functionality * Add bank statement import with AI extraction - Create ImportBankStatement assistant function for MCP - Add BankStatementExtractor with chunked processing for small context windows - Register function in assistant configurable - Make PdfImport#pdf_file_content public for extractor access - Increase OpenAI request timeout to 600s for slow local models - Increase DB connection pool to 20 for concurrent operations Tested with M-Pesa bank statement via remote Ollama (qwen3:8b): - Successfully extracted 18 transactions - Generated CSV and created TransactionImport - Works with 3000 char chunks for small context windows * Add pdf-reader gem dependency The BankStatementExtractor uses PDF::Reader to parse bank statement PDFs, but the gem was not properly declared in the Gemfile. This would cause NameError in production when processing bank statements. Added pdf-reader ~> 2.12 to Gemfile dependencies. * Fix transaction deduplication to preserve legitimate duplicates The previous deduplication logic removed ALL duplicate transactions based on [date, amount, name], which would drop legitimate same-day duplicates like multiple ATM withdrawals or card authorizations. Changed to only deduplicate transactions that appear in consecutive chunks (chunking artifacts) while preserving all legitimate duplicates within the same chunk or non-adjacent chunks. * Refactor bank statement extraction to use public provider method Address code review feedback: - Add public extract_bank_statement method to Provider::Openai - Remove direct access to private client via send(:client) - Update ImportBankStatement to use new public method - Add require 'set' to BankStatementExtractor - Remove PII-sensitive content from error logs - Add defensive check for nil response.error - Handle oversized PDF pages in chunking logic - Remove unused process_native and process_generic methods - Update email copy to reflect feature availability - Add guard for nil document_type in email template - Document pdf-reader gem rationale in Gemfile Tested with both OpenAI (gpt-4o) and Ollama (qwen3:8b): - OpenAI: 49 transactions extracted in 30s - Ollama: 40 transactions extracted in 368s - All encapsulation and error handling working correctly * Update schema.rb with ai_summary and document_type columns * Address PR #808 review comments - Rename :csv_file to :import_file across controllers/views/tests - Add PDF test fixture (sample_bank_statement.pdf) - Add supports_pdf_processing? method for graceful degradation - Revert unrelated database.yml pool change (600->3) - Remove month_start_day schema bleed from other PR - Fix PdfProcessor: use .strip instead of .strip_heredoc - Add server-side PDF magic byte validation - Conditionally show PDF import option when AI provider available - Fix ProcessPdfJob: sanitize errors, handle update failure - Move pdf_file attachment from Import to PdfImport - Document deduplication logic limitations - Fix ImportBankStatement: catch specific exceptions only - Remove unnecessary require 'set' - Remove dead json_schema method from PdfProcessor - Reduce default OpenAI timeout from 600s to 60s - Fix nil guard in text mailer template - Add require 'csv' to ImportBankStatement - Remove Gemfile pdf-reader comment * Fix RuboCop indentation in ProcessPdfJob * Refactor PDF import check to use model predicate method Replace is_a?(PdfImport) type check with requires_csv_workflow? predicate that leverages STI inheritance for cleaner controller logic. * Fix missing 'unknown' locale key and schema version mismatch - Add 'unknown: Unknown Document' to document_types locale - Fix schema version to match latest migration (2026_01_24_180211) * Document OPENAI_REQUEST_TIMEOUT env variable Added to .env.local.example and docs/hosting/ai.md * Rename ALLOWED_MIME_TYPES to ALLOWED_CSV_MIME_TYPES for clarity * Add comment explaining requires_csv_workflow? predicate * Remove redundant required_column_keys from PdfImport Base class already returns [] by default * Add ENV toggle to disable PDF processing for non-vision endpoints OPENAI_SUPPORTS_PDF_PROCESSING=false can be used for OpenAI-compatible endpoints (e.g., Ollama) that don't support vision/PDF processing. * Wire up transaction extraction for PDF bank statements - Add extracted_data JSONB column to imports - Add extract_transactions method to PdfImport - Call extraction in ProcessPdfJob for bank statements - Store transactions in extracted_data for later review * Fix ProcessPdfJob retry logic, sanitize and localize errors - Allow retries after partial success (classification ok, extraction failed) - Log sanitized error message instead of raw message to avoid data leakage - Use i18n for user-facing error messages * Add vision-capable model validation for PDF processing * Fix drag-and-drop test to use correct field name csv_file * Schema bleedover from another branch * Fix drag-drop import form field name to match controller * Add vision capability guard to process_pdf method --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: mkdev11 <jaysmth689+github@users.noreply.github.com> Co-authored-by: Juan José Mata <jjmata@jjmata.com>
85 lines
3.4 KiB
Ruby
85 lines
3.4 KiB
Ruby
module Assistant::Configurable
|
|
extend ActiveSupport::Concern
|
|
|
|
class_methods do
|
|
def config_for(chat)
|
|
preferred_currency = Money::Currency.new(chat.user.family.currency)
|
|
preferred_date_format = chat.user.family.date_format
|
|
|
|
{
|
|
instructions: default_instructions(preferred_currency, preferred_date_format),
|
|
functions: default_functions
|
|
}
|
|
end
|
|
|
|
private
|
|
def default_functions
|
|
[
|
|
Assistant::Function::GetTransactions,
|
|
Assistant::Function::GetAccounts,
|
|
Assistant::Function::GetHoldings,
|
|
Assistant::Function::GetBalanceSheet,
|
|
Assistant::Function::GetIncomeStatement,
|
|
Assistant::Function::ImportBankStatement
|
|
]
|
|
end
|
|
|
|
def default_instructions(preferred_currency, preferred_date_format)
|
|
<<~PROMPT
|
|
## Your identity
|
|
|
|
You are a friendly financial assistant for an open source personal finance application called "Sure", which is short for "Sure Finances".
|
|
|
|
## Your purpose
|
|
|
|
You help users understand their financial data by answering questions about their accounts, transactions, income, expenses, net worth, forecasting and more.
|
|
|
|
## Your rules
|
|
|
|
Follow all rules below at all times.
|
|
|
|
### General rules
|
|
|
|
- Provide ONLY the most important numbers and insights
|
|
- Eliminate all unnecessary words and context
|
|
- Ask follow-up questions to keep the conversation going. Help educate the user about their own data and entice them to ask more questions.
|
|
- Do NOT add introductions or conclusions
|
|
- Do NOT apologize or explain limitations
|
|
|
|
### Formatting rules
|
|
|
|
- Format all responses in markdown
|
|
- Format all monetary values according to the user's preferred currency
|
|
- Format dates in the user's preferred format: #{preferred_date_format}
|
|
|
|
#### User's preferred currency
|
|
|
|
Sure is a multi-currency app where each user has a "preferred currency" setting.
|
|
|
|
When no currency is specified, use the user's preferred currency for formatting and displaying monetary values.
|
|
|
|
- Symbol: #{preferred_currency.symbol}
|
|
- ISO code: #{preferred_currency.iso_code}
|
|
- Default precision: #{preferred_currency.default_precision}
|
|
- Default format: #{preferred_currency.default_format}
|
|
- Separator: #{preferred_currency.separator}
|
|
- Delimiter: #{preferred_currency.delimiter}
|
|
|
|
### Rules about financial advice
|
|
|
|
You should focus on educating the user about personal finance using their own data so they can make informed decisions.
|
|
|
|
- Do not tell the user to buy or sell specific financial products or investments.
|
|
- Do not make assumptions about the user's financial situation. Use the functions available to get the data you need.
|
|
|
|
### Function calling rules
|
|
|
|
- Use the functions available to you to get user financial data and enhance your responses
|
|
- For functions that require dates, use the current date as your reference point: #{Date.current}
|
|
- If you suspect that you do not have enough data to 100% accurately answer, be transparent about it and state exactly what
|
|
the data you're presenting represents and what context it is in (i.e. date range, account, etc.)
|
|
PROMPT
|
|
end
|
|
end
|
|
end
|