R/dialog.R

In oaii: 'OpenAI' API R Interface

#' Create dialog data.frame
#'
#' @param content string, message content
#' @param role string, message role ("owner")
#' @param finish_reason see https://platform.openai.com/docs/guides/gpt/chat-completions-response-format
#' @return A one-row data.frame with columns: `content`, `role` and `finish_reason`
#' @export
#'
#' @examples
#' dialog_df("some text message")
#' dialog_df("some another text message", role = "assistant")
#'
dialog_df <- function(content, role = "user", finish_reason = "stop") {
  # asserts
  stopifnot(
    "`content` must be a non-empty string" = checkmate::testString(content, min.chars = 1),
    "`role` must be a non-empty string" = checkmate::testString(role, min.chars = 1),
    "`finish_reason` must be a non-empty string" = checkmate::testString(finish_reason, min.chars = 1)
  )

  df <-
    data.frame(
      role = role,
      content = content,
      finish_reason = finish_reason
    )
  rownames(df) <- NULL
  df
}


#' Merge multiple dialog data.frame
#'
#' @param ... dialog data.frame or NULL
#' @return data.frame containing all input dialogs
#' @export
#'
#' @examples
#' d1 <- dialog_df("message 1")
#' d2 <- dialog_df("message 2")
#' print(
#'   merge_dialog_df(
#'     d1,
#'     merge_dialog_df(d1, d2),
#'     NULL,
#'     d2
#'   )
#' )
#'
merge_dialog_df <- function(...) {
  df <-
    data.frame(
      role = character(0),
      content = character(0),
      finish_reason = character(0)
    )

  for (x in list(...)) {
    if (is.data.frame(x)) df <- rbind(df, x)
  }
  rownames(df) <- NULL
  df
}

#' Save dialog data.frame as csv file
#'
#' @param dialog_df data.frame, dialog data.frame to save in csv file
#' @param file string, csv file path
#' @return \link[utils]{write.table} return value or SimpleError
#' @export
#'
dialog_df_to_csv <- function(dialog_df, file) {
  # asserts
  stopifnot(
    "`dialog_df` must be a data.frame" = checkmate::testDataFrame(dialog_df),
    "`file` must be a valid file path" = checkmate::testPathForOutput(file)
  )

  tryCatch(
    expr = {
      dialog_df[, "content"] <- utils::URLencode(dialog_df[, "content"])
      utils::write.table(
        dialog_df,
        file = file,
        quote = TRUE,
        sep = "\t",
        row.names = FALSE
      )
    },
    error = function(e) {
      log_error("dialog_df_to_csv(dialog_df, '", file, "') - error message '", e$message, "'")
      e
    }
  )
}

#' Read csv file as dialog data.frame
#'
#' @param datapath string, csv file path
#' @return Content of the input csv file as dialog data.frame,
#' SimpleError when an error occurs
#' @export
#'
csv_to_dialog_df <- function(datapath) {
  # asserts
  stopifnot(
    "`datapath` must be a valid file path" = checkmate::testFile(datapath)
  )

  tryCatch(
    expr = {
      df <- utils::read.table(
        datapath,
        sep = "\t",
        header = TRUE
      )
      df[, "content"] <- utils::URLdecode(df[, "content"])
      df
    },
    error = function(e) {
      log_error("csv_to_dialog_df('", datapath, "') - error message '", e$message, "'")
      e
    }
  )
}