Skip to content

fix(utils): emit multi-type tool params as JSON array, not a comma-joined string #695

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
anxkhn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(utils): emit multi-type tool params as JSON array, not a comma-joined string #695

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
7 changes: 6 additions & 1 deletion ollama/_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,14 @@ def convert_function_to_tool(func: Callable) -> Tool:
schema['required'].remove(k)
types.discard('null')

# Emit a single type as a string and multiple types as a JSON-Schema array.
# A comma-joined string (e.g. 'integer, string') is parsed by the server as one
# invalid type name, silently dropping the constraint. Sorting also makes the
# output deterministic across runs since types is a set.
sorted_types = sorted(types)
schema['properties'][k] = {
'description': parsed_docstring[k],
'type': ', '.join(types),
'type': sorted_types if len(sorted_types) > 1 else ''.join(sorted_types),
}

tool = Tool(
Expand Down
6 changes: 4 additions & 2 deletions tests/test_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,10 @@ def all_types(
if sys.version_info >= (3, 10):
assert tool['function']['parameters']['properties']['z']['type'] == 'array'
assert tool['function']['parameters']['properties']['w']['type'] == 'object'
assert {x.strip().strip("'") for x in tool['function']['parameters']['properties']['v']['type'].removeprefix('[').removesuffix(']').split(',')} == {'string', 'integer'}
assert tool['function']['parameters']['properties']['v']['type'] != 'null'
# A multi-type parameter must be a JSON array, not a comma-joined string, so the
# server parses each type instead of one invalid 'integer, string' type name.
assert isinstance(tool['function']['parameters']['properties']['v']['type'], list)
assert tool['function']['parameters']['properties']['v']['type'] == ['integer', 'string']
assert tool['function']['parameters']['required'] == ['x', 'y', 'z', 'w']
else:
assert tool['function']['parameters']['properties']['z']['type'] == 'array'
Expand Down