Repository navigation
This page is copied from
docs/ai.mdwhenever it changes. To correct it, open a pull request on that file.
CloudBank can use an AI model of your choice to write reports, propose budgets and point out what looks odd. It is off until you set it up, it uses your own key, and every job says what it sends before you switch it on.
In Settings → AI:
-
Your provider. Any service that speaks the OpenAI chat API: its address
(such as
https://api.openai.com/v1), the model, and your key. A model on your own network, such as Ollama or LM Studio, works too, but only an administrator can set an address on the local network. - Switch it on, then the jobs you want, one by one. Off, CloudBank sends nothing to any model.
- On which wallets. The AI works only on the wallets you tick.
The live demo has no AI.
CloudBank works out the numbers itself; the model only writes the words around them. Everything the model wrote sits in the AI box, a frame with a slowly changing border (still when your system asks for less motion, or when you turn it off in Settings → AI). Its Why? shows the numbers it was given, and the thumbs say whether it helped.
| Job | Where it shows |
|---|---|
| Monthly reports, and weekly or yearly ones if you tick them | AI insights, and a notification when one is written |
| Ask your data: a question in your own words, answered from the wallet's numbers | AI insights |
| Budget proposals: budgets from what you really spend | Budget and the overview |
| Subscription proposals: schedules that cost more, look doubled, or no longer appear in the bank | Schedules |
| Savings proposals: categories grown lately | AI insights and the overview |
| Goal proposals: goals behind, or with no date | Goals |
| Rule proposals: payees you always file under one category, a rule each | Rules |
| Payee cleanup: raw bank names (AMZN MKTP IT*2K3) grouped under one clean name, with a rule for the next imports | Payees |
| CSV columns: an unknown bank CSV's columns, date format, decimal and sign | The import's Map columns step |
| Unusual transactions: a payee far over its usual amount, a large new payee, a charge taken twice | Review, the overview and the bell |
| Category suggestion: one transaction's category, or a payee and a category for many at once | The entry sheet, and Review |
| Quick entry: a sentence, or text shared from your phone, turned into the fields | The entry sheet |
| Receipts: a receipt's photo turned into the fields | The entry sheet's Scan a receipt |
| Bank mails: the mails no pattern reads | Bank mails |
Ask your data works in two steps. The model first picks, from your question, up to three of CloudBank's own read-only queries (a total, a total by month or by category, the largest expenses, the account balances) with their period and filters; CloudBank runs them on this wallet alone; the model then answers in a sentence or three from what they returned. Under the answer, Numbers used lists each query and its result as CloudBank computed it. The model never writes a query and never sees a transaction. Questions are not kept: the earlier ones stay a click away until you leave the page.
Nothing the AI proposes is saved by itself: Apply and the like open the usual sheet, filled in, and you save it there.
Each job's switch says what it sends:
- Monthly reports: the month's totals by category, against the month before and your budgets, the three largest expenses (payee, amount and date) and next month's bills. Never the memos.
- Ask your data: your question, the names of your categories, accounts and tags and of your 200 busiest payees, then the results of the queries it picked. Never a transaction or a memo.
- Budget, subscription, savings and goal proposals: for each line proposed, its name and the figures behind the proposal. Never the transactions.
- Rule proposals: for each payee proposed, its name, its category and how many of its transactions have it. Never an amount, a memo or a date.
- Payee cleanup: the payee names only. Never an amount, a memo or a date.
- CSV columns: the column names and three rows' shapes: dates and numbers as written, a cell of words as "text, 3 words". Never the words.
- Unusual transactions: for each expense flagged, the payee, the date and the amount, with the payee's usual amount. Never the memo.
- Category suggestion: the payee and the amount, with your categories; in Review also the date, for each row it asks about. Never the bank's text.
- Quick entry: the sentence you write, with your categories, payees and tags.
- Receipts: the photo, once you press Read with AI, shrunk by your browser to at most 1600 pixels and without the place it was taken, with your categories, payees and tags. The photo is never stored on the server unless you attach it to the transaction; What was sent shows a line about it instead of the photo. The model must read images: a provider that refuses the photo says so.
- Bank mails: the mail's text, with card numbers and IBANs hidden first.
What was sent, at the foot of Settings → AI, lists the last 90 days word for word.
-
Your key stays on the server: it is never sent back to the browser, and
with
CB_SECRET_KEYset it is stored encrypted (Configuration). - What the AI writes is yours alone. In a shared wallet the other members see none of your reports or proposals.
- Notifications about unusual transactions leave out the amount on push, email and chat when you chose to keep amounts out of them (Notifications).
Requests a month caps how many calls CloudBank makes for you. At the limit, bank mails are no longer read by the AI, what you ask for yourself (Generate now, a quick entry, a receipt, a question) asks before going past it, and reports that would come by themselves are skipped; the bell says so once. The count starts again on the first of the month. A question counts twice: one request to pick the queries, one to answer.
Start here
Using CloudBank
- Using CloudBank, page by page
- Importing transactions
- Automatic bank sync
- Bank mails
- Notifications
- The AI, and what it sees
- CloudBank in Home Assistant
- Adding from your phone
- Ask your data
- Schedules in your phone's calendar
Running CloudBank
Extending CloudBank
Project