Skip to content

LLMfy

llmfy.llmfy_core.llmfy

LLMfy

Source code in llmfy/llmfy_core/llmfy.py
 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
 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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
class LLMfy:
    def __init__(
        self,
        llm: BaseAIModel,
        system_message: Optional[str] = None,
        input_variables: Optional[List[str]] = None,
    ):
        self.model: BaseAIModel = llm
        self.messages_temp: MessageTemp = MessageTemp()
        self.system_message = system_message
        self.input_variables = input_variables or []
        self._tools: Dict[str, Callable] = {}
        self._tool_definitions: Dict[str, Dict[str, Any]] = {}

        def _has_variable_placeholder(s):
            return bool(
                list(string.Formatter().parse(s))
                and any(
                    field for _, field, _, _ in string.Formatter().parse(s) if field
                )
            )

        def _extract_variable_names(s):
            return list(
                set([field for _, field, _, _ in string.Formatter().parse(s) if field])
            )

        # Validate that if system message has variable then input variable should not be empty
        if (
            _has_variable_placeholder(self.system_message)
            if self.system_message
            else False
        ) and not self.input_variables:
            variable_names = _extract_variable_names(self.system_message)
            raise LLMfyException(
                f"System messages have placeholder variables, so the `input variable` should not be empty. "
                f"Missing input variables: {variable_names}. "
            )

        # Validate input variables
        if self.system_message and self.input_variables:
            # Validate that all required input variables are in kwargs
            variable_names = _extract_variable_names(self.system_message)
            missing_vars = [
                var for var in variable_names if var not in self.input_variables
            ]
            if missing_vars:
                raise LLMfyException(
                    f"Missing required input variables: {missing_vars}. "
                    f"Expected variables: {variable_names}."
                )

    def register_tool(self, funcs: List[Callable]) -> None:
        """Register a tool with this framework instance."""
        for func in funcs:
            if not hasattr(func, "_is_tool"):
                raise LLMfyException("Function must be decorated with @Tool")

            tool_def = Tool._get_tool_definition(func, self.model.provider)
            self._tools[func.__name__] = func
            self._tool_definitions[func.__name__] = tool_def

    def __get_tool_definitions(self) -> List[Dict[str, Any]]:
        """Get all tool definitions registered with this framework."""
        return list(self._tool_definitions.values())

    def __execute_tool(self, name: str, arguments: Dict[str, Any]) -> Any:
        """Execute a registered tool."""
        if name not in self._tools:
            raise LLMfyException(f"Tool not found: {name}")
        return self._tools[name](**arguments)

    def __validate_system_message(self, **kwargs) -> str | None:
        # If we have a system message and input variables
        try:
            final_system_message = self.system_message if self.system_message else ""
            if self.system_message and self.input_variables:
                # Validate that all required input variables are in kwargs
                missing_vars = [
                    var for var in self.input_variables if var not in kwargs
                ]
                if missing_vars:
                    raise LLMfyException(
                        f"Missing required input variables: {missing_vars}. "
                        f"Expected variables: {self.input_variables}, "
                        f"Received variables: {list(kwargs.keys())}"
                    )

                # Create a dictionary of variables from kwargs that match input_variables
                format_variables = {
                    var: kwargs.get(var)
                    for var in self.input_variables
                    if var in kwargs
                }

                # Update the system message with the variables
                final_system_message = self.system_message.format(**format_variables)

            return final_system_message
        except KeyError as e:
            raise LLMfyException(f"Required variable {e} not found in kwargs")
        except Exception as e:
            raise LLMfyException(f"Error formatting system message: {str(e)}")

    def invoke(self, contents: str | List[Content], **kwargs) -> GenerationResponse:
        """
        Generate a response based on contents.

        Args:
            contents (str | List[Content]): Text or List of content objects to process
            **kwargs: Additional generation parameters

        Returns:
            GenerationResponse containing the generated response
        """
        try:
            self.messages_temp.clear()

            # Generate using user role only if invoke
            messages = [Message(role=Role.USER, content=contents)]

            if self.system_message:
                # Validate system message
                final_system_message = self.__validate_system_message(**kwargs)

                # Add system message to history
                self.messages_temp.add_system_message(
                    final_system_message if final_system_message else ""
                )

            # Add new messages to history
            for message in messages:
                # always ROLE == USER because invoke
                if message.role == Role.USER:
                    self.messages_temp.add_user_message(
                        message.id,
                        message.content if message.content else "",
                    )

            response = self.model.generate(
                self.messages_temp.get_messages(provider=self.model.provider),
                tools=self.__get_tool_definitions(),
            )

            self.messages_temp.add_assistant_message(
                id=str(uuid.uuid4()),
                content=response.content,
                tool_calls=response.tool_calls,
            )

            return GenerationResponse(
                result=response,
                messages=self.messages_temp.get_instance_messages(),
            )
        except Exception as e:
            raise LLMfyException(e)

    def invoke_with_tools(
        self,
        contents: str | List[Content],
        **kwargs,
    ) -> GenerationResponse:
        """
        Generate a response based on contents with tools results.

        Args:
            contents (str | List[Content]): Text or List of content objects to process
            **kwargs: Additional generation parameters

        Returns:
            GenerationResponse containing the generated response
        """
        try:
            self.messages_temp.clear()

            # Generate using user role only if invoke
            messages = [Message(role=Role.USER, content=contents)]

            if self.system_message:
                # Validate system message
                final_system_message = self.__validate_system_message(**kwargs)

                # Add system message to history
                self.messages_temp.add_system_message(
                    final_system_message if final_system_message else ""
                )

            # Add new messages to history
            for message in messages:
                # always ROLE == USER because invoke
                if message.role == Role.USER:
                    self.messages_temp.add_user_message(
                        message.id,
                        message.content if message.content else "",
                    )

            while True:
                response = self.model.generate(
                    self.messages_temp.get_messages(provider=self.model.provider),
                    tools=self.__get_tool_definitions(),
                )

                if response.tool_calls:
                    self.messages_temp.add_assistant_message(
                        id=str(uuid.uuid4()),
                        tool_calls=response.tool_calls,
                    )

                    for tool_call in response.tool_calls:
                        result = self.__execute_tool(
                            tool_call.name, tool_call.arguments
                        )
                        self.messages_temp.add_tool_message(
                            id=str(uuid.uuid4()),
                            request_call_id=tool_call.request_call_id,
                            tool_call_id=tool_call.tool_call_id,
                            name=tool_call.name,
                            result=str(result),
                            provider=self.model.provider,
                        )
                    continue

                self.messages_temp.add_assistant_message(
                    id=str(uuid.uuid4()),
                    content=response.content,
                    tool_calls=response.tool_calls,
                )

                return GenerationResponse(
                    result=response,
                    messages=self.messages_temp.get_instance_messages(),
                )
        except Exception as e:
            raise LLMfyException(e)

    def chat(self, messages: List[Message], **kwargs) -> GenerationResponse:
        """
        Generate a response based on a list of messages.

        Args:
            messages (List[Message]): List of Message objects to process
            **kwargs: Additional generation parameters

        Returns:
            GenerationResponse containing the generated response
        """
        try:
            self.messages_temp.clear()

            if self.system_message:
                # Validate system message
                final_system_message = self.__validate_system_message(**kwargs)

                # Add system message to history
                self.messages_temp.add_system_message(
                    final_system_message if final_system_message else ""
                )

            # Add new messages to history
            for message in messages:
                if message.role == Role.USER:
                    self.messages_temp.add_user_message(
                        message.id,
                        message.content if message.content else "",
                    )
                elif message.role == Role.ASSISTANT:
                    self.messages_temp.add_assistant_message(
                        id=message.id,
                        content=message.content,
                        tool_calls=message.tool_calls,
                    )
                elif message.role == Role.TOOL:
                    self.messages_temp.add_tool_message(
                        id=message.id,
                        request_call_id=message.request_call_id,
                        tool_call_id=(
                            message.tool_call_id if message.tool_call_id else ""
                        ),
                        name=message.name if message.name else "",
                        result=message.tool_results[0] if message.tool_results else "",
                        provider=self.model.provider,
                    )

            response = self.model.generate(
                self.messages_temp.get_messages(provider=self.model.provider),
                tools=self.__get_tool_definitions(),
            )

            self.messages_temp.add_assistant_message(
                id=str(uuid.uuid4()),
                content=response.content,
                tool_calls=response.tool_calls,
            )

            return GenerationResponse(
                result=response,
                messages=self.messages_temp.get_instance_messages(),
            )
        except Exception as e:
            raise LLMfyException(e)

    def chat_with_tools(self, messages: List[Message], **kwargs) -> GenerationResponse:
        """
        Generate a response based on a list of messages with tools results.

        Args:
            messages (List[Message]): List of Message objects to process
            **kwargs: Additional generation parameters

        Returns:
            GenerationResponse containing the generated response
        """
        try:
            self.messages_temp.clear()

            if self.system_message:
                # Validate system message
                final_system_message = self.__validate_system_message(**kwargs)

                # Add system message to history
                self.messages_temp.add_system_message(
                    final_system_message if final_system_message else ""
                )

            # Add new messages to history
            for message in messages:
                if message.role == Role.USER:
                    self.messages_temp.add_user_message(
                        message.id,
                        message.content if message.content else "",
                    )
                elif message.role == Role.ASSISTANT:
                    self.messages_temp.add_assistant_message(
                        id=message.id,
                        content=message.content,
                        tool_calls=message.tool_calls,
                    )
                elif message.role == Role.TOOL:
                    self.messages_temp.add_tool_message(
                        id=message.id,
                        request_call_id=message.request_call_id,
                        tool_call_id=(
                            message.tool_call_id if message.tool_call_id else ""
                        ),
                        name=message.name if message.name else "",
                        result=message.tool_results[0] if message.tool_results else "",
                        provider=self.model.provider,
                    )

            while True:
                response = self.model.generate(
                    self.messages_temp.get_messages(provider=self.model.provider),
                    tools=self.__get_tool_definitions(),
                )

                if response.tool_calls:
                    self.messages_temp.add_assistant_message(
                        id=str(uuid.uuid4()),
                        tool_calls=response.tool_calls,
                    )

                    for tool_call in response.tool_calls:
                        result = self.__execute_tool(
                            tool_call.name, tool_call.arguments
                        )
                        self.messages_temp.add_tool_message(
                            id=str(uuid.uuid4()),
                            request_call_id=tool_call.request_call_id,
                            tool_call_id=tool_call.tool_call_id,
                            name=tool_call.name,
                            result=str(result),
                            provider=self.model.provider,
                        )
                    continue

                self.messages_temp.add_assistant_message(
                    id=str(uuid.uuid4()),
                    content=response.content,
                    tool_calls=response.tool_calls,
                )

                return GenerationResponse(
                    result=response,
                    messages=self.messages_temp.get_instance_messages(),
                )
        except Exception as e:
            raise LLMfyException(e)

    def chat_stream(self, messages: List[Message], **kwargs) -> Any:
        """
        Generate a streaming response based on a list of messages.

        Args:
            messages (List[Message]): List of Message objects to process
            **kwargs: Additional generation parameters

        Returns:
            Streaming response from the model
        """
        try:
            self.messages_temp.clear()

            if self.system_message:
                # Validate system message
                final_system_message = self.__validate_system_message(**kwargs)

                # Add system message to history
                self.messages_temp.add_system_message(
                    final_system_message if final_system_message else ""
                )

            # Add new messages to history
            for message in messages:
                if message.role == Role.USER:
                    self.messages_temp.add_user_message(
                        message.id,
                        message.content if message.content else "",
                    )
                elif message.role == Role.ASSISTANT:
                    self.messages_temp.add_assistant_message(
                        id=message.id,
                        content=message.content,
                        tool_calls=message.tool_calls,
                    )
                elif message.role == Role.TOOL:
                    self.messages_temp.add_tool_message(
                        id=message.id,
                        request_call_id=message.request_call_id,
                        tool_call_id=(
                            message.tool_call_id if message.tool_call_id else ""
                        ),
                        name=message.name if message.name else "",
                        result=message.tool_results[0] if message.tool_results else "",
                        provider=self.model.provider,
                    )

            stream = self.model.generate_stream(
                self.messages_temp.get_messages(provider=self.model.provider),
                tools=self.__get_tool_definitions(),
            )

            full_content = ""
            tool_calls = None

            for chunk in stream:
                if isinstance(chunk, AIResponse):
                    content = ""
                    tool_calls = []
                    # Yield each chunk
                    if chunk.content:
                        content = chunk.content
                        full_content += content

                    if chunk.tool_calls:
                        tool_calls = chunk.tool_calls

                    # update content and toolcalls only
                    yield GenerationResponse(
                        result=AIResponse(content=content, tool_calls=tool_calls),
                        messages=[],
                    )

            self.messages_temp.add_assistant_message(
                id=str(uuid.uuid4()),
                content=full_content,
                tool_calls=tool_calls,
            )

            # update messages only
            yield GenerationResponse(
                result=AIResponse(),
                messages=self.messages_temp.get_instance_messages(),
            )
        except Exception as e:
            raise LLMfyException(e)

    def clear_messages_temp(self) -> None:
        self.messages_temp.clear()

