Wrapper's Delight: 增强型OpenAI包装器的全面解析

Ray

wrappers_delight

Wrapper's Delight:为OpenAI API赋能的多功能包装器

在人工智能快速发展的今天,OpenAI的ChatGPT API已成为许多开发者和企业不可或缺的工具。然而,如何更高效地使用这一强大的API,如何更好地管理和分析API调用,一直是开发者们关注的问题。Wrapper's Delight应运而生,它作为OpenAI ChatCompletion API的增强型包装器,为开发者提供了一系列实用的功能,极大地提升了API的使用体验和效率。

主要特性一览

Wrapper's Delight的主要特性包括:

自动日志记录:每次与模型的交互都会被自动记录到NDJSON文件中。
分析功能:提供可视化工具,帮助开发者了解模型使用情况。
日志查询:支持基于参数或AI辅助的日志查询。
自动反思:可选功能,对每个提示进行反思并提出改进建议。

这些功能不仅提高了开发效率,还为API使用提供了深入的洞察。接下来,让我们详细探讨Wrapper's Delight的各项功能及其使用方法。

安装与基本使用

要开始使用Wrapper's Delight,首先需要克隆其GitHub仓库:

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

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

pip install openai

基本的聊天完成功能使用如下:

import openai
from wrappers_delight import ChatWrapper

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)

这段代码除了导入ChatWrapper外,与标准的OpenAI ChatCompletion调用完全相同。然而,使用ChatWrapper后,每次API调用都会被自动记录下来。

自动日志记录

Wrapper's Delight的一大亮点是自动日志记录功能。所有与模型的交互都会被记录到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"
}

这种详细的日志记录为后续的分析和优化提供了宝贵的数据。

分析功能

Wrapper's Delight提供了一系列分析工具,帮助开发者可视化模型的使用情况。要使用这些分析工具,可以这样导入:

from wrappers_delight.analytics import plot_token_usage, plot_model_distribution, plot_response_time_distribution

# 生成并显示分析图表
plot_token_usage()
plot_model_distribution()
plot_response_time_distribution()

这些函数会生成直观的图表,展示token使用情况、模型分布和响应时间分布等关键指标。这些信息对于优化API使用、控制成本和提高效率都非常有帮助。

Token使用情况

日志查询

Wrapper's Delight提供了两种查询日志的方法:query_log()和query_log_with_ai()。

query_log()支持多种参数,如日期范围、token数量、关键词等,可以精确地筛选所需的日志条目。例如:

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

而query_log_with_ai()则更进一步,它能理解自然语言查询,并将其转换为适当的参数。例如:

result = query_log_with_ai("Show me the last 3 logs.")

这个函数会自动将这个自然语言查询转换为适当的参数,并调用query_log()函数。

这两个功能极大地提高了日志分析的效率,使开发者能够快速找到所需的信息。

自动反思功能

Wrapper's Delight的另一个强大功能是自动反思。这个功能可以评估AI模型对提示的理解,并提出潜在的改进建议。要启用这个功能,只需要:

wrapper.ChatWrapper.enable_reflection()

启用后,每次ChatCompletion调用都会生成一个反思,包括AI对提示的分析、响应是否满意,以及改进后的提示建议。这些反思被存储在prompt_reflections.ndjson文件中。

例如,一个反思条目可能如下所示:

{
  "kwargs": {
    "messages": [
      {"role": "user", "content": "What's the weather like today?"}
    ]
  },
  "reflection": {
    "Analysis": "The AI interpreted this as a request for current weather information. However, without specific location data, it's impossible to provide an accurate answer.",
    "Is Satisfactory": false,
    "Suggested Prompt": "What's the weather like today in [specific location]?"
  }
}

这个功能对于优化提示、提高AI响应质量非常有帮助。