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

概述

{openai} 是 OpenAI API 端点的 R 封装器。该软件包涵盖了 Models、Completions、Chat、Edits、Images、Embeddings、Audio、Files、Fine-tunes、Moderations 和 legacy Engines 端点。其中，后者即 Engines 端点仅用于向后兼容性，将很快被删除。

安装

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

你也能够使用 GitHub 上的开发版本从 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 环境变量。如果要设置全局环境变量，可使用以下命令（将 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 替换为您的实际密钥）：

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

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

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

= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx OPENAI_API_KEYxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

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

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

示例

{openai} 的函数具有自我说明的名称。例如，要创建一个 completion，可使用 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 ( “一个骑着马的宇航员，以逼真的风格” )

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

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 年世界系列赛在德克萨斯州阿灵顿的环球生命运动场举行。

最后，语音到文本的 Whisper 可通过 create_transcription() 和 create_translation() 使用：

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