README(openai key api examples)
I. 取得OpenAI API密钥
A. 在OpenAI网站上注册和登录账号
要获得OpenAI API密钥,首先需要在OpenAI网站上注册和登录账号。
- 访问https://platform.openai.com/signup
- 创建账号并登录
B. 创建API密钥
在注册并登录账号后,可以创建API密钥。
- 访问https://platform.openai.com/account/api-keys
- 点击“Create new API key”
- 生成并保存API密钥
II. 使用OpenAI API示例
A. 安装和导入OpenAI库
在使用OpenAI API之前,需要安装并导入OpenAI库。
- 使用pip install openai命令安装OpenAI库
- 在Python代码中导入openai模块
B. 调用OpenAI接口
通过OpenAI API,可以调用相关接口实现模型的生成。
- 创建OpenAI客户端配置
- a. 设置API密钥
- b. 设置其他配置参数
- 调用相关接口
- a. 使用已训练好的模型
- b. 设定输入参数和生成选项
- c. 调用模型生成文本
C. Python代码示例
以下是使用OpenAI API的Python代码示例。
- 设置OpenAI API密钥
- 调用模型生成文本的示例代码
I. 取得OpenAI API密钥
A. 在OpenAI网站上注册和登录账号
为了获得OpenAI API密钥,首先需要在OpenAI网站上注册和登录账号。只有注册并登录成功后,才能继续下一步的API密钥创建。
- 访问https://platform.openai.com/signup。
- 在注册页面填写必要信息并创建账号。
- 登录账号。
注册和登录完成后,您就能够开始API密钥的创建进程。
B. 创建API密钥
API密钥是使用OpenAI API的身份凭证。在注册并登录账号后,可以创建一个或多个API密钥。
- 访问https://platform.openai.com/account/api-keys。
- 在API密钥页面,点击“Create new API key”按钮。
- 生成并保存API密钥。
一旦API密钥创建成功,您就能够开始使用OpenAI API了。
II. 使用OpenAI API示例
A. 安装和导入OpenAI库
在使用OpenAI API之前,首先需要在Python环境中安装OpenAI库。
- 打开命令行终端,并运行以下命令来安装OpenAI库:
pip install openai
- 在Python代码中导入openai模块:
import openai
B. 调用OpenAI接口
使用OpenAI API,您可以调用各种接口来实现文本的生成和处理。
- 创建OpenAI客户端配置:您需要设置API密钥和其他配置参数,以便于使用API。
- a. 设置API密钥:将您的API密钥赋值给OpenAI客户端配置。
- b. 设置其他配置参数:根据需要,您可以设置其他相关参数,例如模型名称、超参数等。
- 调用相关接口:使用已训练好的模型,设置输入参数和生成选项,然后调用模型生成文本。
C. Python代码示例
以下是使用OpenAI API的Python代码示例。
- 设置OpenAI API密钥:
- 调用模型生成文本的示例代码:
import openai
# 设置API密钥
openai.api_key = 'YOUR_API_KEY'
import openai
# 调用模型生成文本
response = openai.Completion.create(
engine='text-davinci-003',
prompt='Once upon a time',
max_tokens=100
)
# 输诞生成的文本
print(response.choices[0].text)
openai key api examples的进一步展开说明
开放人工智能(OpenAI)概述
开放人工智能(OpenAI)是OpenAI API端点的R包装器。该软件包涵盖了模型、完成、聊天、编辑、图象、嵌入、音频、文件、微调、调理和遗留引擎端点。后者,即引擎,被保存以备向后兼容,并将很快被删除。
安装
从CRAN安装{openai}最简单的方法是使用“官方”安装包install.packages()函数:
你也能够从GitHub安装{openai}的开发版本:
if ( ! require (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)) install.packages ( “usethis” ) :: edit_r_environ ( scope = “project” ) usethis
您可以在文件中添加以下行(一样,用您的实际密钥替换 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx):
= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx OPENAI_API_KEYxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
注意:如果您正在使用GitHub/Gitlab,请不要忘记将.Renviron添加到.gitignore中!
最后,您始终可以手动向软件包的函数提供密钥。
示例
{openai}的函数具有自解释的名称。例如,要创建一个完成,请使用create_completion()函数:
library (openai) create_completion ( model = “ada” , prompt = “生成一个问题和答案” ) #> $id #> [1] “cmpl⑹MiImjcaCSuQYY6u8UA2Mm0rCdbEo” #> #> $object #> [1] “text_completion” #> #> $created #> [1] 1670871532 #> #> $model #> [1] “ada” #> #> $choices #> text #> 1 根据用户区别情况,完成时间在5分钟到一个小时不等 #> 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年世界系列赛在德州阿灵顿的环球人寿球场进行。
最后,语音转文本的Whisper可以通过create_transcription()和create_translation()使用:
openai key api examples的常见问答Q&A
问题1:如何申请和接入OpenAI的API接口?
答案:申请和接入OpenAI的API接口的步骤以下:
- 首先,访问OpenAI官方网站,前往API页面。
- 点击“Get Started”按钮,选择相应的API产品。
- 注册OpenAI账号,填写必要的个人信息。
- 创建API密钥,生成用于访问API的唯一密钥。
- 安装OpenAI的API库,如使用Python,可以通过pip安装openai库。
- 调用API接口,使用生成的API密钥进行身份验证,发送要求并处理响应。
示例:
下面是使用Python调用OpenAI API接口的示例代码:
import openai
openai.api_key = 'YOUR_API_KEY'
response = openai.Completion.create(
engine="davinci",
prompt="Once upon a time",
max_tokens=100
)
print(response.choices[0].text)
- 在上述示例中,我们首先导入openai库,并设置API密钥,将YOUR_API_KEY替换为你自己的API密钥。
- 然后,我们使用openai.Completion.create方法发送一个文本生成的要求。
- 最后,我们打印诞生成的文本结果。