__execute_tool(name, arguments)

Execute a registered tool.

Source code in llmfy/llmfy_core/llmfy.py
def __execute_tool(self, name: str, arguments: Dict[str, Any]) -> Any:
    """Execute a registered tool."""
    if name not in self._tools:
        raise LLMfyException(f"Tool not found: {name}")
    return self._tools[name](**arguments)

__get_tool_definitions()

Get all tool definitions registered with this framework.

Source code in llmfy/llmfy_core/llmfy.py
def __get_tool_definitions(self) -> List[Dict[str, Any]]:
    """Get all tool definitions registered with this framework."""
    return list(self._tool_definitions.values())

chat(messages, **kwargs)

Generate a response based on a list of messages.

Parameters:

Name Type Description Default
messages List[Message]

List of Message objects to process

required
**kwargs

Additional generation parameters

{}

Returns:

Type Description
GenerationResponse

GenerationResponse containing the generated response

Source code in llmfy/llmfy_core/llmfy.py
def chat(self, messages: List[Message], **kwargs) -> GenerationResponse:
    """
    Generate a response based on a list of messages.

    Args:
        messages (List[Message]): List of Message objects to process
        **kwargs: Additional generation parameters

    Returns:
        GenerationResponse containing the generated response
    """
    try:
        self.messages_temp.clear()

        if self.system_message:
            # Validate system message
            final_system_message = self.__validate_system_message(**kwargs)

            # Add system message to history
            self.messages_temp.add_system_message(
                final_system_message if final_system_message else ""
            )

        # Add new messages to history
        for message in messages:
            if message.role == Role.USER:
                self.messages_temp.add_user_message(
                    message.id,
                    message.content if message.content else "",
                )
            elif message.role == Role.ASSISTANT:
                self.messages_temp.add_assistant_message(
                    id=message.id,
                    content=message.content,
                    tool_calls=message.tool_calls,
                )
            elif message.role == Role.TOOL:
                self.messages_temp.add_tool_message(
                    id=message.id,
                    request_call_id=message.request_call_id,
                    tool_call_id=(
                        message.tool_call_id if message.tool_call_id else ""
                    ),
                    name=message.name if message.name else "",
                    result=message.tool_results[0] if message.tool_results else "",
                    provider=self.model.provider,
                )

        response = self.model.generate(
            self.messages_temp.get_messages(provider=self.model.provider),
            tools=self.__get_tool_definitions(),
        )

        self.messages_temp.add_assistant_message(
            id=str(uuid.uuid4()),
            content=response.content,
            tool_calls=response.tool_calls,
        )

        return GenerationResponse(
            result=response,
            messages=self.messages_temp.get_instance_messages(),
        )
    except Exception as e:
        raise LLMfyException(e)

