toi_server 0.1.1

A personal assistant server
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
use axum::{extract::State, http::StatusCode, response::Json};
use diesel::{ExpressionMethods, QueryDsl, SelectableHelper};
use diesel_async::RunQueryDsl;
use pgvector::VectorExpressionMethods;
use schemars::schema_for;
use utoipa_axum::{router::OpenApiRouter, routes};

use crate::{
    models::{
        accounts::{BankAccount, BankAccountSearchParams},
        client::{EmbeddingPromptTemplate, EmbeddingRequest, RerankRequest},
        state::ToiState,
        transactions::{
            BankAccountHistory, BankAccountTransaction, BankAccountTransactionSearchParams,
            LinkedTransaction, NewBankAccountTransactionRequest, NewLinkedTransaction, Transaction,
            TransactionSearchParams,
        },
    },
    routes::accounts::search_bank_accounts,
    schema, utils,
};

// Prefixes are used for embedding instructions.
const INSTRUCTION_PREFIX: &str =
    "Instruction: Given a user query, find transactions stored with details that the user mentions";
const QUERY_PREFIX: &str = "Query: ";

pub fn bank_account_transactions_router(state: ToiState) -> OpenApiRouter {
    OpenApiRouter::new()
        .routes(routes!(add_bank_account_transaction))
        .routes(routes!(delete_matching_bank_account_transactions))
        .routes(routes!(get_matching_bank_account_transactions))
        .with_state(state)
}

pub fn transactions_router(state: ToiState) -> OpenApiRouter {
    OpenApiRouter::new()
        .routes(routes!(delete_matching_transactions))
        .routes(routes!(get_matching_transactions))
        .with_state(state)
}

pub async fn search_bank_account_transactions(
    state: &ToiState,
    params: BankAccountTransactionSearchParams,
    conn: &mut utils::Conn<'_>,
) -> Result<(BankAccount, Vec<i32>), (StatusCode, String)> {
    let BankAccountTransactionSearchParams {
        bank_account_id,
        bank_account_query,
        bank_account_use_reranking_filter,
        bank_account_created_from,
        bank_account_created_to,
        bank_account_order_by,
        transaction_ids,
        transaction_query,
        transaction_use_reranking_filter,
        transaction_posted_from,
        transaction_posted_to,
        transaction_order_by,
        transaction_limit,
    } = params;
    let bank_account_query_params = BankAccountSearchParams {
        ids: bank_account_id.map(|i| vec![i]),
        query: bank_account_query,
        use_reranking_filter: bank_account_use_reranking_filter,
        created_from: bank_account_created_from,
        created_to: bank_account_created_to,
        order_by: bank_account_order_by,
        limit: Some(1),
    };
    let bank_account_id = search_bank_accounts(state, bank_account_query_params, conn)
        .await?
        .into_iter()
        .next()
        .ok_or((StatusCode::NOT_FOUND, "bank account not found".to_string()))?;
    let bank_account = schema::bank_accounts::table
        .select(BankAccount::as_select())
        .filter(schema::bank_accounts::id.eq(bank_account_id))
        .first(conn)
        .await
        .map_err(utils::diesel_error)?;

    let transaction_query_params = TransactionSearchParams {
        bank_account_id: Some(bank_account.id),
        ids: transaction_ids,
        query: transaction_query,
        use_reranking_filter: transaction_use_reranking_filter,
        posted_from: transaction_posted_from,
        posted_to: transaction_posted_to,
        order_by: transaction_order_by,
        limit: transaction_limit,
    };
    let transaction_ids = search_transactions(state, transaction_query_params, conn).await?;
    Ok((bank_account, transaction_ids))
}

