wrappers_delight

wrappers_delight

增强型OpenAI API Python封装库

wrappers_delight是一个为OpenAI ChatCompletion API设计的增强型Python封装库。它集成了自动日志记录、使用分析和日志查询等功能,帮助开发者高效管理API调用。此外,该项目还提供可选的提示反思功能和日志可视化界面,旨在简化API使用流程,深化数据洞察,并促进提示工程的优化。

OpenAIChatCompletionPython包装器日志记录分析功能Github开源项目

Wrapper's Delight:增强型OpenAI包装器

**wrappers_delight**是一个围绕OpenAI的ChatCompletion API构建的Python包装器。该包装器的主要特点包括:

  • 每次交互自动记录到NDJSON文件。
  • 用于可视化模型使用情况的分析功能。
  • 基于参数或AI辅助的日志查询。
  • (可选)对每个提示自动进行反思并提出改进建议。

要开始使用,你需要克隆此仓库:

git clone https://github.com/yoheinakajima/wrappers_delight.git
cd wrappers_delight

先决条件

确保已安装OpenAI的Python客户端:

pip install openai

使用方法

基本聊天完成

要使用包装器进行与模型的基本对话,加载包装器后,每个提示输入和输出都将被存储:<br> *除第2行外,这是标准的OpenAI ChatCompletion调用。

import openai
from wrappers_delight import ChatWrapper

# 设置你的OpenAI API密钥
openai.api_key = "YOUR_API_KEY"

# 与模型进行对话
response = openai.ChatCompletion.create(
    model="gpt-3.5-turbo",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Tell me a fun fact."},
    ]
)

print(response.choices[0].message.content)

使用自定义函数

注册和使用自定义函数:<br> *除第2行外,这是使用函数的标准OpenAI ChatCompletion调用。

import openai
from wrappers_delight.wrapper import _enhanced_chat_completion

# 设置你的OpenAI API密钥
openai.api_key = "YOUR_OPENAI_KEY"

completion = openai.ChatCompletion.create(
    model="gpt-3.5-turbo-0613",
    messages=[
        {
            "role": "user", 
            "content": "I visited Tokyo, then moved to San Francisco, and finally settled in Toronto."
        }
    ],
    functions=[
        {
            "name": "extract_locations",
            "description": "Extract all locations mentioned in the text",
            "parameters": {
                "type": "object",
                "properties": {
                    "locations": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "name": {
                                    "type": "string",
                                    "description": "The name of the location"
                                },
                                "country_iso_alpha2": {
                                    "type": "string",
                                    "description": "The ISO alpha-2 code of the country where the location is situated"
                                }
                            },
                            "required": ["name", "country_iso_alpha2"]
                        }
                    }
                },
                "required": ["locations"],
            },
        },
    ],
    function_call={"name": "extract_locations"}
)

response_data = completion.choices[0]['message']['function_call']['arguments']
print(response_data)

日志记录

与模型的所有交互都会自动记录到log.ndjson文件中。NDJSON中的每一行都包含请求参数和相应的模型响应。

示例输出

以下是log.ndjson中的两个示例输出。第一个是标准的ChatCompletion调用,第二个是函数调用:

