| ben-aaron188 | 3818e7c | 2022-09-08 17:49:01 +0200 | [diff] [blame] | 1 | % Generated by roxygen2: do not edit by hand |
| 2 | % Please edit documentation in R/authenticate.R |
| 3 | \name{gpt3.authenticate} |
| 4 | \alias{gpt3.authenticate} |
| 5 | \title{Set up the authentication with your API key} |
| 6 | \usage{ |
| 7 | gpt3.authenticate(apikey) |
| 8 | } |
| 9 | \arguments{ |
| 10 | \item{apikey}{A character vector that is your personal API key} |
| 11 | } |
| 12 | \value{ |
| 13 | A confirmation message |
| 14 | } |
| 15 | \description{ |
| 16 | Access to GPT-3's functions requires an API key that you obtain from \url{https://openai.com/api/}. \code{gpt3.authenticate()} accepts your API key and ensures that you can connect to the models. \code{gpt3.endsession()} overwrites your API key \emph{for this session} (it is recommended that you run this when you are done). \code{check_apikey_form()} is a simple check if any information has been provided at all. |
| 17 | } |
| 18 | \examples{ |
| 19 | # Starting a session: |
| 20 | gpt3.authenticate(apikey = 'REPLACE_THIS_WITH_YOUR_KEY') |
| 21 | # After you are finished: |
| 22 | gpt3.endsession() |
| 23 | } |