chat_stream(messages, **kwargs)

Generate a streaming response based on a list of messages.

Parameters:

Name Type Description Default
messages List[Message]

List of Message objects to process

required
**kwargs

Additional generation parameters

{}

Returns:

Type Description
Any

Streaming response from the model

Source code in llmfy/llmfy_core/llmfy.py
def chat_stream(self, messages: List[Message], **kwargs) -> Any:
    """
    Generate a streaming response based on a list of messages.

    Args:
        messages (List[Message]): List of Message objects to process
        **kwargs: Additional generation parameters

    Returns:
        Streaming response from the model
    """
    try:
        self.messages_temp.clear()

        if self.system_message:
            # Validate system message
            final_system_message = self.__validate_system_message(**kwargs)

            # Add system message to history
            self.messages_temp.add_system_message(
                final_system_message if final_system_message else ""
            )

        # Add new messages to history
        for message in messages:
            if message.role == Role.USER:
                self.messages_temp.add_user_message(
                    message.id,
                    message.content if message.content else "",
                )
            elif message.role == Role.ASSISTANT:
                self.messages_temp.add_assistant_message(
                    id=message.id,
                    content=message.content,
                    tool_calls=message.tool_calls,
                )
            elif message.role == Role.TOOL:
                self.messages_temp.add_tool_message(
                    id=message.id,
                    request_call_id=message.request_call_id,
                    tool_call_id=(
                        message.tool_call_id if message.tool_call_id else ""
                    ),
                    name=message.name if message.name else "",
                    result=message.tool_results[0] if message.tool_results else "",
                    provider=self.model.provider,
                )

        stream = self.model.generate_stream(
            self.messages_temp.get_messages(provider=self.model.provider),
            tools=self.__get_tool_definitions(),
        )

        full_content = ""
        tool_calls = None

        for chunk in stream:
            if isinstance(chunk, AIResponse):
                content = ""
                tool_calls = []
                # Yield each chunk
                if chunk.content:
                    content = chunk.content
                    full_content += content

                if chunk.tool_calls:
                    tool_calls = chunk.tool_calls

                # update content and toolcalls only
                yield GenerationResponse(
                    result=AIResponse(content=content, tool_calls=tool_calls),
                    messages=[],
                )

        self.messages_temp.add_assistant_message(
            id=str(uuid.uuid4()),
            content=full_content,
            tool_calls=tool_calls,
        )

        # update messages only
        yield GenerationResponse(
            result=AIResponse(),
            messages=self.messages_temp.get_instance_messages(),
        )
    except Exception as e:
        raise LLMfyException(e)

