ChatGLM3工具调用问题解析与解决方案

问题背景

在ChatGLM3项目中，用户在使用tools_using_demo/openai_api_demo.py进行工具调用测试时遇到了422错误。该问题主要出现在工具注册和调用过程中，特别是当尝试使用随机数生成器(random_number_generator)工具时，会出现AttributeError异常。

问题分析

422错误原因

原始代码中，工具注册系统使用了字典(_TOOL_DESCRIPTIONS = {})来存储工具描述信息。然而，OpenAI API期望的工具参数格式应该是列表类型而非字典。这种类型不匹配导致了422错误(Unprocessable Entity Error)。

NoneType错误原因

当用户修改工具注册系统为列表类型后，天气查询工具(get_weather)可以正常工作，但随机数生成器工具仍然失败。这是因为在处理工具调用响应时，代码尝试访问chunk.choices[0].delta.function_call属性，但该属性在某些情况下可能为None。

解决方案

工具注册系统修改

1. 将tool_register.py中的_TOOL_DESCRIPTIONS从字典改为列表：

   _TOOL_DESCRIPTIONS = []  # 原为 _TOOL_DESCRIPTIONS = {}
   

2. 修改register_tool方法中的工具添加方式：

   _TOOL_DESCRIPTIONS.append(tool_def)  # 原为 _TOOL_DESCRIPTIONS[tool_name] = tool_def
   

3. 更新get_tools方法的返回类型声明：

   def get_tools() -> list[Any]:  # 原为 def get_tools() -> dict:
   

工具调用处理优化

对于function_call可能为None的情况，应该添加适当的错误处理：

function_call = chunk.choices[0].delta.function_call
if function_call is None:
    logger.error("Function call is None")
    continue  # 或采取其他适当的错误处理措施

技术原理

ChatGLM3的工具调用机制基于OpenAI API规范，其核心原理是：

1. 工具注册：通过定义工具的名称、描述和参数，系统能够理解可用的工具及其使用方式。

2. 工具选择：模型根据用户查询的内容，自动判断是否需要调用工具以及调用哪个工具。

3. 参数提取：模型从用户输入中提取出符合工具定义的参数。

4. 工具执行：系统执行实际工具代码并返回结果。

5. 结果整合：模型将工具执行结果整合到最终回复中。

最佳实践建议

1. 工具定义规范化：确保工具的描述、参数定义等符合OpenAI API规范。

2. 错误处理完善化：对所有可能的None值情况进行防御性编程。

3. 日志记录详细化：在关键步骤添加详细的日志记录，便于问题排查。

4. 类型检查严格化：使用类型注解和运行时类型检查确保数据格式正确。

5. 测试覆盖全面化：为各种工具调用场景编写测试用例。

总结

ChatGLM3的工具调用功能虽然强大，但在实际使用中需要注意API规范和数据类型的匹配问题。通过将工具注册系统从字典改为列表，并完善错误处理逻辑，可以有效解决工具调用失败的问题。开发者在使用时应当充分理解工具调用机制的原理，并遵循最佳实践来确保功能的稳定性和可靠性。