Skip to content
/ openai Public
forked from samterfa/openai

This R package provides an SDK to the Open AI API

License

Notifications You must be signed in to change notification settings

csqr/openai

 
 

Repository files navigation

openai

openai provides R scripts to use the Open AI API

Installation

You can install the development version of openai from GitHub with:

# install.packages("devtools")
devtools::install_github("samterfa/openai")

Set Up

API calls are authenticated using your API keys. The environment variables set below are consulted while making each call.

Sys.setenv(openai_organization_id = {your_organization_id})
Sys.setenv(openai_secret_key = {your_secret_key})

More details on authentication can be found here.

Examples

Retrieve the currently available models used to generate text.

library(openai)
library(purrr)

list_models() %>% 
  pluck('data') %>% 
  map_dfr(compact)
#> # A tibble: 70 × 7
#>    id                          object created owned_by permission   root  parent
#>    <chr>                       <chr>    <int> <chr>    <list>       <chr> <chr> 
#>  1 babbage                     model   1.65e9 openai   <named list> babb… <NA>  
#>  2 davinci                     model   1.65e9 openai   <named list> davi… <NA>  
#>  3 babbage-code-search-code    model   1.65e9 openai-… <named list> babb… <NA>  
#>  4 text-similarity-babbage-001 model   1.65e9 openai-… <named list> text… <NA>  
#>  5 text-davinci-001            model   1.65e9 openai   <named list> text… <NA>  
#>  6 ada                         model   1.65e9 openai   <named list> ada   <NA>  
#>  7 curie-instruct-beta         model   1.65e9 openai   <named list> curi… <NA>  
#>  8 babbage-code-search-text    model   1.65e9 openai-… <named list> babb… <NA>  
#>  9 babbage-similarity          model   1.65e9 openai-… <named list> babb… <NA>  
#> 10 gpt-3.5-turbo               model   1.68e9 openai   <named list> gpt-… <NA>  
#> # … with 60 more rows

Create a completion request using the davinci engine.

create_completion(
  model = 'davinci', 
  max_tokens = 30,
  temperature = .5,
  top_p = 1,
  n = 1,
  stream = F, 
  prompt = 'Once upon a time') %>% 
  pluck('choices') %>% 
  map_chr(~ .x$text)
#> [1] ", when I was a kid, I used to play this game on the old Apple II computer. It was a text adventure game, and the goal"

Generate an image based on a prompt.

create_image(
  prompt = "A rollerskating zebra", 
  n = 1, 
  response_format = "url")
#> $created
#> [1] 1679239172
#> 
#> $data
#> $data[[1]]
#> $data[[1]]$url
#> [1] "https://oaidalleapiprodscus.blob.core.windows.net/private/org-nKKiUxRVJQl2MhzgM9gtTsko/user-uQ6jdzskUi7KqutVEN82ZpLB/img-8Kvth8NNoHAzdV9OcFnbFgsV.png?st=2023-03-19T14%3A19%3A32Z&se=2023-03-19T16%3A19%3A32Z&sp=r&sv=2021-08-06&sr=b&rscd=inline&rsct=image/png&skoid=6aaadede-4fb3-4698-a8f6-684d7786b067&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skt=2023-03-19T13%3A44%3A34Z&ske=2023-03-20T13%3A44%3A34Z&sks=b&skv=2021-08-06&sig=spR0XL8LW55T8MpX61NQjIqReIcJYZJ/DN4zCwM1vs0%3D"

Use the included addin to code collaboratively with a model.

Access it via the Addins menu, or by Tools -> Addins -> Browse Addins. Search for "openai".

About

This R package provides an SDK to the Open AI API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • R 100.0%