Skip to content

types: add 'max' think level to match Go ThinkValue #702

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
vaderollama wants to merge 1 commit into
base: main
Choose a base branch
from
+33 −15
Open

types: add 'max' think level to match Go ThinkValue #702

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
24 changes: 12 additions & 12 deletions ollama/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ def generate(
template: str = '',
context: Optional[Sequence[int]] = None,
stream: Literal[False] = False,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
raw: bool = False,
Expand All @@ -233,7 +233,7 @@ def generate(
template: str = '',
context: Optional[Sequence[int]] = None,
stream: Literal[True] = True,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
raw: bool = False,
Expand All @@ -256,7 +256,7 @@ def generate(
template: Optional[str] = None,
context: Optional[Sequence[int]] = None,
stream: bool = False,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
raw: Optional[bool] = None,
Expand Down Expand Up @@ -313,7 +313,7 @@ def chat(
*,
tools: Optional[Sequence[Union[Mapping[str, Any], Tool, Callable]]] = None,
stream: Literal[False] = False,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
format: Optional[Union[Literal['', 'json'], JsonSchemaValue]] = None,
Expand All @@ -329,7 +329,7 @@ def chat(
*,
tools: Optional[Sequence[Union[Mapping[str, Any], Tool, Callable]]] = None,
stream: Literal[True] = True,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
format: Optional[Union[Literal['', 'json'], JsonSchemaValue]] = None,
Expand All @@ -344,7 +344,7 @@ def chat(
*,
tools: Optional[Sequence[Union[Mapping[str, Any], Tool, Callable]]] = None,
stream: bool = False,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
format: Optional[Union[Literal['', 'json'], JsonSchemaValue]] = None,
Expand Down Expand Up @@ -842,7 +842,7 @@ async def generate(
template: str = '',
context: Optional[Sequence[int]] = None,
stream: Literal[False] = False,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
raw: bool = False,
Expand All @@ -866,7 +866,7 @@ async def generate(
template: str = '',
context: Optional[Sequence[int]] = None,
stream: Literal[True] = True,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
raw: bool = False,
Expand All @@ -889,7 +889,7 @@ async def generate(
template: Optional[str] = None,
context: Optional[Sequence[int]] = None,
stream: bool = False,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
raw: Optional[bool] = None,
Expand Down Expand Up @@ -945,7 +945,7 @@ async def chat(
*,
tools: Optional[Sequence[Union[Mapping[str, Any], Tool, Callable]]] = None,
stream: Literal[False] = False,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
format: Optional[Union[Literal['', 'json'], JsonSchemaValue]] = None,
Expand All @@ -961,7 +961,7 @@ async def chat(
*,
tools: Optional[Sequence[Union[Mapping[str, Any], Tool, Callable]]] = None,
stream: Literal[True] = True,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
format: Optional[Union[Literal['', 'json'], JsonSchemaValue]] = None,
Expand All @@ -976,7 +976,7 @@ async def chat(
*,
tools: Optional[Sequence[Union[Mapping[str, Any], Tool, Callable]]] = None,
stream: bool = False,
think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None,
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None,
logprobs: Optional[bool] = None,
top_logprobs: Optional[int] = None,
format: Optional[Union[Literal['', 'json'], JsonSchemaValue]] = None,
Expand Down
4 changes: 2 additions & 2 deletions ollama/_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ class GenerateRequest(BaseGenerateRequest):
images: Optional[Sequence[Image]] = None
'Image data for multimodal models.'

think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None
'Enable thinking mode (for thinking models).'

logprobs: Optional[bool] = None
Expand Down Expand Up @@ -400,7 +400,7 @@ def serialize_model(self, nxt):
tools: Optional[Sequence[Tool]] = None
'Tools to use for the chat.'

think: Optional[Union[bool, Literal['low', 'medium', 'high']]] = None
think: Optional[Union[bool, Literal['low', 'medium', 'high', 'max']]] = None
'Enable thinking mode (for thinking models).'

logprobs: Optional[bool] = None
Expand Down
20 changes: 19 additions & 1 deletion tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1490,10 +1490,28 @@ async def test_async_client_context_manager():


def test_generate_think_annotation_matches_chat():
# The `think` parameter accepts bool or the 'low'/'medium'/'high' string levels.
# The `think` parameter accepts bool or the 'low'/'medium'/'high'/'max' string levels.
# Client.generate must keep the same annotation as Client.chat and
# AsyncClient.generate so passing a string level does not raise a false type
# error (regression guard for the sync generate overloads/implementation).
expected = inspect.signature(Client.chat).parameters['think'].annotation
assert inspect.signature(Client.generate).parameters['think'].annotation == expected
assert inspect.signature(AsyncClient.generate).parameters['think'].annotation == expected


def test_think_max_level_accepted():
# The 'max' think level must be accepted by all generate/chat methods without
# raising a type error (mirrors the Go ThinkValue which accepts 'max').
import typing

for method in (Client.generate, Client.chat, AsyncClient.generate, AsyncClient.chat):
annotation = typing.get_type_hints(method).get('think')
args = typing.get_args(annotation)
# Flatten nested Unions/Literals to find the literal values
literals = set()
for arg in args:
if arg is bool or arg is bool:
continue
sub = typing.get_args(arg)
literals.update(sub)
assert 'max' in literals, f'{method.__qualname__} think annotation missing max: {literals}'
Loading