Skip to content

feat: export EffortLevel as a named TypeAlias #939

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

Closed
algojogacor wants to merge 1 commit into from
Closed

feat: export EffortLevel as a named TypeAlias #939

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: 2 additions & 0 deletions src/claude_agent_sdk/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
ContextUsageCategory,
ContextUsageResponse,
DeferredToolUse,
EffortLevel,
HookCallback,
HookContext,
HookEventMessage,
Expand Down Expand Up @@ -601,6 +602,7 @@ async def call_tool(name: str, arguments: dict[str, Any]) -> Any:
# Agent support
"AgentDefinition",
"SettingSource",
"EffortLevel",
# Plugin support
"SdkPluginConfig",
# Session listing
Expand Down
9 changes: 6 additions & 3 deletions src/claude_agent_sdk/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from collections.abc import Awaitable, Callable
from dataclasses import dataclass, field
from pathlib import Path
from typing import TYPE_CHECKING, Any, Literal, Protocol
from typing import TYPE_CHECKING, Any, Literal, Protocol, TypeAlias

if sys.version_info >= (3, 11):
from typing import NotRequired, Required, TypedDict
Expand All @@ -31,6 +31,9 @@
# Agent definitions
SettingSource = Literal["user", "project", "local"]

# Thinking effort levels
EffortLevel: TypeAlias = Literal["low", "medium", "high", "xhigh", "max"]


class SystemPromptPreset(TypedDict):
"""System prompt preset configuration."""
Expand Down Expand Up @@ -96,7 +99,7 @@ class AgentDefinition:
initialPrompt: str | None = None # noqa: N815
maxTurns: int | None = None # noqa: N815
background: bool | None = None
effort: Literal["low", "medium", "high", "xhigh", "max"] | int | None = None
effort: EffortLevel | int | None = None
permissionMode: PermissionMode | None = None # noqa: N815


Expand Down Expand Up @@ -1864,7 +1867,7 @@ class ClaudeAgentOptions:
See https://docs.anthropic.com/en/docs/build-with-claude/adaptive-thinking.
"""

effort: Literal["low", "medium", "high", "xhigh", "max"] | None = None
effort: EffortLevel | None = None
"""Controls how much effort Claude puts into its response.

Works with adaptive thinking to guide thinking depth.
Expand Down