chat_with_tools(messages, **kwargs)

Generate a response based on a list of messages with tools results.

Parameters:

Name Type Description Default
messages List[Message]

List of Message objects to process

required
**kwargs

Additional generation parameters

{}

Returns:

Type Description
GenerationResponse

GenerationResponse containing the generated response

Source code in llmfy/llmfy_core/llmfy.py
def chat_with_tools(self, messages: List[Message], **kwargs) -> GenerationResponse:
    """
    Generate a response based on a list of messages with tools results.

    Args:
        messages (List[Message]): List of Message objects to process
        **kwargs: Additional generation parameters

    Returns:
        GenerationResponse containing the generated response
    """
    try:
        self.messages_temp.clear()

        if self.system_message:
            # Validate system message
            final_system_message = self.__validate_system_message(**kwargs)

            # Add system message to history
            self.messages_temp.add_system_message(
                final_system_message if final_system_message else ""
            )

        # Add new messages to history
        for message in messages:
            if message.role == Role.USER:
                self.messages_temp.add_user_message(
                    message.id,
                    message.content if message.content else "",
                )
            elif message.role == Role.ASSISTANT:
                self.messages_temp.add_assistant_message(
                    id=message.id,
                    content=message.content,
                    tool_calls=message.tool_calls,
                )
            elif message.role == Role.TOOL:
                self.messages_temp.add_tool_message(
                    id=message.id,
                    request_call_id=message.request_call_id,
                    tool_call_id=(
                        message.tool_call_id if message.tool_call_id else ""
                    ),
                    name=message.name if message.name else "",
                    result=message.tool_results[0] if message.tool_results else "",
                    provider=self.model.provider,
                )

        while True:
            response = self.model.generate(
                self.messages_temp.get_messages(provider=self.model.provider),
                tools=self.__get_tool_definitions(),
            )

            if response.tool_calls:
                self.messages_temp.add_assistant_message(
                    id=str(uuid.uuid4()),
                    tool_calls=response.tool_calls,
                )

                for tool_call in response.tool_calls:
                    result = self.__execute_tool(
                        tool_call.name, tool_call.arguments
                    )
                    self.messages_temp.add_tool_message(
                        id=str(uuid.uuid4()),
                        request_call_id=tool_call.request_call_id,
                        tool_call_id=tool_call.tool_call_id,
                        name=tool_call.name,
                        result=str(result),
                        provider=self.model.provider,
                    )
                continue

            self.messages_temp.add_assistant_message(
                id=str(uuid.uuid4()),
                content=response.content,
                tool_calls=response.tool_calls,
            )

            return GenerationResponse(
                result=response,
                messages=self.messages_temp.get_instance_messages(),
            )
    except Exception as e:
        raise LLMfyException(e)

