mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 02:19:06 +00:00
Evan MattsonandEvan Mattson
7268d13ee8
### Motivation and Context Solves #4864 The KernelFunction was configured as a Python class without regards to using Pydantic fields and its validations. As an aside, while running a kernel example related to function/tool calling, it didn't succeed. <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> ### Description This PR cleans up the KernelFunction by creating Pydantic fields. We're also able to remove the KernelFunctionBase as it didn't contain a lot of logic after removing the properties. While testing other code, I found that the tool call kernel example wasn't succeeding. The tool_call payload needed a small reformat, and we needed to handle the tool_call_id and correctly handle the ToolCall object. As further work towards v1, we should look at removing support for FunctionCall as it is deprecated in Azure OpenAI. We now see: ``` User:> What is 3+3? Mosscap:> Ah, the timeless question of arithmetic! The sum of 3 and 3 is undoubtedly a splendid number. By utilizing my mathematical prowess, I can confidently declare that 3 plus 3 equals 6. It is a harmonious union of two threes, joining forces to create a new entity, greater in magnitude. The addition of these two numbers results in a perfect balance, a symphony of numerical harmony. ``` <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [X] The code builds clean without any errors or warnings - [X] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [X] All unit tests pass, and I have added new tests where possible - [X] I didn't break anyone 😄 --------- Co-authored-by: Evan Mattson <[email protected]>
196 lines
5.5 KiB
Python
196 lines
5.5 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
from unittest.mock import AsyncMock, Mock
|
|
|
|
import pytest
|
|
|
|
from semantic_kernel import Kernel
|
|
from semantic_kernel.orchestration.kernel_function import KernelFunction
|
|
from semantic_kernel.plugin_definition.function_view import FunctionView
|
|
from semantic_kernel.plugin_definition.kernel_plugin import KernelPlugin
|
|
|
|
|
|
def create_mock_function(name) -> KernelFunction:
|
|
function_view = FunctionView(name, "SummarizePlugin", "Summarize an input", [], True, True)
|
|
mock_function = Mock(spec=KernelFunction)
|
|
mock_function.describe.return_value = function_view
|
|
mock_function.name = function_view.name
|
|
mock_function.plugin_name = function_view.plugin_name
|
|
mock_function.description = function_view.description
|
|
|
|
return mock_function
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
@pytest.mark.parametrize("pipeline_count", [1, 2])
|
|
async def test_run_async_handles_pre_invocation(pipeline_count):
|
|
# Arrange
|
|
kernel = Kernel()
|
|
|
|
mock_function = create_mock_function("test_function")
|
|
mock_function.invoke = AsyncMock(side_effect=lambda input, context: context)
|
|
kernel.plugins.add(KernelPlugin(name="test", functions=[mock_function]))
|
|
|
|
invoked = 0
|
|
|
|
def invoking_handler(sender, e):
|
|
nonlocal invoked
|
|
invoked += 1
|
|
|
|
kernel.add_function_invoking_handler(invoking_handler)
|
|
functions = [mock_function] * pipeline_count
|
|
|
|
# Act
|
|
_ = await kernel.run(*functions)
|
|
|
|
# Assert
|
|
assert invoked == pipeline_count
|
|
assert mock_function.invoke.call_count == pipeline_count
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_run_async_pre_invocation_skip_dont_trigger_invoked_handler():
|
|
# Arrange
|
|
kernel = Kernel()
|
|
|
|
mock_function1 = create_mock_function(name="SkipMe")
|
|
mock_function1.invoke = AsyncMock(side_effect=lambda input, context: context)
|
|
mock_function2 = create_mock_function(name="DontSkipMe")
|
|
mock_function2.invoke = AsyncMock(side_effect=lambda input, context: context)
|
|
invoked = 0
|
|
invoking = 0
|
|
invoked_function_name = ""
|
|
|
|
def invoking_handler(sender, e):
|
|
nonlocal invoking
|
|
invoking += 1
|
|
if e.function_view.name == "SkipMe":
|
|
e.skip()
|
|
|
|
def invoked_handler(sender, e):
|
|
nonlocal invoked_function_name, invoked
|
|
invoked_function_name = e.function_view.name
|
|
invoked += 1
|
|
|
|
kernel.add_function_invoking_handler(invoking_handler)
|
|
kernel.add_function_invoked_handler(invoked_handler)
|
|
|
|
# Act
|
|
_ = await kernel.run(mock_function1, mock_function2)
|
|
|
|
# Assert
|
|
assert invoking == 2
|
|
assert invoked == 1
|
|
assert invoked_function_name == "DontSkipMe"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
@pytest.mark.parametrize("pipeline_count", [1, 2])
|
|
async def test_run_async_handles_post_invocation(pipeline_count):
|
|
# Arrange
|
|
kernel = Kernel()
|
|
|
|
mock_function = create_mock_function("test_function")
|
|
mock_function.invoke = AsyncMock(side_effect=lambda input, context: context)
|
|
invoked = 0
|
|
|
|
def invoked_handler(sender, e):
|
|
nonlocal invoked
|
|
invoked += 1
|
|
|
|
kernel.add_function_invoked_handler(invoked_handler)
|
|
functions = [mock_function] * pipeline_count
|
|
|
|
# Act
|
|
_ = await kernel.run(*functions)
|
|
|
|
# Assert
|
|
assert invoked == pipeline_count
|
|
mock_function.invoke.assert_called()
|
|
assert mock_function.invoke.call_count == pipeline_count
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_run_async_post_invocation_repeat_is_working():
|
|
# Arrange
|
|
kernel = Kernel()
|
|
|
|
mock_function = create_mock_function(name="RepeatMe")
|
|
mock_function.invoke = AsyncMock(side_effect=lambda input, context: context)
|
|
|
|
invoked = 0
|
|
repeat_times = 0
|
|
|
|
def invoked_handler(sender, e):
|
|
nonlocal invoked, repeat_times
|
|
invoked += 1
|
|
|
|
if repeat_times < 3:
|
|
e.repeat()
|
|
repeat_times += 1
|
|
|
|
kernel.add_function_invoked_handler(invoked_handler)
|
|
|
|
# Act
|
|
_ = await kernel.run(mock_function)
|
|
|
|
# Assert
|
|
assert invoked == 4
|
|
assert repeat_times == 3
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_run_async_change_variable_invoking_handler():
|
|
# Arrange
|
|
kernel = Kernel()
|
|
|
|
mock_function = create_mock_function("test_function")
|
|
mock_function.invoke = AsyncMock(side_effect=lambda input, context: context)
|
|
|
|
original_input = "Importance"
|
|
new_input = "Problems"
|
|
|
|
def invoking_handler(sender, e):
|
|
e.context.variables.update(new_input)
|
|
e.context.variables["new"] = new_input
|
|
|
|
kernel.add_function_invoking_handler(invoking_handler)
|
|
|
|
# Act
|
|
context = await kernel.run(mock_function, input_str=original_input)
|
|
|
|
# Assert
|
|
assert context.result == new_input
|
|
assert context.variables.input == new_input
|
|
assert context.variables["new"] == new_input
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_run_async_change_variable_invoked_handler():
|
|
# Arrange
|
|
kernel = Kernel()
|
|
|
|
mock_function = create_mock_function("test_function")
|
|
mock_function.invoke = AsyncMock(side_effect=lambda input, context: context)
|
|
|
|
original_input = "Importance"
|
|
new_input = "Problems"
|
|
|
|
def invoked_handler(sender, e):
|
|
e.context.variables.update(new_input)
|
|
e.context.variables["new"] = new_input
|
|
|
|
kernel.add_function_invoked_handler(invoked_handler)
|
|
|
|
# Act
|
|
context = await kernel.run(mock_function, input_str=original_input)
|
|
|
|
# Assert
|
|
assert context.result == new_input
|
|
assert context.variables.input == new_input
|
|
assert context.variables["new"] == new_input
|
|
|
|
|
|
if __name__ == "__main__":
|
|
pytest.main(["-s", "-v", __file__])
|