-
Notifications
You must be signed in to change notification settings - Fork 35
/
Copy pathREADME.Rmd
205 lines (169 loc) · 6.6 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
---
output: github_document
---
## :warning: :warning: :warning: The project is shelved and archived :warning: :warning: :warning:
Since the project has been stalled for more than a year, it has been archived and won't be maintained. There are other amazing packages you can use instead, e.g., [elmer](https://github.com/tidyverse/elmer) by Hadley Wickham and friends.
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# openai <img src="man/figures/logo.png" align="right" width="120" />
<!-- badges: start -->
[](https://github.com/irudnyts/openai/actions)
[](https://app.codecov.io/gh/irudnyts/openai?branch=main)
[](https://CRAN.R-project.org/package=openai)
[](https://cranlogs.r-pkg.org/badges/grand-total/openai?color=brightgreen)
<!-- badges: end -->
> :warning: **Note:** :warning: OpenAI introduced major changes in package's version 1.0.0. Since the idea of this package is to mimic OpenAI's official Python package, from now on, everything will be re-written in object-oriented way. Current implementation will be gradually and gently depricated. One can install the development verion using:
>```
> remotes::install_github("irudnyts/openai", ref = "r6")
> ```
> Then, the code will look like:
> ```
> library(openai)
> client <- OpenAI()
> completion <- client$chat$completions$create(
> model = "gpt-3.5-turbo",
> messages = list(list("role" = "user", "content" = "What's up?"))
> )
> ```
## Overview
`{openai}` is an R wrapper of OpenAI API endpoints. This package covers Models, Completions, Chat, Edits, Images, Embeddings, Audio, Files, Fine-tunes, Moderations, and legacy Engines endpoints. The latter endpoints, namely Engines, are left for backward compatibility and will be removed soon.
## Installation
The easiest way to install `{openai}` from CRAN is to use the "official" `install.packages()` function:
```{r, eval = FALSE}
install.packages("openai")
```
You can also install the development version of `{openai}` from [GitHub](https://github.com/), which uses the latest version of official OpenAI's Python package:
```{r, eval = FALSE}
if (!require(remotes))
install.packages("remotes")
remotes::install_github("irudnyts/openai", ref = "r6")
```
## Authentication
To use the OpenAI API, you need to provide an API key. First, sign up for OpenAI API on [this page](https://openai.com/api/). Once you signed up and logged in, you need to open [this page](https://platform.openai.com), click on **Personal**, and select **View API keys** in drop-down menu. You can then copy the key by clicking on the green text **Copy**.
By default, functions of `{openai}` will look for `OPENAI_API_KEY` environment variable. If you want to set a global environment variable, you can use the following command (where `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` should be replaced with your actual key):
```{r, eval = FALSE}
Sys.setenv(
OPENAI_API_KEY = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
)
```
Otherwise, you can add the key to the `.Renviron` file of the project. The following commands will open `.Renviron` for editing:
```{r, eval = FALSE}
if (!require(usethis))
install.packages("usethis")
usethis::edit_r_environ(scope = "project")
```
You can add the following line to the file (again, replace `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` with your actual key):
```{r, eval = FALSE}
OPENAI_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```
**Note:** If you are using GitHub/Gitlab, do not forget to add `.Renviron` to `.gitignore`!
Finally, you can always provide the key manually to the functions of the package.
## Example
Functions of `{openai}` have self-explanatory names. For example, to create a completion, one can use `create_completion()` function:
```{r, eval=FALSE}
library(openai)
create_completion(
model = "ada",
prompt = "Generate a question and an answer"
)
#> $id
#> [1] "cmpl-6MiImjcaCSuQYY6u8UA2Mm0rCdbEo"
#>
#> $object
#> [1] "text_completion"
#>
#> $created
#> [1] 1670871532
#>
#> $model
#> [1] "ada"
#>
#> $choices
#> text
#> 1 within 5 minutes, up to an hour depending on how your users are different and
#> index logprobs finish_reason
#> 1 0 NA length
#>
#> $usage
#> $usage$prompt_tokens
#> [1] 7
#>
#> $usage$completion_tokens
#> [1] 16
#>
#> $usage$total_tokens
#> [1] 23
```
Further, one can generate an image using DALL·E text-to-image model with `create_image()`:
```{r, eval=FALSE}
create_image("An astronaut riding a horse in a photorealistic style")
```
```{r, echo=FALSE, out.width = "256px", fig.align = "center"}
knitr::include_graphics("man/figures/astronaut.png")
```
It is also possible to use ChatGPT's `gpt-3.5-turbo` model via `create_chat_completion()`:
```{r, eval=FALSE}
create_chat_completion(
model = "gpt-3.5-turbo",
messages = list(
list(
"role" = "system",
"content" = "You are a helpful assistant."
),
list(
"role" = "user",
"content" = "Who won the world series in 2020?"
),
list(
"role" = "assistant",
"content" = "The Los Angeles Dodgers won the World Series in 2020."
),
list(
"role" = "user",
"content" = "Where was it played?"
)
)
)
#> $id
#> [1] "chatcmpl-6r7N6YXcMhg8xmVM4ohOcAmzPOy3f"
#>
#> $object
#> [1] "chat.completion"
#>
#> $created
#> [1] 1678117740
#>
#> $model
#> [1] "gpt-3.5-turbo-0301"
#>
#> $usage
#> $usage$prompt_tokens
#> [1] 56
#>
#> $usage$completion_tokens
#> [1] 19
#>
#> $usage$total_tokens
#> [1] 75
#>
#>
#> $choices
#> finish_reason index message.role
#> 1 stop 0 assistant
#> message.content
#> 1 The 2020 World Series was played at Globe Life Field in Arlington, Texas.
```
Finally, the speech-to-text [Whisper](https://openai.com/research/whisper) is available via `create_transcription()` and `create_translation()`:
```{r, eval=FALSE}
voice_sample_ua <- system.file("extdata", "sample-ua.m4a", package = "openai")
create_translation(file = voice_sample_ua, model = "whisper-1")
#> $text
#> [1] "I want to check how this model works"
```