how to get openai api key的进一步展开说明

概述

{openai} 是 OpenAI API 端点的 R 包装器。该包涵盖了模型、补全、聊天、编辑、图象、嵌入、音频、文件、微调、审核和旧版引擎端点。后者名称为引擎，是为了向后兼容而保存的，不久将被移除。

安装

从 CRAN 安装 {openai} 的最简单方法是使用“官方” install.packages() 函数：

您也能够使用以下命令从 GitHub 安装 {openai} 的开发版本：

if ( ! require (remotes)) (remotes)) install.packages ( “remotes” ) :: install_github ( “irudnyts/openai” ) remotes

身份验证

要使用 OpenAI API，您需要提供一个 API 密钥。首先，在此页面上注册 OpenAI API。注册并登录后，您需要打开此页面，在下拉菜单中点击 Personal，然后选择 View API keys。然后，您可以通过点击绿色文本 Copy 复制密钥。

默许情况下，{openai} 的函数将寻觅 OPENAI_API_KEY 环境变量。如果您想设置全局环境变量，可使用以下命令（其中 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 应替换为您的实际密钥）：

否则，您可以将密钥添加到项目的 .Renviron 文件中。以下命令将打开 .Renviron 文件以进行编辑：

if ( ! require (usethis)) (usethis)) install.packages ( “usethis” ) :: edit_r_environ ( scope = “project” ) usethis

您可以将以下行添加到文件中（再次，将 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 替换为您的实际密钥）：

= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx OPENAI_API_KEYxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

注意：如果您使用 GitHub/Gitlab，请不要忘记将 .Renviron 添加到 .gitignore 中！

最后，您始终可以手动提供密钥给包的函数。

示例

{openai} 的函数名称都很自解释。例如，要创建一个补全，可使用 create_completion() 函数：

library (openai) (openai) create_completion ( model = “ada” , prompt = “生成一个问题和一个回答” ) #> $id #> [1] “cmpl⑹MiImjcaCSuQYY6u8UA2Mm0rCdbEo” #> #> $object #> [1] “text_completion” #> #> $created #> [1] 1670871532 #> #> $model #> [1] “ada” #> #> $choices #> text #> 1 根据您的用户区别，需要 5 分钟到 1 小时不等 #> index logprobs finish_reason #> 1 0 NA length #> #> $usage #> $usage$prompt_tokens #> [1] 7 #> #> $usage$completion_tokens #> [1] 16 #> #> $usage$total_tokens #> [1] 23

另外，还可使用 DALL·E 文本到图象模型的 create_image() 生成图象：

create_image ( “以逼真的风格骑马的宇航员” )

还可以通过 create_chat_completion() 使用 ChatGPT 的 gpt⑶.5-turbo 模型：

create_chat_completion ( model = “gpt⑶.5-turbo” , messages = list ( list ( “role” = “system” , “content” = “您是一个有帮助的助手。” ), list ( “role” = “user” , “content” = “2023 年世界系列赛的冠军是谁？” ), list ( “role” = “assistant” , “content” = “洛杉矶道奇队在 2023 年赢得了世界系列赛。” ), list ( “role” = “user” , “content” = “比赛是在哪里进行的？” )) ) #> $id #> [1] “chatcmpl⑹r7N6YXcMhg8xmVM4ohOcAmzPOy3f” #> #> $object #> [1] “chat.completion” #> #> $created #> [1] 1678117740 #> #> $model #> [1] “gpt⑶.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 2023 年世界系列赛在德克萨斯州阿灵顿的环球生命田园球场举行。

最后，通过 create_transcription() 和 create_translation()，可使用语音到文本的 Whisper 进行转录和翻译：

how to get openai api key的常见问答Q&A