invoke(contents, **kwargs)

Generate a response based on contents.

Parameters:

Name Type Description Default
contents str | List[Content]

Text or List of content objects to process

required
**kwargs

Additional generation parameters

{}

Returns:

Type Description
GenerationResponse

GenerationResponse containing the generated response

Source code in llmfy/llmfy_core/llmfy.py
def invoke(self, contents: str | List[Content], **kwargs) -> GenerationResponse:
    """
    Generate a response based on contents.

    Args:
        contents (str | List[Content]): Text or List of content objects to process
        **kwargs: Additional generation parameters

    Returns:
        GenerationResponse containing the generated response
    """
    try:
        self.messages_temp.clear()

        # Generate using user role only if invoke
        messages = [Message(role=Role.USER, content=contents)]

        if self.system_message:
            # Validate system message
            final_system_message = self.__validate_system_message(**kwargs)

            # Add system message to history
            self.messages_temp.add_system_message(
                final_system_message if final_system_message else ""
            )

        # Add new messages to history
        for message in messages:
            # always ROLE == USER because invoke
            if message.role == Role.USER:
                self.messages_temp.add_user_message(
                    message.id,
                    message.content if message.content else "",
                )

        response = self.model.generate(
            self.messages_temp.get_messages(provider=self.model.provider),
            tools=self.__get_tool_definitions(),
        )

        self.messages_temp.add_assistant_message(
            id=str(uuid.uuid4()),
            content=response.content,
            tool_calls=response.tool_calls,
        )

        return GenerationResponse(
            result=response,
            messages=self.messages_temp.get_instance_messages(),
        )
    except Exception as e:
        raise LLMfyException(e)

