如果你正在使用 OpenAI 助手,请查看 OpenAI Assistant 示例应用。

此集成的优势在于,你可以在 UI 的步骤中查看 OpenAI API 调用,并可以在提示词演练场中探索它们。

如果你的项目正在使用 Literal AI,你还将在 Literal AI 控制台中获得完整的生成详情(提示词、补全、每秒 token 数等)。

在创建 OpenAI 客户端后,你需要添加 cl.instrument_openai()

如果你已经在使用 Langchain 或 LlamaIndex 等其他集成,则不应配置此集成。这两个集成会记录相同的生成内容,并在 UI 中创建重复的步骤。

前提条件

在开始之前,请确保你已准备好以下各项:

  • 已成功安装 Chainlit
  • 已安装 OpenAI 包
  • 一个 OpenAI API 密钥
  • 对 Python 编程有基本了解

步骤 1:创建一个 Python 文件

在你的项目目录中创建一个名为 app.py 的新 Python 文件。此文件将包含你的 LLM 应用程序的主要逻辑。

步骤 2:编写应用逻辑

app.py 中,导入所需的包并定义一个函数来处理来自 UI 的传入消息。

from openai import AsyncOpenAI
import chainlit as cl
client = AsyncOpenAI()

# Instrument the OpenAI client
cl.instrument_openai()

settings = {
    "model": "gpt-3.5-turbo",
    "temperature": 0,
    # ... more settings
}

@cl.on_message
async def on_message(message: cl.Message):
    response = await client.chat.completions.create(
        messages=[
            {
                "content": "You are a helpful bot, you always reply in Spanish",
                "role": "system"
            },
            {
                "content": message.content,
                "role": "user"
            }
        ],
        **settings
    )
    await cl.Message(content=response.choices[0].message.content).send()

步骤 3:填写环境变量

在与 app.py 文件相同的文件夹中创建一个名为 .env 的文件。在 OPENAI_API_KEY 变量中添加你的 OpenAI API 密钥。你可以选择性地在 LITERAL_API_KEY 中添加你的 Literal AI API 密钥。

步骤 4:运行应用程序

要启动你的应用,请打开终端并导航到包含 app.py 的目录。然后运行以下命令:

chainlit run app.py -w

-w 标志告诉 Chainlit 启用自动重载,这样你每次更改应用时就不需要重新启动服务器。你的聊天机器人 UI 现在应该可以通过 http://localhost:8000 访问了。