{"timestamp": "2023-08-13 03:00:49", "response_time": 3.21, "params": {"model": "gpt-3.5-turbo", "messages": [{"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "Tell me a fun fact."}]}, "response": {"id": "chatcmpl-7mvdPu0H1QULvDZOUVJS6npdMslul", "object": "chat.completion", "created": 1691895647, "model": "gpt-3.5-turbo-0613", "choices": [{"index": 0, "message": {"role": "assistant", "content": "Sure! Here's a fun fact: Did you know that honey never spoils? Archaeologists have found pots of honey in ancient Egyptian tombs that are over 3,000 years old and still perfectly edible! Honey's low moisture content and acidic pH create an inhospitable environment for bacteria and other microorganisms, allowing it to last indefinitely."}, "finish_reason": "stop"}], "usage": {"prompt_tokens": 23, "completion_tokens": 70, "total_tokens": 93}}, "total_tokens": 93, "model": "gpt-3.5-turbo"}
{"timestamp": "2023-08-13 03:01:16", "response_time": 4.80, "params": {"model": "gpt-3.5-turbo-0613", "messages": [{"role": "user", "content": "I visited Tokyo, then moved to San Francisco, and finally settled in Toronto."}], "functions": [{"name": "extract_locations", "description": "Extract all locations mentioned in the text", "parameters": {"type": "object", "properties": {"locations": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string", "description": "The name of the location"}, "country_iso_alpha2": {"type": "string", "description": "The ISO alpha-2 code of the country where the location is situated"}}, "required": ["name", "country_iso_alpha2"]}}}, "required": ["locations"]}}], "function_call": {"name": "extract_locations"}}, "response": {"id": "chatcmpl-7mvdqfScl0uQ2tfye1HdfcPEV5XYI", "object": "chat.completion", "created": 1691895674, "model": "gpt-3.5-turbo-0613", "choices": [{"index": 0, "message": {"role": "assistant", "content": null, "function_call": {"name": "extract_locations", "arguments": "{\n  \"locations\": [\n    {\n      \"name\": \"Tokyo\",\n      \"country_iso_alpha2\": \"JP\"\n    },\n    {\n      \"name\": \"San Francisco\",\n      \"country_iso_alpha2\": \"US\"\n    },\n    {\n      \"name\": \"Toronto\",\n      \"country_iso_alpha2\": \"CA\"\n    }\n  ]\n}"}}, "finish_reason": "stop"}], "usage": {"prompt_tokens": 83, "completion_tokens": 74, "total_tokens": 157}}, "total_tokens": 157, "model": "gpt-3.5-turbo-0613"}

分析

要运行分析并可视化模型的使用情况,加载分析模块:

from wrappers_delight.analytics import plot_token_usage, plot_model_distribution, plot_response_time_distribution

生成并显示分析图表

plot_token_usage() plot_model_distribution() plot_response_time() plot_response_time_distribution()

# 查询日志
要启用日志查询功能,请加载以下两个查询函数:

from wrappers_delight.analytics import query_log, query_log_with_ai

*query_log()* 和 *query_log_with_ai()* 是用于从日志中检索特定条目的函数。query_log 根据各种参数直接查询日志,而 query_log_with_ai 使用 AI 模型根据上下文或更复杂的要求进一步优化结果。

## 前提条件
确保已安装所需的库。这包括 pandas、openai 以及其他根据需要的库。

## 使用 query_log()
参数:
* columns:要在结果中显示的列列表。
* start_date:要检索的日志的起始日期。
* end_date:日志的结束日期。
* min_tokens:响应中的最小令牌数。
* max_tokens:响应中的最大令牌数。
* filter_by:附加过滤条件。
* sort_by:结果应排序的列(默认为时间戳)。
* limit:限制结果中的行数。
* keyword:在用户消息或响应中搜索关键词。
* function_name:按函数名过滤。
* model_version:按模型版本过滤。

示例代码:

result = query_log(start_date="2023-08-01", end_date="2023-08-10", keyword="weather") print(result)


## 使用 query_log_with_ai
此函数解释自然语言用户查询,并将其转换为参数,使用 query_log 函数获取适当的日志条目。

### 使用示例:
用户查询:

result = query_log_with_ai("显示最后 3 条日志。")

query_log 的预期参数:

{ "limit": 3, "sort_by": "timestamp" }

用户查询:

result = query_log_with_ai("我想看到提到'天气'的前 5 条日志。")

query_log 的预期参数:

{ "keyword": "weather", "limit": 5 }

用户查询:

result = query_log_with_ai("你能按总令牌数对 gpt-3.5-turbo 模型的日志进行排序,但只显示时间戳、模型和总令牌数列吗?")

query_log 的预期参数:

{ "model_version": "gpt-3.5-turbo", "sort_by": "total_tokens", "columns": ["timestamp", "model", "total_tokens"] }

用户查询:

result = query_log_with_ai("我想要使用了 50 到 1000 个令牌并且只使用 gpt-3.5-turbo 模型的日志。")

query_log 的预期参数:

{ "min_tokens": 50, "max_tokens": 1000, "filter_by": { "model": "gpt-3.5-turbo" } }

用户查询:

result = query_log_with_ai("显示 8 月 12 日到 8 月 14 日的日志。")

query_log 的预期参数:

{ "start_date": "2023-08-12", "end_date": "2023-08-14" }

*`query_log_with_ai()`* 函数将自动使用生成的参数调用 *`query_log()`* 函数。上面的示例旨在帮助您理解 *`query_log_with_ai()`* 的功能,同时也为 *`query_log()`* 函数提供了额外的示例。

## 日志查询的自动存储
* 结果存储在 *log_queries* 目录中,使用唯一的文件名。
* 始终确保敏感数据得到适当处理,不会被暴露。

# 启用和使用反思功能
反思功能提供了 OpenAI 模型如何解释给定提示的洞察,评估其响应并建议潜在改进。此功能集成在 `wrapper.ChatWrapper` 中,使其易于启用或禁用。

## 如何启用:
1. 启用反思:只需使用以下行为所有后续的 ChatCompletion 调用启用反思功能:

wrapper.ChatWrapper.enable_reflection()

这将自动为使用 `ChatWrapper` 进行的所有聊天完成 API 调用启用反思。

2. 禁用反思:如果您希望关闭反思功能:

wrapper.ChatWrapper.disable_reflection()


## 反思的存储:

反思被记录并存储在 `prompt_reflections.ndjson` 文件中。此文件中的每个条目代表一个不同的反思,格式为新行分隔的 JSON(NDJSON)。这允许更容易地附加新的反思和简化解析。

每个反思条目的结构如下:

- **kwargs**:包含提供给 OpenAI 模型的输入提示。
- **reflection**:
  - **Analysis**:AI 如何解释提示以及其响应背后的理由的洞察。
  - **Is Satisfactory**:指示 AI 是否认为其响应令人满意。可以是 `True` 或 `False`。
  - **Suggested Prompt**:如果 AI 认为提示可以更清晰或更优化,这里提供建议的改进。

# Wrappers Delight UI

寻找一个用户友好的界面来可视化和解释由 `wrappers_delight` 生成的日志?查看 [`wrappers_delight_ui`](https://github.com/yoheinakajima/wrappers_delight_ui)!

`wrappers_delight_ui` 提供了一种直观的方式来查看反思和提示-响应动态。获得洞察,优化提示,并提高您对 AI 如何处理和响应各种提示的理解。

[在 GitHub 上探索 Wrappers Delight UI](https://github.com/yoheinakajima/wrappers_delight_ui)

# 贡献
如果您想贡献,请 fork 仓库并按您的意愿进行更改。我们热烈欢迎拉取请求。

# 许可证
根据 MIT 许可证分发。有关更多信息,请参阅 LICENSE。

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI助手AI工具AI写作工具AI辅助写作蛙蛙写作学术助手办公助手营销助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

热门AI工具生产力协作转型TraeAI IDE
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

聊天机器人AI助手热门AI工具AI对话
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

热门AI工具AI办公办公工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

模型训练热门AI工具内容创作智能问答AI开发讯飞星火大模型多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

AI助手热门AI工具AI创作AI辅助写作讯飞绘文内容运营个性化文章多平台分发
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多