OpenAI 使用

1. 创建相关文件

创建一个yaml文件，例如 user_openai.yaml 将以下内容粘贴到您的user_openai.yaml文件当中

name: 'user_openai_llm'
description: 'user define openai llm'
model_name: 'gpt-3.5-turbo'
temperature: 0.5
max_tokens: 2000
streaming: True
api_key: '${OPENAI_API_KEY}'
api_base: 'https://api.openai.com/v1'
organization: '${OPENAI_ORGANIZATION}'
proxy: '${OPENAI_PROXY}'
metadata:
  type: 'LLM'
  module: 'agentuniverse.llm.default.default_openai_llm'
  class: 'DefaultOpenAILLM'

note: api_key/api_base/organization/proxy等模型参数有三种配置方法

直接字符串值：直接在配置文件中输入API密钥字符串。
```
api_key: 'sk-***'
```
环境变量占位符：使用${VARIABLE_NAME}语法从环境变量中加载。当agentUniverse启动时，会自动从环境变量读取相应的值。
```
api_key: '${OPENAI_API_KEY}'
```
自定义函数加载：使用@FUNC注解在运行时通过自定义函数动态加载API密钥。
```
api_key: '@FUNC(load_api_key(model_name="openai"))'
```
该函数需要在yaml_func_extension.py文件的YamlFuncExtension类中定义，可参考样例工程中的YamlFuncExtension，当agentUniverse加载此配置时：
- 解析@FUNC注解
- 执行load_api_key函数并传入相应参数
- 用函数返回值替换注解内容

2. 环境设置

示例yaml中模型密钥等参数使用环境变量占位符，下面将介绍环境变量设置方法。

必须配置：OPENAI_API_KEY
可选配置：OPENAI_PROXY, OPENAI_API_BASE, OPENAI_ORGANIZATION

2.1 通过python代码配置

import os
os.environ['OPENAI_API_KEY'] = 'sk-***'
os.environ['OPENAI_PROXY'] = 'https://xxxxxx'
os.environ['OPENAI_API_BASE'] = 'https://api.openai.com/v1'

2.2 通过配置文件配置

在项目的config目录下的custom_key.toml当中，添加配置：

OPENAI_API_KEY="sk-******"
OPENAI_PROXY="https://xxxxxx"
OPENAI_API_BASE="https://api.openai.com/v1"
OPENAI_ORGANIZATION = ''

3. API KEY 获取

参考文档

4. Tips

在agentuniverse中，我们已经创建了一个name为default_openai_llm的llm,用户在配置OPENAI_API_KEY之后可以直接使用。

2.4 KiB Raw Permalink Blame History Unescape Escape