-
Notifications
You must be signed in to change notification settings - Fork 9
/
utils.R
679 lines (572 loc) · 21.4 KB
/
utils.R
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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
#' Test connection to Ollama server
#'
#' @description
#' `test_connection()` tests whether the Ollama server is running or not.
#'
#' @param url The URL of the Ollama server. Default is http://localhost:11434
#'
#' @return A httr2 response object.
#' @export
#'
#' @examples
#' test_connection()
#' test_connection("http://localhost:11434") # default url
#' test_connection("http://127.0.0.1:11434")
test_connection <- function(url = "http://localhost:11434") {
req <- httr2::request(url)
req <- httr2::req_method(req, "GET")
tryCatch(
{
resp <- httr2::req_perform(req)
message("Ollama local server running")
return(resp)
},
error = function(e) {
message("Ollama local server not running or wrong server.\nDownload and launch Ollama app to run the server. Visit https://ollama.com or https://github.com/ollama/ollama")
req$status_code <- 503
return(req)
}
)
}
#' Stream handler helper function
#'
#' Function to handle streaming.
#'
#' @keywords internal
stream_handler <- function(x, env, endpoint) {
s <- rawToChar(x)
env$accumulated_data <- append(env$accumulated_data, x)
json_strings <- strsplit(s, "\n")[[1]]
for (i in seq_along(json_strings)) {
tryCatch(
{
json_string <- paste0(env$buffer, json_strings[i], "\n", collapse = "")
if (endpoint == "/api/generate") {
stream_content <- jsonlite::fromJSON(json_string)$response
} else if (endpoint == "/api/chat") {
stream_content <- jsonlite::fromJSON(json_string)$message$content
} else if (endpoint %in% c("/api/pull", "/api/push")) {
stream_content <- jsonlite::fromJSON(json_string)$status
stream_content <- paste0(stream_content, "\n")
}
# concatenate the content
env$content <- c(env$content, stream_content)
env$buffer <- ""
cat(stream_content) # stream/print stream
},
error = function(e) {
env$buffer <- paste0(env$buffer, json_strings[i])
}
)
}
return(TRUE)
}
#' Process httr2 response object
#'
#' @param resp A httr2 response object.
#' @param output The output format. Default is "df". Other options are "jsonlist", "raw", "resp" (httr2 response object), "text"
#'
#' @return A data frame, json list, raw or httr2 response object.
#' @export
#'
#' @examplesIf test_connection()$status_code == 200
#' resp <- list_models("resp")
#' resp_process(resp, "df") # parse response to dataframe/tibble
#' resp_process(resp, "jsonlist") # parse response to list
#' resp_process(resp, "raw") # parse response to raw string
#' resp_process(resp, "resp") # return input response object
#' resp_process(resp, "text") # return text/character vector
resp_process <- function(resp, output = c("df", "jsonlist", "raw", "resp", "text")) {
if (!inherits(resp, "httr2_response")) {
stop("Input must be a httr2 response object")
}
if (is.null(resp) || resp$status_code != 200) {
stop("Cannot process response")
}
endpoints_to_skip <- c("api/delete", "api/embed", "api/embeddings", "api/create")
for (endpoint in endpoints_to_skip) {
if (grepl(endpoint, resp$url)) {
message("Returning response object because resp_process not supported for this endpoint.")
return(resp)
}
}
output <- output[1]
if (output == "resp") {
return(resp)
}
# process stream resp separately
stream <- FALSE
headers <- httr2::resp_headers(resp)
# if response is chunked, then it was a streamed output
transfer_encoding <- headers$`Transfer-Encoding`
if (!is.null(transfer_encoding)) {
stream <- grepl("chunked", transfer_encoding)
}
# endpoints that should never be processed with resp_process_stream
endpoints_without_stream <- c("api/tags", "api/delete", "api/show", "api/ps")
for (endpoint in endpoints_without_stream) {
if (grepl(endpoint, resp$url)) {
stream <- FALSE
break
}
}
if (stream) {
return(resp_process_stream(resp, output))
}
# process non-stream response below
if (output == "raw") {
return(rawToChar(resp$body))
} else if (output == "jsonlist") {
tryCatch({
return(httr2::resp_body_json(resp))
}, error = function(e) {})
}
# process different endpoints
if (grepl("api/generate", resp$url)) { # process generate endpoint
json_body <- httr2::resp_body_json(resp)
df_response <- tibble::tibble(
model = json_body$model,
response = json_body$response,
created_at = json_body$created_at
)
if (output == "df") {
return(df_response)
} else if (output == "text") {
return(df_response$response)
}
} else if (grepl("api/chat", resp$url)) { # process chat endpoint
json_body <- httr2::resp_body_json(resp)
df_response <- tibble::tibble(
model = json_body$model,
role = json_body$message$role,
content = json_body$message$content,
created_at = json_body$created_at
)
if (output == "df") {
return(df_response)
} else if (output == "text") {
return(df_response$content)
}
} else if (grepl("api/tags", resp$url)) { # process tags endpoint
json_body <- httr2::resp_body_json(resp)[[1]]
df_response <- tibble::tibble(
name = character(length(json_body)),
size = character(length(json_body)),
parameter_size = character(length(json_body)),
quantization_level = character(length(json_body)),
modified = character(length(json_body))
)
for (i in seq_along(json_body)) {
df_response[i, "name"] <- json_body[[i]]$name
size <- json_body[[i]]$size / 10^9
df_response[i, "size"] <- ifelse(size > 1, paste0(round(size, 1), " GB"), paste0(round(size * 1000), " MB"))
df_response[i, "parameter_size"] <- json_body[[i]]$details$parameter_size
df_response[i, "quantization_level"] <- json_body[[i]]$details$quantization_level
df_response[i, "modified"] <- strsplit(json_body[[i]]$modified_at, ".", fixed = TRUE)[[1]][1]
}
df_response <- df_response[order(df_response$name, df_response$size), ]
if (output == "df") {
return(data.frame(df_response))
} else if (output == "text") {
return(df_response$name)
}
} else if (grepl("api/show", resp$url)) {
if (output %in% c("df", "text")) stop("Output format not supported for this endpoint: Only 'jsonlist' and 'raw' are supported.")
} else if (grepl("api/ps", resp$url)) {
json_body <- httr2::resp_body_json(resp)$models
df_response <- tibble::tibble(
name = character(length(json_body)),
size = character(length(json_body)),
parameter_size = character(length(json_body)),
quantization_level = character(length(json_body)),
digest = character(length(json_body)),
expires_at = character(length(json_body)),
)
for (i in seq_along(json_body)) {
df_response[i, "name"] <- json_body[[i]]$name
size <- json_body[[i]]$size / 10^9
df_response[i, "size"] <- ifelse(size > 1, paste0(round(size, 1), " GB"), paste0(round(size * 1000), " MB"))
df_response[i, "parameter_size"] <- json_body[[i]]$details$parameter_size
df_response[i, "quantization_level"] <- json_body[[i]]$details$quantization_level
df_response[i, "digest"] <- json_body[[i]]$details$parameter_size
df_response[i, "expires_at"] <- json_body[[i]]$expires_at
}
if (output == "df") {
return(data.frame(df_response))
} else if (output == "text") {
return(df_response$name)
}
}
}
#' Process httr2 response object for streaming
#'
#' @keywords internal
resp_process_stream <- function(resp, output) {
if (output == "raw") {
return(rawToChar(resp$body))
}
if (grepl("api/generate", resp$url)) { # process generate endpoint
json_lines <- strsplit(rawToChar(resp$body), "\n")[[1]]
json_lines_output <- vector("list", length = length(json_lines))
df_response <- tibble::tibble(
model = character(length(json_lines_output)),
response = character(length(json_lines_output)),
created_at = character(length(json_lines_output))
)
for (i in seq_along(json_lines)) {
json_lines_output[[i]] <- jsonlite::fromJSON(json_lines[[i]])
df_response$model[i] <- json_lines_output[[i]]$model
df_response$response[i] <- json_lines_output[[i]]$response
df_response$created_at[i] <- json_lines_output[[i]]$created_at
}
if (output == "jsonlist") {
return(json_lines_output)
}
if (output == "df") {
return(df_response)
}
if (output == "text") {
return(paste0(df_response$response, collapse = ""))
}
} else if (grepl("api/chat", resp$url)) { # process chat endpoint
json_lines <- strsplit(rawToChar(resp$body), "\n")[[1]]
json_lines_output <- vector("list", length = length(json_lines))
df_response <- tibble::tibble(
model = character(length(json_lines_output)),
role = character(length(json_lines_output)),
content = character(length(json_lines_output)),
created_at = character(length(json_lines_output))
)
for (i in seq_along(json_lines)) {
json_lines_output[[i]] <- jsonlite::fromJSON(json_lines[[i]])
df_response$model[i] <- json_lines_output[[i]]$model
df_response$role[i] <- json_lines_output[[i]]$message$role
df_response$content[i] <- json_lines_output[[i]]$message$content
df_response$created_at[i] <- json_lines_output[[i]]$created_at
}
if (output[1] == "jsonlist") {
return(json_lines_output)
}
if (output[1] == "df") {
return(df_response)
}
if (output[1] == "text") {
return(paste0(df_response$content, collapse = ""))
}
} else if (grepl("api/pull", resp$url)) {
json_lines <- strsplit(rawToChar(resp$body), "\n")[[1]]
json_lines_output <- vector("list", length = length(json_lines))
df_response <- tibble::tibble(
status = character(length(json_lines_output)),
)
for (i in seq_along(json_lines)) {
json_lines_output[[i]] <- jsonlite::fromJSON(json_lines[[i]])
df_response$status[i] <- json_lines_output[[i]]$status
}
if (output[1] == "jsonlist") {
return(json_lines_output)
}
if (output[1] == "df") {
return(df_response)
}
if (output[1] == "text") {
return(paste0(df_response$status, collapse = ""))
}
} else if (grepl("api/push", resp$url)) {
json_lines <- strsplit(rawToChar(resp$body), "\n")[[1]]
json_lines_output <- vector("list", length = length(json_lines))
df_response <- tibble::tibble(
status = character(length(json_lines_output))
)
for (i in seq_along(json_lines)) {
json_lines_output[[i]] <- jsonlite::fromJSON(json_lines[i])
if (grepl("error", json_lines[i])) {
df_response$status[i] <- "error"
} else if (grepl("success", json_lines[i])) {
df_response$status[i] <- "success"
} else {
df_response$status[i] <- json_lines_output[[i]]$status
}
}
if (output[1] == "jsonlist") {
return(json_lines_output)
}
if (output[1] == "df") {
return(df_response)
}
if (output[1] == "text") {
return(paste0(df_response$status, collapse = ""))
}
}
}
#' Read image file and encode it to base64
#'
#' @param image_path The path to the image file.
#'
#' @return A base64 encoded string.
#' @export
#'
#' @examples
#' image_path <- file.path(system.file("extdata", package = "ollamar"), "image1.png")
#' substr(image_encode_base64(image_path), 1, 5) # truncate output
image_encode_base64 <- function(image_path) {
if (!file.exists(image_path)) {
stop("Image file does not exist.")
}
img_raw <- readBin(image_path, "raw", file.info(image_path)$size)
return(base64enc::base64encode(img_raw))
}
#' Create a message
#'
#' @param content The content of the message.
#' @param role The role of the message. Can be "user", "system", "assistant". Default is "user".
#' @param ... Additional arguments such as images.
#'
#' @return A list of messages.
#' @export
#'
#' @examples
#' create_message("Hello", "user")
#' create_message("Always respond nicely", "system")
#' create_message("I am here to help", "assistant")
create_message <- function(content, role = "user", ...) {
message <- list(c(list(role = role, content = content), list(...)))
return(message)
}
#' Append message to a list
#'
#' Appends a message (add to end of a list) to a list of messages. The role and content will be converted to a list and appended to the input list.
#'
#' @param content The content of the message.
#' @param role The role of the message. Can be "user", "system", "assistant". Default is "user".
#' @param x A list of messages. Default is NULL.
#' @param ... Additional arguments such as images.
#'
#' @return A list of messages with the new message appended.
#' @export
#'
#' @examples
#' append_message("user", "Hello")
#' append_message("system", "Always respond nicely")
append_message <- function(content, role = "user", x = NULL, ...) {
if (is.null(x)) {
x <- list()
}
new_message <- c(list(role = role, content = content), list(...))
x[[length(x) + 1]] <- new_message
return(x)
}
#' Prepend message to a list
#'
#' Prepends a message (add to beginning of a list) to a list of messages.
#' The role and content will be converted to a list and prepended to the input list.
#'
#' @param content The content of the message.
#' @param role The role of the message. Can be "user", "system", "assistant".
#' @param x A list of messages. Default is NULL.
#' @param ... Additional arguments such as images.
#'
#' @return A list of messages with the new message prepended.
#' @export
#'
#' @examples
#' prepend_message("user", "Hello")
#' prepend_message("system", "Always respond nicely")
prepend_message <- function(content, role = "user", x = NULL, ...) {
if (is.null(x)) {
x <- list()
}
new_message <- c(list(role = role, content = content), list(...))
x <- c(list(new_message), x) # Prepend by combining the new message with the existing list
return(x)
}
#' Insert message into a list at a specified position
#'
#' Inserts a message at a specified position in a list of messages.
#' The role and content are converted to a list and inserted into the input list at the given position.
#'
#' @param content The content of the message.
#' @param role The role of the message. Can be "user", "system", "assistant". Default is "user".
#' @param x A list of messages. Default is NULL.
#' @param position The position at which to insert the new message. Default is -1 (end of list).
#' @param ... Additional arguments such as images.
#'
#' @return A list of messages with the new message inserted at the specified position.
#' @export
#'
#' @examples
#' messages <- list(
#' list(role = "system", content = "Be friendly"),
#' list(role = "user", content = "How are you?")
#' )
#' insert_message("INSERT MESSAGE AT THE END", "user", messages)
#' insert_message("INSERT MESSAGE AT THE BEGINNING", "user", messages, 2)
insert_message <- function(content, role = "user", x = NULL, position = -1, ...) {
if (position == -1) position <- length(x) + 1
new_message <- c(list(role = role, content = content), list(...))
if (is.null(x)) {
return(list(new_message))
}
if (position == 1) {
return(prepend_message(content, role, x))
}
if (position == length(x) + 1) {
return(append_message(content, role, x))
}
x <- c(x[1:(position - 1)], list(new_message), x[position:length(x)])
return(x)
}
#' Delete a message in a specified position from a list
#'
#' Delete a message using positive or negative positions/indices.
#' Negative positions/indices can be used to refer to
#' elements/messages from the end of the sequence.
#'
#' @param x A list of messages.
#' @param position The position of the message to delete.
#'
#' @return A list of messages with the message at the specified position removed.
#' @export
#'
#' @examples
#' messages <- list(
#' list(role = "system", content = "Be friendly"),
#' list(role = "user", content = "How are you?")
#' )
#' delete_message(messages, 1) # delete first message
#' delete_message(messages, -2) # same as above (delete first message)
#' delete_message(messages, 2) # delete second message
#' delete_message(messages, -1) # same as above (delete second message)
delete_message <- function(x, position = -1) {
if (position == 0 || abs(position) > length(x)) {
stop("Position out of valid range.")
}
if (position < 0) position <- length(x) + position + 1
return(x[-position])
}
#' Validate a message
#'
#' Validate a message to ensure it has the required fields and the correct data types for the `chat()` function.
#' @param message A list with a single message of list class.
#'
#' @return TRUE if message is valid, otherwise an error is thrown.
#' @export
#'
#' @examples
#' validate_message(create_message("Hello"))
#' validate_message(list(role = "user", content = "Hello"))
validate_message <- function(message) {
# if message is a list of messages, extract the first message
# likely created by create_message()
if (is.list(message) & all(c("role", "content") %in% names(message[[1]]))) {
message <- message[[1]]
}
if (!is.list(message)) {
stop("Message must be list.")
}
if (!all(c("role", "content") %in% names(message))) {
stop("Message must have role and content.")
}
if (!is.character(message$role)) {
stop("Message role must be character.")
}
if (!is.character(message$content)) {
stop("Message content must be character.")
}
return(TRUE)
}
#' Create a list of messages
#'
#' Create messages for `chat()` function.
#'
#' @param ... A list of messages, each of list class.
#'
#' @return A list of messages, each of list class.
#' @export
#'
#' @examples
#' messages <- create_messages(
#' create_message("be nice", "system"),
#' create_message("tell me a 3-word joke")
#' )
#'
#' messages <- create_messages(
#' list(role = "system", content = "be nice"),
#' list(role = "user", content = "tell me a 3-word joke")
#' )
create_messages <- function(...) {
messages <- list(...)
for (i in 1:length(messages)) {
message <- messages[[i]]
# in case message is in a nested list created by create_message()
if (is.null(names(message))) {
if (validate_message(message[[1]])) {
message <- message[[1]]
messages[[i]] <- message
}
}
if (validate_message(message)) {
next
}
}
return(messages)
}
#' Validate a list of messages
#'
#' Validate a list of messages to ensure they have the required fields and the correct data types for the `chat()` function.
#'
#' @param messages A list of messages, each of list class.
#'
#' @return TRUE if all messages are valid, otherwise warning messages are printed and FALSE is returned.
#' @export
#'
#' @examples
#' validate_messages(create_messages(
#' create_message("Be friendly", "system"),
#' create_message("Hello")
#' ))
validate_messages <- function(messages) {
status <- TRUE
for (i in 1:length(messages)) {
tryCatch({
validate_message(messages[[i]])
}, error = function(e) {
status <<- FALSE
message(paste0("Message ", i, ": ", conditionMessage(e)))
})
}
return(status)
}
#' Encode images in messages to base64 format
#'
#' @param messages A list of messages, each of list class. Generally used in the `chat()` function.
#'
#' @return A list of messages with images encoded in base64 format.
#' @export
#'
#' @examples
#' image <- file.path(system.file("extdata", package = "ollamar"), "image1.png")
#' message <- create_message(content = "what is in the image?", images = image)
#' message_updated <- encode_images_in_messages(message)
encode_images_in_messages <- function(messages) {
if (!validate_messages(messages)) {
stop("Invalid messages.")
}
for (i in 1:length(messages)) {
message <- messages[[i]]
if ("images" %in% names(message)) {
images <- message$images
if (images[1] != "") {
message$images <- lapply(images, image_encode_base64)
messages[[i]] <- message
} else {
next
}
}
}
# revalidate messages
if (!validate_messages(messages)) {
stop("Invalid messages.")
}
return(messages)
}