chatlab

ChatLab 项目介绍

项目概述

ChatLab 是一个方便进行 OpenAI 聊天模型实验的 Python 包。它提供了一个简单的接口，用户可以与模型进行对话，并注册可供聊天模型调用的函数。ChatLab 支持在交互式笔记本中使用，使得实验更加直观和动态。

安装与配置

用户可以通过以下命令安装 ChatLab：

pip install chatlab

安装完成后，需要设置 OPENAI_API_KEY 环境变量。在本地工作时，建议将其保存在 .env 文件中以确保安全。在托管的笔记本环境中，也应将其保存在“秘密”配置中以保护隐私。

功能与用法

基本功能

ChatLab 的主要功能包括 Chat 类，该类可以用来与 OpenAI 的模型进行聊天，并会保留一段聊天记录。这些记录存储在 Chat.messages 中。用户可以通过 submit 方法将预构建的消息发送到 OpenAI 进行处理，并以 Markdown 格式展示助手的回复。

注册函数

用户可以通过 Chat.register 方法注册函数，使其可供聊天模型调用。注册的函数需要包含一个文档字符串作为描述，并使用 pydantic.BaseModel 进行模式验证。以下是一个简单的例子：

from pydantic import BaseModel
from datetime import datetime
from pytz import timezone, all_timezones, utc
from typing import Optional

class WhatTime(BaseModel):
    tz: Optional[str] = None

def what_time(tz: Optional[str] = None):
    if tz is None:
        pass
    elif tz in all_timezones:
        tz = timezone(tz)
    else:
        return 'Invalid timezone'

    return datetime.now(tz).strftime('%I:%M %p')

chat.register(what_time, WhatTime)

注册成功后，用户可以使用 await chat("What time is it?") 来调用注册的 what_time 函数。

消息生成

ChatLab 提供了 human（或 user）和 narrate（或 system）函数，用于生成用户和系统的信息。用户消息通常用于提出问题，而系统消息则用来引导模型朝特定方向进行。

from chatlab import human, narrate

human("How are you?")
narrate("You are a large bird")

开发与贡献

ChatLab 项目使用 Poetry 进行依赖管理。开发者可以通过克隆代码库并运行

poetry install -E dev -E test

进行本地开发。项目使用 ruff 和 mypy 进行代码检查。我们欢迎大家的贡献，如有重大改动，请提前开启 issue 进行讨论。

通过 ChatLab，用户可以轻松地利用 OpenAI 模型进行各种有趣的实验和创作。不论是初学者还是经验丰富的开发者，都能从中受益。欢迎大家积极参与并探索更多可能性！