OpenAI Node 库中 ChatCompletionMessageParam 类型的使用注意事项

在使用 OpenAI Node 库进行聊天补全功能开发时，开发者可能会遇到关于 ChatCompletionMessageParam 类型的类型检查错误。本文详细解析这一问题的根源及解决方案。

问题背景

在 OpenAI 的聊天补全 API 中，消息内容(content)的类型会根据消息角色(role)的不同而有所变化。当角色是"user"时，content 可以是一个包含文本和图像的多媒体内容数组；但当角色是"assistant"时，content 必须是一个纯字符串。

技术细节

1. 用户消息(User Message)：

   • 可以包含复杂的内容结构
   • 支持多媒体内容组合
   • 示例格式：

     {
       role: "user",
       content: [
         { type: "text", text: "What is this?" },
         { type: "image_url", image_url: { url: "data:image/jpeg;base64,..." } }
       ]
     }
     

2. 助手消息(Assistant Message)：

   • 内容必须是简单字符串
   • 不支持多媒体内容
   • 正确格式：

     {
       role: "assistant",
       content: "This is a response from the assistant."
     }
     

常见错误模式

开发者常犯的错误是将助手消息的内容也写成数组形式，这会导致 TypeScript 类型检查错误。例如以下错误写法：

{
  role: "assistant",
  content: [
    {
      type: "text",
      text: "This is an incorrect format for assistant message."
    }
  ]
}

解决方案

1. 确保助手消息的内容是字符串类型
2. 对于用户消息，可以保持多媒体内容数组的形式
3. 使用 TypeScript 时，可以利用类型提示来避免这类错误

最佳实践建议

1. 对不同角色的消息采用不同的内容构造方式
2. 在代码中添加类型检查注释
3. 考虑封装消息构造函数，根据角色自动处理内容格式

总结

OpenAI Node 库对聊天消息的内容格式有严格要求，理解并正确处理不同角色消息的内容类型差异，是避免类型错误的关键。开发者应当特别注意助手消息必须使用字符串内容这一限制，以确保代码能够顺利通过类型检查并正确调用 API。