R/openai_api_calls.R

In mergenstudio: 'Mergen' Studio: An 'RStudio' Addin Wrapper for the 'Mergen' Package

#' Base for a request to the OPENAI API
#'
#' This function sends a request to a specific OpenAI API \code{task} endpoint at the base URL \code{https://api.openai.com/v1}, and authenticates with an API key using a Bearer token.
#'
#' @param task character string specifying an OpenAI API endpoint task
#' @param token String containing an OpenAI API key. Defaults to the AI_API_KEY environmental variable if not specified.
#'
#' @import cli
#' @importFrom httr2 request req_url_path_append req_auth_bearer_token
#' @noRd
request_base <- function(task, token = Sys.getenv("AI_API_KEY")) {
  if (!task %in% get_available_endpoints()) {
    cli::cli_abort(message = c(
      "{.var task} must be a supported endpoint",
      "i" = "Run {.run mergenstudio::get_available_endpoints()} to get a list of supported endpoints"
    ))
  }
  httr2::request(getOption("mergenstudio.openai_url")) %>%
    httr2::req_url_path_append(task) %>%
    httr2::req_auth_bearer_token(token = token)
}


#' List supported models
#'
#' Get a list of the models supported by the OpenAI API.
#'
#' @param service The API service
#'
#' @import cli
#' @importFrom httr2 req_perform resp_body_json
#' @importFrom purrr pluck map_chr
#' @importFrom stringr str_subset
#' @noRd
get_available_models <- function(service, token = Sys.getenv("AI_API_KEY")) {
  models <- NULL
  if (service == "openai") {

    # get models from GPT API if possible
    models <- tryCatch({
      request_base("models", token = token) %>%
        httr2::req_perform() %>%
        httr2::resp_body_json() %>%
        purrr::pluck("data") %>%
        purrr::map_chr("id")
    },
    error = function(e) {
      return(NULL)
    })

    if(!is.null(models)) {
      models <- models %>%
        stringr::str_subset("^gpt") %>%
        stringr::str_subset("instruct", negate = TRUE) %>%
        stringr::str_subset("vision", negate = TRUE) %>%
        sort()
      idx <- which(models == "gpt-3.5-turbo")
      models <- c(models[idx], models[-idx])
    } else {
      models <- c("gpt-3.5-turbo", "gpt-4")
    }
  } else if (service == "replicate"){
    models <- c("llama-2-70b-chat")
  } else if (service == "generic"){
    models <- c("")
  }
  models
}

#' List supported endpoints
#'
#' Get a list of the endpoints supported by mergenstudio.
#'
#' @noRd
get_available_endpoints <- function() {
  c("completions", "chat/completions", "edits", "embeddings", "models")
}