R/llm-translate.R

In mall: Run Multiple Large Language Model Predictions Against a Table, or Vectors

#' Translates text to a specific language
#'
#' @description
#' Use a Large Language Model (LLM) to translate a text to a specific
#' language
#'
#' @inheritParams llm_classify
#' @param language Target language to translate the text to
#' @examples
#' \donttest{
#' library(mall)
#'
#' data("reviews")
#'
#' llm_use("ollama", "llama3.2", seed = 100, .silent = TRUE)
#'
#' # Pass the desired language to translate to
#' llm_translate(reviews, review, "spanish")
#' }
#' @returns `llm_translate` returns a `data.frame` or `tbl` object.
#' `llm_vec_translate` returns a vector that is the same length as `x`.
#' @export
llm_translate <- function(.data,
                          col,
                          language,
                          pred_name = ".translation",
                          additional_prompt = "") {
  UseMethod("llm_translate")
}

#' @export
llm_translate.data.frame <- function(.data,
                                     col,
                                     language,
                                     pred_name = ".translation",
                                     additional_prompt = "") {
  mutate(
    .data = .data,
    !!pred_name := llm_vec_translate(
      x = {{ col }},
      language = language,
      additional_prompt = additional_prompt
    )
  )
}

#' @rdname llm_translate
#' @export
llm_vec_translate <- function(
    x,
    language,
    additional_prompt = "",
    preview = FALSE) {
  m_vec_prompt(
    x = x,
    prompt_label = "translate",
    additional_prompt = additional_prompt,
    language = language,
    preview = preview
  )
}