openai

项目介绍：openai 包

项目状态

openai 项目目前已经被搁置和归档，因为在过去一年中没有进展。这意味着项目将不再接受进一步的维护。不过，用户可以选择使用其他功能强大的软件包，例如 Hadley Wickham 和他的团队开发的 elmer。

项目概述

openai 是一个 R 语言的包，旨在作为 OpenAI API 端点的 R 封装器。这个包包含了多个功能模块，包括模型（Models）、完成（Completions）、聊天（Chat）、编辑（Edits）、图像（Images）、嵌入（Embeddings）、音频（Audio）、文件（Files）、微调（Fine-tunes）、和审批（Moderations）。此外，还有一个用于历史兼容的 Engines 端点，预计不久之后将被移除。

安装方法

用户可以通过 CRAN 正式版以简单的方式安装 {openai} 包：

install.packages("openai")

此外，用户也可以通过 GitHub 安装开发版：

if (!require(remotes))
    install.packages("remotes")
remotes::install_github("irudnyts/openai", ref = "r6")

认证方法

要使用 OpenAI API，用户需要提供一个 API 密钥。该密钥可以通过注册 OpenAI API 获取。用户可以在 OpenAI 官网的个人页面中找到“查看 API 密钥”的选项来获取密钥。

默认情况下，{openai} 的函数会寻找名为 OPENAI_API_KEY 的环境变量。用户可以通过如下命令全局设置此变量：

Sys.setenv(
    OPENAI_API_KEY = '你的实际密钥'
)

或者，用户也可以将密钥添加到项目的 .Renviron 文件中，以保持密钥的隐私。请注意，如果用户使用的是 GitHub/Gitlab，不要忘记将 .Renviron 添加到 .gitignore 中。

示例用法

{openai} 的函数名自解释，易于使用。例如，用户可以使用 create_completion() 函数来创建一个文本补全：

library(openai)

create_completion(
    model = "ada",
    prompt = "生成一个问题和一个答案"
)

用户还可以使用 DALL·E 文本到图像模型生成一幅图像：

create_image("用写实风格绘制骑马的宇航员")

此外，用户可以通过 create_chat_completion() 使用 ChatGPT 的 gpt-3.5-turbo 模型来创建聊天对话：

create_chat_completion(
    model = "gpt-3.5-turbo",
    messages = list(
        list(
            "role" = "system",
            "content" = "你是一个乐于助人的助手。"
        ),
        list(
            "role" = "user",
            "content" = "2020 年世界大赛是谁赢的？"
        ),
        list(
            "role" = "assistant",
            "content" = "2020 年世界大赛是洛杉矶道奇队赢的。"
        ),
        list(
            "role" = "user",
            "content" = "比赛在哪里举办的？"
        )
    )
)

最后，通过 create_transcription() 和 create_translation()，用户还可以使用 Whisper 语音转文本功能：

voice_sample_ua <- system.file("extdata", "sample-ua.m4a", package = "openai")
create_translation(file = voice_sample_ua, model = "whisper-1")

openai 包为 R 用户访问 OpenAI 提供了便携的途径，尽管项目已被搁置，但其最后版本仍提供了丰富的功能和灵活性。