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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
use axum::{extract::State, http::StatusCode, response::Json};
use chrono::{Datelike, Duration, Month, NaiveDate};
use diesel::{BoolExpressionMethods, ExpressionMethods, QueryDsl, SelectableHelper};
use diesel_async::RunQueryDsl;
use pgvector::VectorExpressionMethods;
use schemars::schema_for;
use utoipa_axum::{router::OpenApiRouter, routes};

use crate::{
    models::{
        client::{EmbeddingPromptTemplate, EmbeddingRequest, RerankRequest},
        contacts::{
            Contact, ContactDeleteParams, ContactSearchParams, NewContact, NewContactRequest,
            UpdateContactRequest,
        },
        state::ToiState,
    },
    schema, utils,
};

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

pub fn contacts_router(state: ToiState) -> OpenApiRouter {
    OpenApiRouter::new()
        .routes(routes!(add_contact, update_matching_contact))
        .routes(routes!(delete_matching_contacts,))
        .routes(routes!(get_matching_contacts))
        .with_state(state)
}

pub async fn search_contacts(
    state: &ToiState,
    params: ContactSearchParams,
    conn: &mut utils::Conn<'_>,
) -> Result<Vec<i32>, (StatusCode, String)> {
    let ContactSearchParams {
        ids,
        birthday,
        birthday_falls_on,
        query,
        use_reranking_filter,
        created_from,
        created_to,
        order_by,
        limit,
    } = params;

    let mut sql_query = schema::contacts::table
        .select(Contact::as_select())
        .into_boxed();

    // Filter items created on or after date.
    if let Some(created_from) = created_from {
        sql_query = sql_query.filter(schema::contacts::created_at.ge(created_from));
    }

    // Filter items created on or before date.
    if let Some(created_to) = created_to {
        sql_query = sql_query.filter(schema::contacts::created_at.le(created_to));
    }

    // Filter items according to birthdays.
    if let Some(birthday) = birthday {
        match birthday_falls_on {
            Some(utils::DateFallsOn::Month) => {
                let year = birthday.year();
                let month = birthday.month();
                let num_days_in_month = {
                    let month = u8::try_from(month).map_err(|_| {
                        (
                            StatusCode::BAD_REQUEST,
                            "invalid birthday search month".to_string(),
                        )
                    })?;
                    let month = Month::try_from(month).map_err(|_| {
                        (
                            StatusCode::BAD_REQUEST,
                            "invalid birthday search month".to_string(),
                        )
                    })?;
                    month.num_days(year).ok_or((
                        StatusCode::BAD_REQUEST,
                        "invalid birthday search year".to_string(),
                    ))?
                };
                let first_day_of_month = NaiveDate::from_ymd_opt(year, month, 1).ok_or((
                    StatusCode::BAD_REQUEST,
                    "invalid birthday search".to_string(),
                ))?;
                let last_day_of_month =
                    NaiveDate::from_ymd_opt(year, month, num_days_in_month.into()).ok_or((
                        StatusCode::BAD_REQUEST,
                        "invalid birthday search".to_string(),
                    ))?;
                sql_query = sql_query.filter(
                    schema::contacts::birthday
                        .ge(first_day_of_month)
                        .and(schema::contacts::birthday.le(last_day_of_month)),
                );
            }
            Some(utils::DateFallsOn::Week) => {
                let num_days_from_sunday = birthday.weekday().num_days_from_sunday();
                let this_weeks_sunday = birthday - Duration::days(num_days_from_sunday.into());
                let this_weeks_saturday = this_weeks_sunday + Duration::days(6);
                sql_query = sql_query.filter(
                    schema::contacts::birthday
                        .ge(this_weeks_sunday)
                        .and(schema::contacts::birthday.le(this_weeks_saturday)),
                );
            }
            Some(utils::DateFallsOn::Day) | None => {
                sql_query = sql_query.filter(schema::contacts::birthday.eq(birthday));
            }
        }
    }

    // Order items.
    match order_by {
        Some(utils::OrderBy::Oldest) => sql_query = sql_query.order(schema::contacts::created_at),
        Some(utils::OrderBy::Newest) => {
            sql_query = sql_query.order(schema::contacts::created_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::contacts::embedding
                            .cosine_distance(embedding.clone())
                            .le(state.server_config.distance_threshold),
                    )
                    .order(schema::contacts::embedding.cosine_distance(embedding));
            }
        }
    }

    // Filter items according to their ids.
    if let Some(ids) = ids {
        sql_query = sql_query.or_filter(schema::contacts::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 contacts: Vec<Contact> = sql_query.load(conn).await.map_err(utils::diesel_error)?;
    let (ids, documents): (Vec<i32>, Vec<String>) = contacts
        .into_iter()
        .map(|contact| {
            let Contact {
                id,
                first_name,
                last_name,
                email,
                phone,
                birthday,
                relationship,
                ..
            } = contact;
            let new_contact_request = NewContactRequest {
                first_name,
                last_name,
                email,
                phone,
                birthday,
                relationship,
            };
            (id, new_contact_request.to_string())
        })
        .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 contact.
///
/// Example queries for adding contacts using this endpoint:
/// - Add a contact
/// - Remember this contact
/// - Make a contact
#[utoipa::path(
    post,
    path = "",
    extensions(
        ("x-json-schema-body" = json!(schema_for!(NewContactRequest)))
    ),
    request_body = NewContactRequest,
    responses(
        (status = 201, description = "Successfully added a contact", body = Contact),
        (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_contact(
    State(state): State<ToiState>,
    Json(params): Json<NewContactRequest>,
) -> Result<Json<Contact>, (StatusCode, String)> {
    let mut conn = state.pool.get().await.map_err(utils::internal_error)?;
    let embedding_request = EmbeddingRequest {
        input: params.to_string(),
    };
    let embedding = state.model_client.embed(embedding_request).await?;
    let NewContactRequest {
        first_name,
        last_name,
        email,
        phone,
        birthday,
        relationship,
    } = params;
    let new_contact = NewContact {
        first_name,
        last_name,
        email,
        phone,
        birthday,
        relationship,
        embedding,
    };
    let result = diesel::insert_into(schema::contacts::table)
        .values(new_contact)
        .returning(Contact::as_returning())
        .get_result(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    Ok(Json(result))
}

/// Delete and return contacts.
///
/// Example queries for deleting contacts using this endpoint:
/// - Delete all contacts
/// - Erase all contacts
/// - Remove contacts
#[utoipa::path(
    post,
    path = "/delete",
    extensions(
        ("x-json-schema-body" = json!(schema_for!(ContactDeleteParams)))
    ),
    request_body = ContactDeleteParams,
    responses(
        (status = 200, description = "Successfully deleted contacts", body = [Contact]),
        (status = 400, description = "Default JSON elements configured by the user are invalid"),
        (status = 404, description = "No contacts 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_contacts(
    State(state): State<ToiState>,
    Json(params): Json<ContactDeleteParams>,
) -> Result<Json<Vec<Contact>>, (StatusCode, String)> {
    let mut conn = state.pool.get().await.map_err(utils::internal_error)?;
    let ContactDeleteParams {
        ids,
        query,
        use_reranking_filter,
        created_from,
        created_to,
        order_by,
        limit,
    } = params;
    let params = ContactSearchParams {
        ids,
        birthday: None,
        birthday_falls_on: None,
        query,
        use_reranking_filter,
        created_from,
        created_to,
        order_by,
        limit,
    };
    let ids = search_contacts(&state, params, &mut conn).await?;
    let contacts = diesel::delete(schema::contacts::table.filter(schema::contacts::id.eq_any(ids)))
        .returning(Contact::as_returning())
        .load(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    Ok(Json(contacts))
}

/// Get contacts.
///
/// Example queries for getting contacts using this endpoint:
/// - Get all contacts
/// - List all contacts
/// - What contacts
/// - How many contacts
#[utoipa::path(
    post,
    path = "/search",
    extensions(
        ("x-json-schema-body" = json!(schema_for!(ContactSearchParams)))
    ),
    request_body = ContactSearchParams,
    responses(
        (status = 200, description = "Successfully got contacts", body = [Contact]),
        (status = 400, description = "Default JSON elements configured by the user are invalid"),
        (status = 404, description = "No contacts 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_contacts(
    State(state): State<ToiState>,
    Json(params): Json<ContactSearchParams>,
) -> Result<Json<Vec<Contact>>, (StatusCode, String)> {
    let mut conn = state.pool.get().await.map_err(utils::internal_error)?;
    let ids = search_contacts(&state, params, &mut conn).await?;
    let contacts = schema::contacts::table
        .select(Contact::as_select())
        .filter(schema::contacts::id.eq_any(ids))
        .load(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    Ok(Json(contacts))
}

/// Update and return a contact.
///
/// Example queries for updating a contact using this endpoint:
/// - Update my contact
/// - Update the birthday
/// - Update the email
/// - An update on my relationship
#[utoipa::path(
    put,
    path = "",
    extensions(
        ("x-json-schema-body" = json!(schema_for!(UpdateContactRequest)))
    ),
    request_body = UpdateContactRequest,
    responses(
        (status = 200, description = "Successfully updated contact", body = Contact),
        (status = 404, description = "Contact not found")
    )
)]
#[axum::debug_handler]
pub async fn update_matching_contact(
    State(state): State<ToiState>,
    Json(params): Json<UpdateContactRequest>,
) -> Result<Json<Contact>, (StatusCode, String)> {
    let mut conn = state.pool.get().await.map_err(utils::internal_error)?;
    let UpdateContactRequest {
        id,
        contact_updates,
        query,
        use_reranking_filter,
        created_from,
        created_to,
        order_by,
    } = params;
    let params = ContactSearchParams {
        ids: id.map(|i| vec![i]),
        birthday: None,
        birthday_falls_on: None,
        query,
        use_reranking_filter,
        created_from,
        created_to,
        order_by,
        limit: Some(1),
    };
    let id = search_contacts(&state, params, &mut conn)
        .await?
        .into_iter()
        .next()
        .ok_or((StatusCode::NOT_FOUND, "contact not found".to_string()))?;
    let mut contact = schema::contacts::table
        .select(Contact::as_select())
        .filter(schema::contacts::id.eq(id))
        .first(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    contact.update(contact_updates);
    let Contact {
        id,
        first_name,
        last_name,
        email,
        phone,
        birthday,
        relationship,
        ..
    } = contact;
    let new_contact_request = NewContactRequest {
        first_name,
        last_name,
        email,
        phone,
        birthday,
        relationship,
    };
    let embedding_request = EmbeddingRequest {
        input: new_contact_request.to_string(),
    };
    let embedding = state.model_client.embed(embedding_request).await?;
    let NewContactRequest {
        first_name,
        last_name,
        email,
        phone,
        birthday,
        relationship,
    } = new_contact_request;
    let new_contact = NewContact {
        first_name,
        last_name,
        email,
        phone,
        birthday,
        relationship,
        embedding,
    };
    let contact = diesel::update(schema::contacts::table.filter(schema::contacts::id.eq(id)))
        .set(&new_contact)
        .returning(Contact::as_returning())
        .get_result(&mut conn)
        .await
        .map_err(utils::diesel_error)?;
    Ok(Json(contact))
}