mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-07-24 07:39:39 +02:00
Personal finance AI (v1) (#2022)
* AI sidebar * Add chat and message models with associations * Implement AI chat functionality with sidebar and messaging system - Add chat and messages controllers - Create chat and message views - Implement chat-related routes - Add message broadcasting and user interactions - Update application layout to support chat sidebar - Enhance user model with initials method * Refactor AI sidebar with enhanced chat menu and interactions - Update sidebar layout with dynamic width and improved responsiveness - Add new chat menu Stimulus controller for toggling between chat and chat list views - Improve chat list display with recent chats and empty state - Extract AI avatar to a partial for reusability - Enhance message display and interaction styling - Add more contextual buttons and interaction hints * Improve chat scroll behavior and message styling - Refactor chat scroll functionality with Stimulus controller - Optimize message scrolling in chat views - Update message styling for better visual hierarchy - Enhance chat container layout with flex and auto-scroll - Simplify message rendering across different chat views * Extract AI avatar to a shared partial for consistent styling - Refactor AI avatar rendering across chat views - Replace hardcoded avatar markup with a reusable partial - Simplify avatar display in chats and messages views * Update sidebar controller to handle right panel width dynamically - Add conditional width class for right sidebar panel - Ensure consistent sidebar toggle behavior for both left and right panels - Use specific width class for right panel (w-[375px]) * Refactor chat form and AI greeting with flexible partials - Extract message form to a reusable partial with dynamic context support - Create flexible AI greeting partial for consistent welcome messages - Simplify chat and sidebar views by leveraging new partials - Add support for different form scenarios (chat, new chat, sidebar) - Improve code modularity and reduce duplication * Add chat clearing functionality with dynamic menu options - Implement clear chat action in ChatsController - Add clear chat route to support clearing messages - Update AI sidebar with dropdown menu for chat actions - Preserve system message when clearing chat - Enhance chat interaction with new menu options * Add frontmatter to project structure documentation - Create initial frontmatter for structure.mdc file - Include description and configuration options - Prepare for potential dynamic documentation rendering * Update general project rules with additional guidelines - Add rule for using `Current.family` instead of `current_family` - Include new guidelines for testing, API routes, and solution approach - Expand project-specific rules for more consistent development practices * Add OpenAI gem and AI-friendly data representations - Add `ruby-openai` gem for AI integration - Implement `to_ai_readable_hash` methods in BalanceSheet and IncomeStatement - Include Promptable module in both models - Add savings rate calculation method in IncomeStatement - Prepare financial models for AI-powered insights and interactions * Enhance AI Financial Assistant with Advanced Querying and Debugging Capabilities - Implement comprehensive AI financial query system with function-based interactions - Add detailed debug logging for AI responses and function calls - Extend BalanceSheet and IncomeStatement models with AI-friendly methods - Create robust error handling and fallback mechanisms for AI queries - Update chat and message views to support debug mode and enhanced rendering - Add AI query routes and initial test coverage for financial assistant * Refactor AI sidebar and chat layout with improved structure and comments - Remove inline AI chat from application layout - Enhance AI sidebar with more semantic HTML structure - Add descriptive comments to clarify different sections of chat view - Improve flex layout and scrolling behavior in chat messages container - Optimize message rendering with more explicit class names and structure * Add Markdown rendering support for AI chat messages - Implement `markdown` helper method in ApplicationHelper using Redcarpet - Update message view to render AI messages with Markdown formatting - Add comprehensive Markdown rendering options (tables, code blocks, links) - Enhance AI Financial Assistant prompt to encourage Markdown usage - Remove commented Markdown CSS in Tailwind application stylesheet * Missing comma * Enhance AI response processing with chat history context * Improve AI debug logging with payload size limits and internal message flag * Enhance AI chat interaction with improved thinking indicator and scrolling behavior * Add AI consent and enable/disable functionality for AI chat * Upgrade Biome and refactor JavaScript template literals - Update @biomejs/biome to latest version with caret (^) notation - Refactor AI query and chat controllers to use template literals - Standardize npm scripts formatting in package.json * Add beta testing usage note to AI consent modal * Update test fixtures and configurations for AI chat functionality - Add family association to chat fixtures and tests - Set consistent password digest for test users - Enable AI for test users - Add OpenAI access token for test environment - Update chat and user model tests to include family context * Simplify data model and get tests passing * Remove structure.mdc from version control * Integrate AI chat styles into existing prose pattern * Match Figma design spec, implement Turbo frames and actions for chats controller * AI rules refresh * Consolidate Stimulus controllers, thinking state, controllers, and views * Naming, domain alignment * Reset migrations * Improve data model to support tool calls and message types * Tool calling tests and fixtures * Tool call implementation and test * Get assistant test working again * Test updates * Process tool calls within provider * Chat UI back to working state again * Remove stale code * Tests passing * Update openai class naming to avoid conflicts * Reconfigure test env * Rebuild gemfile * Fix naming conflicts for ChatResponse * Message styles * Use OpenAI conversation state management * Assistant function base implementation * Add back thinking messages, clean up error handling for chat * Fix sync error when security price has bad data from provider * Add balance sheet function to assistant * Add better function calling error visibility * Add income statement function * Simplify and clean up "thinking" interactions with Turbo frames * Remove stale data definitions from functions * Ensure VCR fixtures working with latest code * basic stream implementation * Get streaming working * Make AI sidebar wider when left sidebar is collapsed * Get tests working with streaming responses * Centralize provider error handling * Provider data boundaries --------- Co-authored-by: Josh Pigford <josh@joshpigford.com>
This commit is contained in:
Zach Gollwitzer
GitHub
parent
8e6b81af77
commit
2f6b11c18f
126 changed files with 3576 additions and 462 deletions
40
app/models/assistant/function/get_accounts.rb
Normal file
40
app/models/assistant/function/get_accounts.rb
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
class Assistant::Function::GetAccounts < Assistant::Function
|
||||
class << self
|
||||
def name
|
||||
"get_accounts"
|
||||
end
|
||||
|
||||
def description
|
||||
"Use this to see what accounts the user has along with their current and historical balances"
|
||||
end
|
||||
end
|
||||
|
||||
def call(params = {})
|
||||
{
|
||||
as_of_date: Date.current,
|
||||
accounts: family.accounts.includes(:balances).map do |account|
|
||||
{
|
||||
name: account.name,
|
||||
balance: account.balance,
|
||||
currency: account.currency,
|
||||
balance_formatted: account.balance_money.format,
|
||||
classification: account.classification,
|
||||
type: account.accountable_type,
|
||||
start_date: account.start_date,
|
||||
is_plaid_linked: account.plaid_account_id.present?,
|
||||
is_active: account.is_active,
|
||||
historical_balances: historical_balances(account)
|
||||
}
|
||||
end
|
||||
}
|
||||
end
|
||||
|
||||
private
|
||||
def historical_balances(account)
|
||||
start_date = [ account.start_date, 5.years.ago.to_date ].max
|
||||
period = Period.custom(start_date: start_date, end_date: Date.current)
|
||||
balance_series = account.balance_series(period: period, interval: "1 month")
|
||||
|
||||
to_ai_time_series(balance_series)
|
||||
end
|
||||
end
|
||||
73
app/models/assistant/function/get_balance_sheet.rb
Normal file
73
app/models/assistant/function/get_balance_sheet.rb
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
class Assistant::Function::GetBalanceSheet < Assistant::Function
|
||||
include ActiveSupport::NumberHelper
|
||||
|
||||
class << self
|
||||
def name
|
||||
"get_balance_sheet"
|
||||
end
|
||||
|
||||
def description
|
||||
<<~INSTRUCTIONS
|
||||
Use this to get the user's balance sheet with varying amounts of historical data.
|
||||
|
||||
This is great for answering questions like:
|
||||
- What is the user's net worth? What is it composed of?
|
||||
- How has the user's wealth changed over time?
|
||||
INSTRUCTIONS
|
||||
end
|
||||
end
|
||||
|
||||
def call(params = {})
|
||||
observation_start_date = [ 5.years.ago.to_date, family.oldest_entry_date ].max
|
||||
|
||||
period = Period.custom(start_date: observation_start_date, end_date: Date.current)
|
||||
|
||||
{
|
||||
as_of_date: Date.current,
|
||||
oldest_account_start_date: family.oldest_entry_date,
|
||||
currency: family.currency,
|
||||
net_worth: {
|
||||
current: family.balance_sheet.net_worth_money.format,
|
||||
monthly_history: historical_data(period)
|
||||
},
|
||||
assets: {
|
||||
current: family.balance_sheet.total_assets_money.format,
|
||||
monthly_history: historical_data(period, classification: "asset")
|
||||
},
|
||||
liabilities: {
|
||||
current: family.balance_sheet.total_liabilities_money.format,
|
||||
monthly_history: historical_data(period, classification: "liability")
|
||||
},
|
||||
insights: insights_data
|
||||
}
|
||||
end
|
||||
|
||||
private
|
||||
def historical_data(period, classification: nil)
|
||||
scope = family.accounts.active
|
||||
scope = scope.where(classification: classification) if classification.present?
|
||||
|
||||
if period.start_date == Date.current
|
||||
[]
|
||||
else
|
||||
balance_series = scope.balance_series(
|
||||
currency: family.currency,
|
||||
period: period,
|
||||
interval: "1 month",
|
||||
favorable_direction: "up",
|
||||
)
|
||||
|
||||
to_ai_time_series(balance_series)
|
||||
end
|
||||
end
|
||||
|
||||
def insights_data
|
||||
assets = family.balance_sheet.total_assets
|
||||
liabilities = family.balance_sheet.total_liabilities
|
||||
ratio = liabilities.zero? ? 0 : (liabilities / assets.to_f)
|
||||
|
||||
{
|
||||
debt_to_asset_ratio: number_to_percentage(ratio * 100, precision: 0)
|
||||
}
|
||||
end
|
||||
end
|
||||
125
app/models/assistant/function/get_income_statement.rb
Normal file
125
app/models/assistant/function/get_income_statement.rb
Normal file
|
|
@ -0,0 +1,125 @@
|
|||
class Assistant::Function::GetIncomeStatement < Assistant::Function
|
||||
include ActiveSupport::NumberHelper
|
||||
|
||||
class << self
|
||||
def name
|
||||
"get_income_statement"
|
||||
end
|
||||
|
||||
def description
|
||||
<<~INSTRUCTIONS
|
||||
Use this to get income and expense insights by category, for a specific time period
|
||||
|
||||
This is great for answering questions like:
|
||||
- What is the user's net income for the current month?
|
||||
- What are the user's spending habits?
|
||||
- How much income or spending did the user have over a specific time period?
|
||||
|
||||
Simple example:
|
||||
|
||||
```
|
||||
get_income_statement({
|
||||
start_date: "2024-01-01",
|
||||
end_date: "2024-12-31"
|
||||
})
|
||||
```
|
||||
INSTRUCTIONS
|
||||
end
|
||||
end
|
||||
|
||||
def call(params = {})
|
||||
period = Period.custom(start_date: Date.parse(params["start_date"]), end_date: Date.parse(params["end_date"]))
|
||||
income_data = family.income_statement.income_totals(period: period)
|
||||
expense_data = family.income_statement.expense_totals(period: period)
|
||||
|
||||
{
|
||||
currency: family.currency,
|
||||
period: {
|
||||
start_date: period.start_date,
|
||||
end_date: period.end_date
|
||||
},
|
||||
income: {
|
||||
total: format_money(income_data.total),
|
||||
by_category: to_ai_category_totals(income_data.category_totals)
|
||||
},
|
||||
expense: {
|
||||
total: format_money(expense_data.total),
|
||||
by_category: to_ai_category_totals(expense_data.category_totals)
|
||||
},
|
||||
insights: get_insights(income_data, expense_data)
|
||||
}
|
||||
end
|
||||
|
||||
def params_schema
|
||||
build_schema(
|
||||
required: [ "start_date", "end_date" ],
|
||||
properties: {
|
||||
start_date: {
|
||||
type: "string",
|
||||
description: "Start date for aggregation period in YYYY-MM-DD format"
|
||||
},
|
||||
end_date: {
|
||||
type: "string",
|
||||
description: "End date for aggregation period in YYYY-MM-DD format"
|
||||
}
|
||||
}
|
||||
)
|
||||
end
|
||||
|
||||
private
|
||||
def format_money(value)
|
||||
Money.new(value, family.currency).format
|
||||
end
|
||||
|
||||
def calculate_savings_rate(total_income, total_expenses)
|
||||
return 0 if total_income.zero?
|
||||
savings = total_income - total_expenses
|
||||
rate = (savings / total_income.to_f) * 100
|
||||
rate.round(2)
|
||||
end
|
||||
|
||||
def to_ai_category_totals(category_totals)
|
||||
hierarchical_groups = category_totals.group_by { |ct| ct.category.parent_id }.then do |grouped|
|
||||
root_category_totals = grouped[nil] || []
|
||||
|
||||
root_category_totals.each_with_object({}) do |ct, hash|
|
||||
subcategory_totals = ct.category.name == "Uncategorized" ? [] : (grouped[ct.category.id] || [])
|
||||
hash[ct.category.name] = {
|
||||
category_total: ct,
|
||||
subcategory_totals: subcategory_totals
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
hierarchical_groups.sort_by { |name, data| -data.dig(:category_total).total }.map do |name, data|
|
||||
{
|
||||
name: name,
|
||||
total: format_money(data.dig(:category_total).total),
|
||||
percentage_of_total: number_to_percentage(data.dig(:category_total).weight, precision: 1),
|
||||
subcategory_totals: data.dig(:subcategory_totals).map do |st|
|
||||
{
|
||||
name: st.category.name,
|
||||
total: format_money(st.total),
|
||||
percentage_of_total: number_to_percentage(st.weight, precision: 1)
|
||||
}
|
||||
end
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
def get_insights(income_data, expense_data)
|
||||
net_income = income_data.total - expense_data.total
|
||||
savings_rate = calculate_savings_rate(income_data.total, expense_data.total)
|
||||
median_monthly_income = family.income_statement.median_income
|
||||
median_monthly_expenses = family.income_statement.median_expense
|
||||
avg_monthly_expenses = family.income_statement.avg_expense
|
||||
|
||||
{
|
||||
net_income: format_money(net_income),
|
||||
savings_rate: number_to_percentage(savings_rate),
|
||||
median_monthly_income: format_money(median_monthly_income),
|
||||
median_monthly_expenses: format_money(median_monthly_expenses),
|
||||
avg_monthly_expenses: format_money(avg_monthly_expenses)
|
||||
}
|
||||
end
|
||||
end
|
||||
185
app/models/assistant/function/get_transactions.rb
Normal file
185
app/models/assistant/function/get_transactions.rb
Normal file
|
|
@ -0,0 +1,185 @@
|
|||
class Assistant::Function::GetTransactions < Assistant::Function
|
||||
include Pagy::Backend
|
||||
|
||||
class << self
|
||||
def default_page_size
|
||||
50
|
||||
end
|
||||
|
||||
def name
|
||||
"get_transactions"
|
||||
end
|
||||
|
||||
def description
|
||||
<<~INSTRUCTIONS
|
||||
Use this to search user's transactions by using various optional filters.
|
||||
|
||||
This function is great for things like:
|
||||
- Finding specific transactions
|
||||
- Getting basic stats about a small group of transactions
|
||||
|
||||
This function is not great for:
|
||||
- Large time periods (use the get_income_statement function for this)
|
||||
|
||||
Note on pagination:
|
||||
|
||||
This function can be paginated. You can expect the following properties in the response:
|
||||
|
||||
- `total_pages`: The total number of pages of results
|
||||
- `page`: The current page of results
|
||||
- `page_size`: The number of results per page (this will always be #{default_page_size})
|
||||
- `total_results`: The total number of results for the given filters
|
||||
- `total_income`: The total income for the given filters
|
||||
- `total_expenses`: The total expenses for the given filters
|
||||
|
||||
Simple example (transactions from the last 30 days):
|
||||
|
||||
```
|
||||
get_transactions({
|
||||
page: 1,
|
||||
start_date: "#{30.days.ago.to_date}",
|
||||
end_date: "#{Date.current}"
|
||||
})
|
||||
```
|
||||
|
||||
More complex example (various filters):
|
||||
|
||||
```
|
||||
get_transactions({
|
||||
page: 1,
|
||||
search: "mcdonalds",
|
||||
accounts: ["Checking", "Savings"],
|
||||
start_date: "#{30.days.ago.to_date}",
|
||||
end_date: "#{Date.current}",
|
||||
categories: ["Restaurants"],
|
||||
merchants: ["McDonald's"],
|
||||
tags: ["Food"],
|
||||
amount: "100",
|
||||
amount_operator: "less"
|
||||
})
|
||||
```
|
||||
INSTRUCTIONS
|
||||
end
|
||||
end
|
||||
|
||||
def strict_mode?
|
||||
false
|
||||
end
|
||||
|
||||
def params_schema
|
||||
build_schema(
|
||||
required: [ "order", "page", "page_size" ],
|
||||
properties: {
|
||||
page: {
|
||||
type: "integer",
|
||||
description: "Page number"
|
||||
},
|
||||
order: {
|
||||
enum: [ "asc", "desc" ],
|
||||
description: "Order of the transactions by date"
|
||||
},
|
||||
search: {
|
||||
type: "string",
|
||||
description: "Search for transactions by name"
|
||||
},
|
||||
amount: {
|
||||
type: "string",
|
||||
description: "Amount for transactions (must be used with amount_operator)"
|
||||
},
|
||||
amount_operator: {
|
||||
type: "string",
|
||||
description: "Operator for amount (must be used with amount)",
|
||||
enum: [ "equal", "less", "greater" ]
|
||||
},
|
||||
start_date: {
|
||||
type: "string",
|
||||
description: "Start date for transactions in YYYY-MM-DD format"
|
||||
},
|
||||
end_date: {
|
||||
type: "string",
|
||||
description: "End date for transactions in YYYY-MM-DD format"
|
||||
},
|
||||
accounts: {
|
||||
type: "array",
|
||||
description: "Filter transactions by account name",
|
||||
items: { enum: family_account_names },
|
||||
minItems: 1,
|
||||
uniqueItems: true
|
||||
},
|
||||
categories: {
|
||||
type: "array",
|
||||
description: "Filter transactions by category name",
|
||||
items: { enum: family_category_names },
|
||||
minItems: 1,
|
||||
uniqueItems: true
|
||||
},
|
||||
merchants: {
|
||||
type: "array",
|
||||
description: "Filter transactions by merchant name",
|
||||
items: { enum: family_merchant_names },
|
||||
minItems: 1,
|
||||
uniqueItems: true
|
||||
},
|
||||
tags: {
|
||||
type: "array",
|
||||
description: "Filter transactions by tag name",
|
||||
items: { enum: family_tag_names },
|
||||
minItems: 1,
|
||||
uniqueItems: true
|
||||
}
|
||||
}
|
||||
)
|
||||
end
|
||||
|
||||
def call(params = {})
|
||||
search_params = params.except("order", "page")
|
||||
|
||||
transactions_query = family.transactions.active.search(search_params)
|
||||
pagy_query = params["order"] == "asc" ? transactions_query.chronological : transactions_query.reverse_chronological
|
||||
|
||||
# By default, we give a small page size to force the AI to use filters effectively and save on tokens
|
||||
pagy, paginated_transactions = pagy(
|
||||
pagy_query.includes(
|
||||
{ entry: :account },
|
||||
:category, :merchant, :tags,
|
||||
transfer_as_outflow: { inflow_transaction: { entry: :account } },
|
||||
transfer_as_inflow: { outflow_transaction: { entry: :account } }
|
||||
),
|
||||
page: params["page"] || 1,
|
||||
limit: default_page_size
|
||||
)
|
||||
|
||||
totals = family.income_statement.totals(transactions_scope: transactions_query)
|
||||
|
||||
normalized_transactions = paginated_transactions.map do |txn|
|
||||
entry = txn.entry
|
||||
{
|
||||
date: entry.date,
|
||||
amount: entry.amount.abs,
|
||||
currency: entry.currency,
|
||||
formatted_amount: entry.amount_money.abs.format,
|
||||
classification: entry.amount < 0 ? "income" : "expense",
|
||||
account: entry.account.name,
|
||||
category: txn.category&.name,
|
||||
merchant: txn.merchant&.name,
|
||||
tags: txn.tags.map(&:name),
|
||||
is_transfer: txn.transfer.present?
|
||||
}
|
||||
end
|
||||
|
||||
{
|
||||
transactions: normalized_transactions,
|
||||
total_results: pagy.count,
|
||||
page: pagy.page,
|
||||
page_size: default_page_size,
|
||||
total_pages: pagy.pages,
|
||||
total_income: totals.income_money.format,
|
||||
total_expenses: totals.expense_money.format
|
||||
}
|
||||
end
|
||||
|
||||
private
|
||||
def default_page_size
|
||||
self.class.default_page_size
|
||||
end
|
||||
end
|
||||
Loading…
Add table
Add a link
Reference in a new issue