Core Functions Reference
Runtime
Core runtime engine for LLM tool calling.
ToolRuntime
Runtime engine for LLM tool calling.
Supports both: - Custom callable: def my_llm(system_prompt: str, user_prompt: str) -> str - LangChain models: Any BaseChatModel instance
Example
from langchain_google_genai import ChatGoogleGenerativeAI llm = ChatGoogleGenerativeAI(model="gemini-1.5-flash") runtime = ToolRuntime(llm)
@runtime.tool def add(a: int, b: int) -> int: ... return a + b
runtime.run("What is 5 + 3?") 'The result is 8.'
Source code in llm_tool_runtime/runtime.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 | |
__init__(llm, max_steps=5, max_retries=None, verbose=False)
Initialize the tool runtime.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
llm
|
Union[Callable[[str, str], str], Any]
|
Either a callable (system, user) -> str, or a LangChain model |
required |
max_steps
|
int
|
Maximum number of steps (tool calls) in a chain. Defaults to 5. |
5
|
max_retries
|
Optional[int]
|
Legacy parameter, alias for max_steps. |
None
|
verbose
|
bool
|
If True, print debug information |
False
|
Raises:
| Type | Description |
|---|---|
ValueError
|
If llm is None or invalid |
Source code in llm_tool_runtime/runtime.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | |
run(user_prompt)
Run the tool calling loop for a user prompt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_prompt
|
str
|
The user's input/question |
required |
Returns:
| Type | Description |
|---|---|
str
|
The final LLM response after any tool calls |
Raises:
| Type | Description |
|---|---|
ValueError
|
If user_prompt is empty |
MaxRetriesExceededError
|
If tool calling fails after max retries |
InvalidAPIKeyError
|
If API key is invalid or missing |
RateLimitError
|
If API rate limit is exceeded |
LLMConnectionError
|
If connection to LLM fails |
Source code in llm_tool_runtime/runtime.py
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | |
run_safe(user_prompt, default='I encountered an error processing your request.')
Run the tool calling loop with automatic error handling.
This method never raises exceptions - it returns a default message on error. Useful for production environments where you want graceful degradation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_prompt
|
str
|
The user's input/question |
required |
default
|
str
|
Default message to return on error |
'I encountered an error processing your request.'
|
Returns:
| Type | Description |
|---|---|
str
|
The LLM response or the default message on error |
Source code in llm_tool_runtime/runtime.py
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 | |
run_with_history(user_prompt, history=None)
Run with conversation history support.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
user_prompt
|
str
|
The user's input |
required |
history
|
list
|
List of previous (user, assistant) message tuples |
None
|
Returns:
| Type | Description |
|---|---|
tuple[str, list]
|
Tuple of (response, updated_history) |
Source code in llm_tool_runtime/runtime.py
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 | |
tool(fn=None, *, description=None)
Decorator to register a function as a tool.
Usage
@runtime.tool def my_tool(arg1: str) -> str: return "result"
@runtime.tool(description="Custom description") def another_tool(x: int) -> int: return x * 2
Source code in llm_tool_runtime/runtime.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 | |
Registry
Tool registry for managing registered functions.
Tool
Wrapper for a callable function registered as a tool.
Source code in llm_tool_runtime/registry.py
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 | |
call(args)
Execute the tool with the given arguments.
Source code in llm_tool_runtime/registry.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | |
get_schema()
Get the tool schema for prompt building.
Source code in llm_tool_runtime/registry.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 | |
ToolRegistry
Registry for managing tool functions.
Source code in llm_tool_runtime/registry.py
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | |
get(name)
Get a tool by name, raises ToolNotFoundError if not found.
Source code in llm_tool_runtime/registry.py
80 81 82 83 84 | |
get_all_schemas()
Get schemas for all registered tools.
Source code in llm_tool_runtime/registry.py
90 91 92 | |
list_tools()
List all registered tool names.
Source code in llm_tool_runtime/registry.py
86 87 88 | |
register(fn=None, *, description=None)
Register a function as a tool.
Can be used as a decorator with or without arguments
@registry.register def my_tool(): ...
@registry.register(description="My tool description") def my_tool(): ...
Source code in llm_tool_runtime/registry.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 | |
Parser
Parser for extracting tool calls from LLM output.
extract_all_tool_calls(text)
Extract all tool calls from LLM output (for future multi-tool support).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
str
|
The raw LLM output text |
required |
Returns:
| Type | Description |
|---|---|
list[ToolCall]
|
List of ToolCall dicts found in the text |
Source code in llm_tool_runtime/parser.py
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 | |
parse_tool_call(text)
Parse a tool call from LLM output text.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
str
|
The raw LLM output text |
required |
Returns:
| Type | Description |
|---|---|
Optional[ToolCall]
|
ToolCall dict with 'name' and 'arguments' if found, None otherwise |
Source code in llm_tool_runtime/parser.py
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | |