add python interface through reticulate (openai only)

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: ubep.gpt
 Title: A basic/simple interface to OpenAI’s GPT API
-Version: 0.2.7
+Version: 0.2.8
 Authors@R: 
     person("Corrado", "Lanera", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-0520-7428"))
@@ -17,6 +17,7 @@ Imports:
     jsonlite,
     lifecycle,
     purrr,
+    reticulate,
     rlang,
     stringr,
     tibble,

NEWS.md

@@ -1,3 +1,7 @@
+# ubep.gpt 0.2.8
+
+* Added `use_py` argument to `gpt_query`, `gpt_query_on_column`, and  `get_completion_from_messages`
+
 # ubep.gpt 0.2.7
 
 * Added `closing` argument to `compose_usr_prompt`, `compose_prompt`, and `create_usr_data_prompter` functions, to allow add text at the very end of the prompt, i.e., after the embedded text.

R/get_completion_from_messages.R

@@ -16,6 +16,9 @@
 #'   "https://api.openai.com/v1/chat/completions", i.e. the OpenAI API)
 #'   the endpoint to use for the request.
 #' @param seed (chr, default = NULL) a string to seed the random number
+#' @param timeout (dbl, default = 60) the number of seconds to wait for
+#'   the request to complete before timing out.
+#' @param use_py (lgl, default = FALSE) whether to use python or not
 #'
 #' @details For argument description, please refer to the [official
 #'   documentation](https://platform.openai.com/docs/api-reference/chat/create).
@@ -82,43 +85,64 @@ get_completion_from_messages <- function(
   temperature = 0,
   max_tokens = NULL,
   endpoint = "https://api.openai.com/v1/chat/completions",
-  seed = NULL
+  seed = NULL,
+  use_py = FALSE
 ) {
+  stopifnot(
+    `At the moment, python can be used with openai API only` = !use_py ||
+      endpoint == "https://api.openai.com/v1/chat/completions"
+  )
+  if (use_py) {
+    if (!reticulate::py_module_available("openai")) {
+      reticulate::py_install("openai")
+    }
+    openai <- reticulate::import("openai")
+    client <- openai$OpenAI()
 
-  response <- httr::POST(
-    endpoint,
-    httr::add_headers(
-      "Authorization" = paste("Bearer", Sys.getenv("OPENAI_API_KEY"))
-    ),
-    httr::content_type_json(),
-    encode = "json",
-    body = list(
-      model = model,
+    client$chat$completions$create(
       messages = messages,
+      model = model,
       temperature = temperature,
       max_tokens = max_tokens,
-      stream = FALSE, # hard coded for the moment
       seed = seed
+    )$to_json() |>
+      jsonlite::fromJSON() |>
+      tryCatch(error = \(e) usethis::ui_stop(e))
+  } else {
+    response <- httr::POST(
+      endpoint,
+      httr::add_headers(
+        "Authorization" = paste("Bearer", Sys.getenv("OPENAI_API_KEY"))
+      ),
+      httr::content_type_json(),
+      encode = "json",
+      body = list(
+        model = model,
+        messages = messages,
+        temperature = temperature,
+        max_tokens = max_tokens,
+        stream = FALSE, # hard coded for the moment
+        seed = seed
+      )
     )
-  )
 
-  parsed <- response |>
-    httr::content(as = "text", encoding = "UTF-8") |>
-    jsonlite::fromJSON(flatten = TRUE)
+    parsed <- response |>
+      httr::content(as = "text", encoding = "UTF-8") |>
+      jsonlite::fromJSON(flatten = TRUE)
 
-  if (httr::http_error(response)) {
-    err <- parsed[["error"]]
-    err <- if (is.character(err)) err else err[["message"]]
-    stringr::str_c(
-      "API request failed [",
-      httr::status_code(response),
-      "]:\n\n",
-      err
-    ) |>
-      usethis::ui_stop()
+    if (httr::http_error(response)) {
+      err <- parsed[["error"]]
+      err <- if (is.character(err)) err else err[["message"]]
+      stringr::str_c(
+        "API request failed [",
+        httr::status_code(response),
+        "]:\n\n",
+        err
+      ) |>
+        usethis::ui_stop()
+    }
+    parsed
   }
-
-  parsed
 }
 
 
@@ -131,7 +155,13 @@ get_completion_from_messages <- function(
 #' @export
 get_content <- function(completion) {
   if (all(is.na(completion))) return(NA_character_)
-  completion[["choices"]][["message.content"]]
+
+  if ("message" %in% names(completion[["choices"]])) {
+    completion[["choices"]][["message"]][["content"]]
+  } else {
+    completion[["choices"]][["message.content"]]
+  }
+
 }
 
 #' Get the number of token of a chat completion
@@ -159,7 +189,6 @@ get_tokens <- function(
       completion_tokens = NA_integer_
     )
   }
-
   if (what == "all") {
     completion[["usage"]] |> unlist()
   } else {

R/query_gpt.R

@@ -11,6 +11,7 @@
 #'   the endpoint to use for the request.
 #' @param na_if_error (lgl) whether to return NA if an error occurs
 #' @param seed  (chr, default = NULL) a string to seed the random number
+#' @param use_py (lgl, default = FALSE) whether to use python or not
 #'
 #' @return (list) the result of the query
 #' @export
@@ -49,7 +50,8 @@ query_gpt <- function(
   max_try = 10,
   quiet = TRUE,
   na_if_error = FALSE,
-  seed = NULL
+  seed = NULL,
+  use_py = FALSE
 ) {
   done <- FALSE
   tries <- 0L
@@ -67,7 +69,8 @@ query_gpt <- function(
           temperature = temperature,
           max_tokens = max_tokens,
           endpoint = endpoint,
-          seed = seed
+          seed = seed,
+          use_py = use_py
         )
       done <- TRUE
       aux

R/query_gpt_on_column.R

@@ -25,6 +25,7 @@
 #'   or not
 #' @param seed (chr, default = NULL) a string to seed the random number
 #' @param closing (chr, default = NULL) Text to include at the end of the prompt
+#' @param use_py (lgl, default = FALSE) whether to use python or not
 #'
 #' @return (tibble) the result of the query
 #'
@@ -85,7 +86,8 @@ query_gpt_on_column <- function(
   na_if_error = FALSE,
   res_name = "gpt_res",
   .progress = TRUE,
-  seed = NULL
+  seed = NULL,
+  use_py = FALSE
 ) {
   usr_data_prompter <- create_usr_data_prompter(
     usr_prompt = usr_prompt,

tests/testthat/test-compose_prompt_api.R

@@ -51,15 +51,15 @@ test_that("compose_prompt_api works on empty args", {
 
   expect_list(
     run_usr_only,
-    c("character", "integer", "data.frame", "list"),
+    c("character", "integer", "data.frame", "list", "NULL"),
     len = 7
   )
   expect_string(get_content(run_usr_only))
   expect_integerish(get_tokens(run_usr_only, "all"), len = 3)
 
   expect_list(
     run_sys_only,
-    c("character", "integer", "data.frame", "list"),
+    c("character", "integer", "data.frame", "list", "NULL"),
     len = 7
   )
   expect_string(get_content(run_sys_only))

tests/testthat/test-get_completion_from_messages.R

@@ -22,7 +22,42 @@ test_that("get_completion_from_messages works", {
   # expectation
   expect_list(
     res,
-    c("character", "integer", "data.frame", "list"),
+    c("character", "integer", "data.frame", "list", "NULL"),
+    len = 7
+  )
+  expect_string(get_content(res))
+  expect_integerish(get_tokens(res))
+  expect_integerish(get_tokens(res, what = "prompt"))
+  expect_integerish(get_tokens(res, what = "completion"))
+  expect_integerish(get_tokens(res, what = "completion"))
+})
+
+test_that("get_completion_from_messages works w/ py", {
+  # setup
+  model <- "gpt-3.5-turbo"
+  messages <- compose_prompt_api(
+    sys_prompt = compose_sys_prompt(
+      role = "role",
+      context = "context"
+    ),
+    usr_prompt = compose_usr_prompt(
+      task = "task",
+      instructions = "instructions"
+    )
+  )
+
+  # execution
+  res <- get_completion_from_messages(
+    model = model,
+    messages = messages,
+    use_py = TRUE
+  ) |>
+    suppressMessages()
+
+  # expectation
+  expect_list(
+    res,
+    c("character", "integer", "data.frame", "list", "NULL"),
     len = 7
   )
   expect_string(get_content(res))

tests/testthat/test-query_gpt.R

@@ -14,7 +14,7 @@ test_that("query_gpt works", {
   # expectation
   expect_list(
     res,
-    c("character", "integer", "data.frame", "list"),
+    c("character", "integer", "data.frame", "list", "NULL"),
     len = 7
   )
   expect_string(get_content(res))
@@ -39,7 +39,7 @@ test_that("query_gpt restarts", {
 
   query_gpt(prompt, max_try = 2, quiet = FALSE) |>
     suppressMessages() |>
-    expect_error(regexp = "is not of type 'array' - 'messages'")
+    expect_error(regexp = "Invalid type for 'messages'")
 })
 
 test_that("na_if_error works", {
@@ -49,7 +49,7 @@ test_that("na_if_error works", {
   # execution
   expect_warning({
     res <- query_gpt(prompt, max_try = 1, na_if_error = TRUE)
-  }, "is not of type 'array' - 'messages'") |>
+  }, "Invalid type for 'messages'") |>
     suppressMessages()
 
   # expectation
@@ -63,6 +63,7 @@ test_that("na_if_error works", {
 
 
 test_that("query_gpt without or empty sys_prompt works", {
+  skip("not on my server")
   # setup
   messages <- compose_prompt_api(usr_prompt = "usr")
 
@@ -75,7 +76,7 @@ test_that("query_gpt without or empty sys_prompt works", {
 
   # expectation
   expect_list(
-    res, c("character", "integer", "data.frame", "list")
+    res, c("character", "integer", "data.frame", "list", "NULL")
   )
   expect_string(get_content(res))
   expect_integerish(get_tokens(res), len = 1)