Skip to content

fix(openai_compatible): handle None tool.description in function_call format and token counting #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
v4mpir0ck wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(openai_compatible): handle None tool.description in function_call format and token counting #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/dify_plugin/entities/tool.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ def to_prompt_message(self) -> PromptMessageTool:
for name, parameter in self.tool_parameters.items():
tool.parameters[name] = {
"type": parameter.type.value,
"description": parameter.description,
"description": parameter.description or "",
}

if parameter.required:
Expand Down
2 changes: 1 addition & 1 deletion src/dify_plugin/interfaces/agent/strategy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ def _convert_tool_to_prompt_message_tool(
"""Convert tool to prompt message tool"""
message_tool = PromptMessageTool(
name=tool.identity.name,
description=tool.description.llm if tool.description else "",
description=(tool.description.llm or "") if tool.description else "",
parameters={
"type": "object",
"properties": {},
Expand Down
4 changes: 2 additions & 2 deletions src/dify_plugin/interfaces/model/openai_compatible/llm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,7 @@ def _generate(
data["functions"] = [
{
"name": tool.name,
"description": tool.description,
"description": tool.description or "",
"parameters": tool.parameters,
}
for tool in tools
Expand Down Expand Up @@ -1127,7 +1127,7 @@ def _num_tokens_for_tools(self, tools: list[PromptMessageTool]) -> int:
num_tokens += self._get_num_tokens_by_gpt2(tool.name)
num_tokens += self._get_num_tokens_by_gpt2("description")
if hasattr(tool, "description"):
num_tokens += self._get_num_tokens_by_gpt2(tool.description)
num_tokens += self._get_num_tokens_by_gpt2(tool.description or "")
Comment on lines 1129 to +1130
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot May 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Since description is a required field in the PromptMessageTool Pydantic model, the hasattr(tool, "description") check is redundant. An instance of PromptMessageTool will always have this attribute.

You can simplify this by removing the conditional check. This would also make the code more consistent with the _generate method (line 601), which accesses tool.description directly.

            num_tokens += self._get_num_tokens_by_gpt2(tool.description or "")

if hasattr(tool, "parameters"):
parameters = tool.parameters
num_tokens += self._get_num_tokens_by_gpt2("parameters")
Expand Down