invoke_with_tools(contents, **kwargs)

Generate a response based on contents with tools results.

Parameters:

Name Type Description Default
contents str | List[Content]

Text or List of content objects to process

required
**kwargs

Additional generation parameters

{}

Returns:

Type Description
GenerationResponse

GenerationResponse containing the generated response

Source code in llmfy/llmfy_core/llmfy.py
def invoke_with_tools(
    self,
    contents: str | List[Content],
    **kwargs,
) -> GenerationResponse:
    """
    Generate a response based on contents with tools results.

    Args:
        contents (str | List[Content]): Text or List of content objects to process
        **kwargs: Additional generation parameters

    Returns:
        GenerationResponse containing the generated response
    """
    try:
        self.messages_temp.clear()

        # Generate using user role only if invoke
        messages = [Message(role=Role.USER, content=contents)]

        if self.system_message:
            # Validate system message
            final_system_message = self.__validate_system_message(**kwargs)

            # Add system message to history
            self.messages_temp.add_system_message(
                final_system_message if final_system_message else ""
            )

        # Add new messages to history
        for message in messages:
            # always ROLE == USER because invoke
            if message.role == Role.USER:
                self.messages_temp.add_user_message(
                    message.id,
                    message.content if message.content else "",
                )

        while True:
            response = self.model.generate(
                self.messages_temp.get_messages(provider=self.model.provider),
                tools=self.__get_tool_definitions(),
            )

            if response.tool_calls:
                self.messages_temp.add_assistant_message(
                    id=str(uuid.uuid4()),
                    tool_calls=response.tool_calls,
                )

                for tool_call in response.tool_calls:
                    result = self.__execute_tool(
                        tool_call.name, tool_call.arguments
                    )
                    self.messages_temp.add_tool_message(
                        id=str(uuid.uuid4()),
                        request_call_id=tool_call.request_call_id,
                        tool_call_id=tool_call.tool_call_id,
                        name=tool_call.name,
                        result=str(result),
                        provider=self.model.provider,
                    )
                continue

            self.messages_temp.add_assistant_message(
                id=str(uuid.uuid4()),
                content=response.content,
                tool_calls=response.tool_calls,
            )

            return GenerationResponse(
                result=response,
                messages=self.messages_temp.get_instance_messages(),
            )
    except Exception as e:
        raise LLMfyException(e)

register_tool(funcs)

Register a tool with this framework instance.

Source code in llmfy/llmfy_core/llmfy.py
def register_tool(self, funcs: List[Callable]) -> None:
    """Register a tool with this framework instance."""
    for func in funcs:
        if not hasattr(func, "_is_tool"):
            raise LLMfyException("Function must be decorated with @Tool")

        tool_def = Tool._get_tool_definition(func, self.model.provider)
        self._tools[func.__name__] = func
        self._tool_definitions[func.__name__] = tool_def