pub async fn search_transactions(
    state: &ToiState,
    params: TransactionSearchParams,
    conn: &mut utils::Conn<'_>,
) -> Result<Vec<i32>, (StatusCode, String)> {
    let TransactionSearchParams {
        bank_account_id,
        ids,
        query,
        use_reranking_filter,
        posted_from,
        posted_to,
        order_by,
        limit,
    } = params;

    let mut sql_query = schema::transactions::table
        .select(Transaction::as_select())
        .into_boxed();

    // Filter items based on parent ID.
    if let Some(bank_account_id) = bank_account_id {
        sql_query = sql_query.filter(schema::transactions::bank_account_id.eq(bank_account_id));
    }

    // Filter items created on or after date.
    if let Some(posted_from) = posted_from {
        sql_query = sql_query.filter(schema::transactions::posted_at.ge(posted_from));
    }

    // Filter items created on or before date.
    if let Some(posted_to) = posted_to {
        sql_query = sql_query.filter(schema::transactions::posted_at.le(posted_to));
    }

    // Order items.
    match order_by {
        Some(utils::OrderBy::Oldest) => {
            sql_query = sql_query.order(schema::transactions::posted_at);
        }
        Some(utils::OrderBy::Newest) => {
            sql_query = sql_query.order(schema::transactions::posted_at.desc());
        }
        None => {
            // By default, filter items similar to a given query.
            if let Some(ref query) = query {
                let input = EmbeddingPromptTemplate::builder()
                    .instruction_prefix(INSTRUCTION_PREFIX.to_string())
                    .query_prefix(QUERY_PREFIX.to_string())
                    .build()
                    .apply(query);
                let embedding_request = EmbeddingRequest { input };
                let embedding = state.model_client.embed(embedding_request).await?;
                sql_query = sql_query
                    .filter(
                        schema::transactions::embedding
                            .cosine_distance(embedding.clone())
                            .le(state.server_config.distance_threshold),
                    )
                    .order(schema::transactions::embedding.cosine_distance(embedding));
            }
        }
    }

    // Filter items according to their ids.
    if let Some(ids) = ids {
        sql_query = sql_query.or_filter(schema::transactions::id.eq_any(ids));
    }

    // Limit number of items.
    if let Some(limit) = limit {
        sql_query = sql_query.limit(limit);
    }

    // Get all the items that match the query.
    let transactions: Vec<Transaction> = sql_query.load(conn).await.map_err(utils::diesel_error)?;
    let (ids, documents): (Vec<i32>, Vec<String>) = transactions
        .into_iter()
        .map(|transaction| (transaction.id, transaction.description))
        .unzip();
    if ids.is_empty() {
        return Ok(ids);
    }

    // Rerank and filter items once more.
    let ids = match (query, use_reranking_filter) {
        (Some(query), Some(true)) => {
            let rerank_request = RerankRequest { query, documents };
            let rerank_response = state.model_client.rerank(rerank_request).await?;
            rerank_response
                .results
                .into_iter()
                .filter(|item| item.relevance_score >= state.server_config.similarity_threshold)
                .map(|item| ids[item.index])
                .collect()
        }
        _ => ids,
    };

    Ok(ids)
}

/// Add and return a bank account transaction.
///
/// Example queries for adding bank account transactions using this endpoint:
/// - Add a bank account transaction to
/// - Remember this bank account transaction for
/// - Make a bank account transaction for
#[utoipa::path(
    post,
    path = "",
    extensions(
        ("x-json-schema-body" = json!(schema_for!(NewBankAccountTransactionRequest)))
    ),
    request_body = NewBankAccountTransactionRequest,
    responses(
        (status = 201, description = "Successfully added a transaction", body = BankAccountTransaction),
        (status = 400, description = "Default JSON elements configured by the user are invalid"),
        (status = 422, description = "Error when parsing a response from a model API"),
        (status = 502, description = "Error when forwarding request to model APIs")
    )
)]
#[axum::debug_handler]
pub async fn add_bank_account_transaction(
    State(state): State<ToiState>,
    Json(params): Json<NewBankAccountTransactionRequest>,
) -> Result<Json<BankAccountTransaction>, (StatusCode, String)> {
    let mut conn = state.pool.get().await.map_err(utils::internal_error)?;
    let NewBankAccountTransactionRequest {
        bank_account_id,
        bank_account_query,
        bank_account_use_reranking_filter,
        bank_account_created_from,
        bank_account_created_to,
        bank_account_order_by,
        transaction_description,
        transaction_amount,
        transaction_posted_at,
    } = params;
    let bank_account_query_params = BankAccountSearchParams {
        ids: bank_account_id.map(|i| vec![i]),
        query: bank_account_query,
        use_reranking_filter: bank_account_use_reranking_filter,
        created_from: bank_account_created_from,
        created_to: bank_account_created_to,
        order_by: bank_account_order_by,
        limit: Some(1),
    };
    let bank_account_id = search_bank_accounts(&state, bank_account_query_params, &mut conn)
        .await?
        .into_iter()
        .next()
        .ok_or((StatusCode::NOT_FOUND, "bank account not found".to_string()))?;
    let bank_account = schema::bank_accounts::table
        .select(BankAccount::as_select())
        .filter(schema::bank_accounts::id.eq(bank_account_id))
        .first(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    let embedding_request = EmbeddingRequest {
        input: transaction_description.clone(),
    };
    let embedding = state.model_client.embed(embedding_request).await?;
    let new_transaction = NewLinkedTransaction {
        bank_account_id: bank_account.id,
        description: transaction_description,
        amount: transaction_amount,
        embedding,
        posted_at: transaction_posted_at,
    };
    let transaction = diesel::insert_into(schema::transactions::table)
        .values(new_transaction)
        .returning(Transaction::as_returning())
        .get_result(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    let bank_account_transaction = BankAccountTransaction {
        bank_account,
        transaction,
    };
    Ok(Json(bank_account_transaction))
}

/// Delete and return bank account transactions.
///
/// Example queries for deleting bank account transactions using this endpoint:
/// - Delete all bank account transactions with
/// - Erase all bank account transactions for
/// - Remove bank account transactions for
/// - Delete bank account transactions
#[utoipa::path(
    post,
    path = "/delete",
    extensions(
        ("x-json-schema-body" = json!(schema_for!(BankAccountTransactionSearchParams)))
    ),
    request_body = BankAccountTransactionSearchParams,
    responses(
        (status = 200, description = "Successfully deleted transactions", body = BankAccountHistory),
        (status = 400, description = "Default JSON elements configured by the user are invalid"),
        (status = 404, description = "No bank account or transactions found"),
        (status = 422, description = "Error when parsing a response from a model API"),
        (status = 502, description = "Error when forwarding request to model APIs")
    )
)]
#[axum::debug_handler]
pub async fn delete_matching_bank_account_transactions(
    State(state): State<ToiState>,
    Json(params): Json<BankAccountTransactionSearchParams>,
) -> Result<Json<BankAccountHistory>, (StatusCode, String)> {
    let mut conn = state.pool.get().await.map_err(utils::internal_error)?;
    let (bank_account, transaction_ids) =
        search_bank_account_transactions(&state, params, &mut conn).await?;
    let transactions = diesel::delete(schema::transactions::table)
        .filter(schema::transactions::id.eq_any(transaction_ids))
        .returning(Transaction::as_returning())
        .load(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    let bank_account_history = BankAccountHistory {
        bank_account,
        transactions,
    };
    Ok(Json(bank_account_history))
}

/// Delete and return transactions.
///
/// Example queries for deleting transactions using this endpoint:
/// - Delete all transactions with
/// - Erase all transactions for
/// - Remove transactions for
/// - Delete transactions
#[utoipa::path(
    post,
    path = "/delete",
    extensions(
        ("x-json-schema-body" = json!(schema_for!(TransactionSearchParams)))
    ),
    request_body = TransactionSearchParams,
    responses(
        (status = 200, description = "Successfully deleted transactions", body = [LinkedTransaction]),
        (status = 400, description = "Default JSON elements configured by the user are invalid"),
        (status = 404, description = "No transactions found"),
        (status = 422, description = "Error when parsing a response from a model API"),
        (status = 502, description = "Error when forwarding request to model APIs")
    )
)]
#[axum::debug_handler]
pub async fn delete_matching_transactions(
    State(state): State<ToiState>,
    Json(params): Json<TransactionSearchParams>,
) -> Result<Json<Vec<LinkedTransaction>>, (StatusCode, String)> {
    let mut conn = state.pool.get().await.map_err(utils::internal_error)?;
    let transaction_ids = search_transactions(&state, params, &mut conn).await?;
    let linked_transactions = diesel::delete(schema::transactions::table)
        .filter(schema::transactions::id.eq_any(transaction_ids))
        .returning(LinkedTransaction::as_returning())
        .load(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    Ok(Json(linked_transactions))
}

/// Get bank account transactions.
///
/// Example queries for getting bank account transactions using this endpoint:
/// - Get all bank account transactions where
/// - List all bank account transactions for
/// - What bank account transactions do I have
/// - How many bank account transactions do I have
#[utoipa::path(
    post,
    path = "/search",
    extensions(
        ("x-json-schema-body" = json!(schema_for!(BankAccountTransactionSearchParams)))
    ),
    request_body = BankAccountTransactionSearchParams,
    responses(
        (status = 200, description = "Successfully got transactions", body = BankAccountHistory),
        (status = 400, description = "Default JSON elements configured by the user are invalid"),
        (status = 404, description = "No bank account or transactions found"),
        (status = 422, description = "Error when parsing a response from a model API"),
        (status = 502, description = "Error when forwarding request to model APIs")
    )
)]
#[axum::debug_handler]
pub async fn get_matching_bank_account_transactions(
    State(state): State<ToiState>,
    Json(params): Json<BankAccountTransactionSearchParams>,
) -> Result<Json<BankAccountHistory>, (StatusCode, String)> {
    let mut conn = state.pool.get().await.map_err(utils::internal_error)?;
    let (bank_account, transaction_ids) =
        search_bank_account_transactions(&state, params, &mut conn).await?;
    let transactions = schema::transactions::table
        .select(Transaction::as_select())
        .filter(schema::transactions::id.eq_any(transaction_ids))
        .load(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    let bank_account_history = BankAccountHistory {
        bank_account,
        transactions,
    };
    Ok(Json(bank_account_history))
}

/// Get transactions.
///
/// Example queries for getting transactions using this endpoint:
/// - Get all transactions where
/// - List all transactions
/// - What transactions do I have
/// - How many transactions do I have
#[utoipa::path(
    post,
    path = "/search",
    extensions(
        ("x-json-schema-body" = json!(schema_for!(TransactionSearchParams)))
    ),
    request_body = TransactionSearchParams,
    responses(
        (status = 200, description = "Successfully got transactions", body = [LinkedTransaction]),
        (status = 400, description = "Default JSON elements configured by the user are invalid"),
        (status = 404, description = "No transactions found"),
        (status = 422, description = "Error when parsing a response from a model API"),
        (status = 502, description = "Error when forwarding request to model APIs")
    )
)]
#[axum::debug_handler]
pub async fn get_matching_transactions(
    State(state): State<ToiState>,
    Json(params): Json<TransactionSearchParams>,
) -> Result<Json<Vec<LinkedTransaction>>, (StatusCode, String)> {
    let mut conn = state.pool.get().await.map_err(utils::internal_error)?;
    let transaction_ids = search_transactions(&state, params, &mut conn).await?;
    let linked_transactions = schema::transactions::table
        .select(LinkedTransaction::as_select())
        .filter(schema::transactions::id.eq_any(transaction_ids))
        .load(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    Ok(Json(linked_transactions))
}