Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hauselin committed May 2, 2024
1 parent d8fb97f commit 5d17c07
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions R/ollama.R
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,16 @@ create_request <- function(endpoint, address = NULL) {

#' Get available local models
#'
#' @param output The output format. Default is "df". Other options are "resp", "jsonlist", "raw".
#' @param output The output format. Default is "df". Other options are "resp", "jsonlist", "raw", "text".
#' @param endpoint The endpoint to get the models. Default is "/api/tags".
#'
#' @return A httr2 response object, json list, raw or data frame. Default is "df".
#' @return A response in the format specified in the output parameter.
#' @export
#'
#' @examplesIf test_connection()$status_code == 200
#' list_models() # returns dataframe/tibble by default
#' list_models("df")
#' list_models("resp")
#' list_models("resp") # httr2 response object
#' list_models("jsonlist")
#' list_models("raw")
list_models <- function(output = c("df", "resp", "jsonlist", "raw", "text"), endpoint = "/api/tags") {
Expand Down Expand Up @@ -77,7 +77,7 @@ list_models <- function(output = c("df", "resp", "jsonlist", "raw", "text"), end
#' @param stream Enable response streaming. Default is FALSE.
#' @param endpoint The endpoint to chat with the model. Default is "/api/chat".
#'
#' @return A httr2 response object, json list, raw or data frame.
#' @return A response in the format specified in the output parameter.
#' @export
#'
#' @examplesIf test_connection()$status_code == 200
Expand Down
2 changes: 1 addition & 1 deletion man/chat.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/list_models.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 5d17c07

Please sign in to comment.