Merge branch 'main' into python-google-user-agent

Author: markmcd

python/pyproject.toml

@@ -28,7 +28,7 @@ dependencies = [
     "azure-ai-agents >= 1.2.0b3",
     "aiohttp ~= 3.8",
     "cloudevents ~=1.0",
-    "pydantic >=2.0,!=2.10.0,!=2.10.1,!=2.10.2,!=2.10.3,<2.12",
+    "pydantic >=2.0,!=2.10.0,!=2.10.1,!=2.10.2,!=2.10.3,<2.13",
     "pydantic-settings ~= 2.0",
     "defusedxml ~= 0.7",
     # azure identity
@@ -77,7 +77,7 @@ azure = [
     "azure-cosmos ~= 4.7"
 ]
 chroma = [
-    "chromadb >= 0.5,< 1.1"
+    "chromadb >= 0.5,< 1.4"
 ]
 copilotstudio = [
     "microsoft-agents-copilotstudio-client >= 0.3.1",
@@ -106,11 +106,11 @@ mistralai = [
     "mistralai >= 1.2,< 2.0"
 ]
 mongo = [
-    "pymongo >= 4.8.0, < 4.15",
+    "pymongo >= 4.8.0, < 4.16",
     "motor >= 3.3.2,< 3.8.0"
 ]
 notebooks = [
-    "ipykernel ~= 6.29"
+    "ipykernel >= 6.29,< 8.0"
 ]
 ollama = [
     "ollama ~= 0.4"
@@ -136,7 +136,7 @@ qdrant = [
     "qdrant-client ~= 1.9"
 ]
 redis = [
-    "redis[hiredis] ~= 6.0",
+    "redis[hiredis] >= 6,< 8",
     "types-redis ~= 4.6.0.20240425",
     "redisvl ~= 0.4"
 ]
@@ -158,7 +158,7 @@ weaviate = [
 [dependency-groups]
 dev = [
     "pre-commit ~= 3.7",
-    "ipykernel ~= 6.29",
+    "ipykernel >= 6.29,< 8.0",
     "nbconvert ~= 7.16",
     "pytest ~= 8.2",
     "pytest-xdist[psutil] ~= 3.6",

python/samples/concepts/prompt_templates/azure_chat_gpt_api_handlebars.py

@@ -39,7 +39,7 @@
 chat_function = kernel.add_function(
     prompt_template_config=PromptTemplateConfig(
         template="""{{system_message}}{{#each chat_history}}
-        {{#message role=role}}{{~content~}}{{/message}} {{/each}}""",
+        {{message_to_prompt}} {{/each}}""",
         template_format="handlebars",
         allow_dangerously_set_content=True,
     ),

python/samples/concepts/prompt_templates/azure_chat_gpt_api_jinja2.py

@@ -38,7 +38,7 @@
 
 chat_function = kernel.add_function(
     prompt_template_config=PromptTemplateConfig(
-        template="""{{system_message}}{% for item in chat_history %}{{ message(item) }}{% endfor %}""",
+        template="""{{system_message}}{% for item in chat_history %}{{ message_to_prompt(item) }}{% endfor %}""",
         template_format="jinja2",
         allow_dangerously_set_content=True,
     ),

python/semantic_kernel/agents/open_ai/responses_agent_thread_actions.py

@@ -1214,10 +1214,19 @@ def _get_tools(
         if agent.tools:
             tools.extend(agent.tools)
 
-        # TODO(evmattso): make sure to respect filters on FCB
-        if kernel.plugins:
-            funcs = kernel.get_full_list_of_function_metadata()
-            tools.extend([kernel_function_metadata_to_response_function_call_format(f) for f in funcs])
+        if not function_choice_behavior.enable_kernel_functions:
+            return tools
+
+        if not kernel.plugins:
+            return tools
+
+        funcs = (
+            kernel.get_list_of_function_metadata(function_choice_behavior.filters)
+            if function_choice_behavior.filters
+            else kernel.get_full_list_of_function_metadata()
+        )
+
+        tools.extend([kernel_function_metadata_to_response_function_call_format(f) for f in funcs])
 
         return tools
 

python/semantic_kernel/prompt_template/utils/handlebars_system_helpers.py

@@ -5,6 +5,7 @@
 import re
 from collections.abc import Callable
 from enum import Enum
+from xml.etree.ElementTree import Element, SubElement, tostring  # nosec B405
 
 logger: logging.Logger = logging.getLogger(__name__)
 
@@ -26,23 +27,32 @@ def _message_to_prompt(this, *args, **kwargs):
 
 
 def _message(this, options, *args, **kwargs):
+    from semantic_kernel.contents.chat_message_content import ChatMessageContent
     from semantic_kernel.contents.const import CHAT_MESSAGE_CONTENT_TAG
 
-    # everything in kwargs, goes to <ROOT_KEY_MESSAGE kwargs_key="kwargs_value">
-    # everything in options, goes in between <ROOT_KEY_MESSAGE>options</ROOT_KEY_MESSAGE>
-    start = f"<{CHAT_MESSAGE_CONTENT_TAG}"
+    # When the context is a ChatMessageContent, delegate to to_element() so that
+    # the XML contract is consistent with the Jinja2 path.
+    if isinstance(this.context, ChatMessageContent):
+        message = this.context.to_element()
+        return tostring(message, encoding="unicode", short_empty_elements=False)
+
+    # Fallback: build the element manually from kwargs and block content.
+    from semantic_kernel.contents.const import TEXT_CONTENT_TAG
+
+    message = Element(CHAT_MESSAGE_CONTENT_TAG)
     for key, value in kwargs.items():
         if isinstance(value, Enum):
             value = value.value
         if value is not None:
-            start += f' {key}="{value}"'
-    start += ">"
-    end = f"</{CHAT_MESSAGE_CONTENT_TAG}>"
+            message.set(key, str(value))
     try:
-        content = options["fn"](this)
+        content = str(options["fn"](this))
     except Exception:  # pragma: no cover
         content = ""
-    return f"{start}{content}{end}"
+    if content:
+        text_elem = SubElement(message, TEXT_CONTENT_TAG)
+        text_elem.text = content
+    return tostring(message, encoding="unicode", short_empty_elements=False)
 
 
 def _set(this, *args, **kwargs):

python/semantic_kernel/prompt_template/utils/jinja2_system_helpers.py

@@ -3,7 +3,7 @@
 import logging
 import re
 from collections.abc import Callable
-from enum import Enum
+from xml.etree.ElementTree import tostring  # nosec B405
 
 logger: logging.Logger = logging.getLogger(__name__)
 
@@ -25,17 +25,8 @@ def _message_to_prompt(context):
 
 
 def _message(item):
-    from semantic_kernel.contents.const import CHAT_MESSAGE_CONTENT_TAG
-
-    start = f"<{CHAT_MESSAGE_CONTENT_TAG}"
-    role = item.role
-    content = item.content
-    if isinstance(role, Enum):
-        role = role.value
-    start += f' role="{role}"'
-    start += ">"
-    end = f"</{CHAT_MESSAGE_CONTENT_TAG}>"
-    return f"{start}{content}{end}"
+    message = item.to_element()
+    return tostring(message, encoding="unicode", short_empty_elements=False)
 
 
 # Wrap the _get function to safely handle calls without arguments

python/tests/unit/agents/openai_responses/test_openai_responses_thread_actions.py

@@ -15,6 +15,7 @@
 
 from semantic_kernel.agents.open_ai.openai_responses_agent import OpenAIResponsesAgent
 from semantic_kernel.agents.open_ai.responses_agent_thread_actions import ResponsesAgentThreadActions
+from semantic_kernel.connectors.ai.function_choice_behavior import FunctionChoiceBehavior
 from semantic_kernel.contents.chat_message_content import ChatMessageContent
 from semantic_kernel.contents.streaming_chat_message_content import StreamingChatMessageContent
 from semantic_kernel.contents.streaming_text_content import StreamingTextContent
@@ -499,11 +500,11 @@ async def mock_invoke_function_call(*args, **kwargs):
 
 def test_get_tools(mock_agent, kernel, custom_plugin_class):
     kernel.add_plugin(custom_plugin_class)
-
+    fcb = FunctionChoiceBehavior()
     tools = ResponsesAgentThreadActions._get_tools(
         agent=mock_agent,
         kernel=kernel,
-        function_choice_behavior=MagicMock(),
+        function_choice_behavior=fcb,
     )
 
     assert len(tools) == len(mock_agent.tools) + len(kernel.get_full_list_of_function_metadata())

python/tests/unit/prompt_template/test_handlebars_prompt_template.py

@@ -261,6 +261,108 @@ async def test_helpers_message(kernel: Kernel):
     assert "Assistant message" in rendered
 
 
+async def test_helpers_message_escapes_xml_metacharacters(kernel: Kernel):
+    template = """
+{{#each chat_history}}
+    {{#message role=role}}
+    {{~content~}}
+    {{/message}}
+{{/each}}
+"""
+    target = create_handlebars_prompt_template(template, allow_dangerously_set_content=True)
+    chat_history = ChatHistory()
+    chat_history.add_user_message('What does a < b & a > c & "d" mean?')
+
+    rendered = await target.render(kernel, KernelArguments(chat_history=chat_history))
+
+    assert "&lt;" in rendered
+    assert "&amp;" in rendered
+    # ElementTree does not escape > in text content (valid XML); verify round-trip works regardless.
+    assert "a > c" in rendered or "a &gt; c" in rendered
+    assert '"d"' in rendered
+    assert ChatHistory.from_rendered_prompt(rendered) == chat_history
+
+
+async def test_helpers_message_uses_text_element(kernel: Kernel):
+    """Verify handlebars {{#message}} wraps content in <text> like the Jinja2 path."""
+    template = """
+{{#each chat_history}}
+    {{#message role=role}}
+    {{~content~}}
+    {{/message}}
+{{/each}}
+"""
+    target = create_handlebars_prompt_template(template, allow_dangerously_set_content=True)
+    chat_history = ChatHistory()
+    chat_history.add_user_message("User message")
+    chat_history.add_assistant_message("Assistant message")
+    rendered = await target.render(kernel, KernelArguments(chat_history=chat_history))
+    assert '<message role="user"><text>User message</text></message>' in rendered
+    assert '<message role="assistant"><text>Assistant message</text></message>' in rendered
+    chat_history2 = ChatHistory.from_rendered_prompt(rendered)
+    assert chat_history2 == chat_history
+
+
+async def test_helpers_message_empty_content(kernel: Kernel):
+    """Empty message content should produce <message role="..."></message>, not self-closing."""
+    template = """
+{{#each chat_history}}
+    {{#message role=role}}
+    {{~content~}}
+    {{/message}}
+{{/each}}
+"""
+    target = create_handlebars_prompt_template(template, allow_dangerously_set_content=True)
+    chat_history = ChatHistory()
+    chat_history.add_user_message("")
+    rendered = await target.render(kernel, KernelArguments(chat_history=chat_history))
+    assert "<message" in rendered
+    assert "/>" not in rendered
+    assert ChatHistory.from_rendered_prompt(rendered) is not None
+
+
+async def test_helpers_message_fallback_empty_content(kernel: Kernel):
+    """Fallback path (non-ChatMessageContent context) with empty block content.
+
+    Should produce <message role="..."></message>, not self-closing.
+    """
+    template = '{{#message role="user"}}{{/message}}'
+    target = create_handlebars_prompt_template(template, allow_dangerously_set_content=True)
+    rendered = await target.render(kernel, KernelArguments())
+    assert '<message role="user"></message>' in rendered
+    assert "/>" not in rendered
+    assert ChatHistory.from_rendered_prompt(rendered) is not None
+
+
+async def test_helpers_message_fallback_with_content(kernel: Kernel):
+    """Fallback path wraps block content in a <text> child element."""
+    template = '{{#message role="user"}}Hello world{{/message}}'
+    target = create_handlebars_prompt_template(template, allow_dangerously_set_content=True)
+    rendered = await target.render(kernel, KernelArguments())
+    assert '<message role="user"><text>Hello world</text></message>' in rendered
+    chat_history = ChatHistory.from_rendered_prompt(rendered)
+    assert chat_history is not None
+    assert len(chat_history) == 1
+    assert chat_history[0].content == "Hello world"
+
+
+async def test_helpers_message_escapes_greater_than(kernel: Kernel):
+    """ElementTree does not escape > in text; verify round-trip still works."""
+    template = """
+{{#each chat_history}}
+    {{#message role=role}}
+    {{~content~}}
+    {{/message}}
+{{/each}}
+"""
+    target = create_handlebars_prompt_template(template, allow_dangerously_set_content=True)
+    chat_history = ChatHistory()
+    chat_history.add_user_message("Is a > b true?")
+    rendered = await target.render(kernel, KernelArguments(chat_history=chat_history))
+    assert "a > b" in rendered or "a &gt; b" in rendered
+    assert ChatHistory.from_rendered_prompt(rendered) == chat_history
+
+
 async def test_helpers_message_to_prompt(kernel: Kernel):
     template = """{{#each chat_history}}{{message_to_prompt}} {{/each}}"""
     target = create_handlebars_prompt_template(template, allow_dangerously_set_content=True)

python/tests/unit/prompt_template/test_handlebars_prompt_template_e2e.py

@@ -2,6 +2,7 @@
 
 
 from semantic_kernel import Kernel
+from semantic_kernel.contents import AuthorRole
 from semantic_kernel.contents.chat_history import ChatHistory
 from semantic_kernel.functions import kernel_function
 from semantic_kernel.functions.kernel_arguments import KernelArguments
@@ -94,9 +95,46 @@ async def test_chat_history_round_trip(self, kernel: Kernel):
         chat_history.add_user_message("User message")
         chat_history.add_assistant_message("Assistant message")
         rendered = await target.render(kernel, KernelArguments(chat_history=chat_history))
-        assert (
-            rendered.strip()
-            == """<message role="user">User message</message> <message role="assistant">Assistant message</message>"""
+        expected = (
+            '<message role="user"><text>User message</text></message>'
+            ' <message role="assistant"><text>Assistant message</text></message>'
         )
+        assert rendered.strip() == expected
         chat_history2 = ChatHistory.from_rendered_prompt(rendered)
         assert chat_history2 == chat_history
+
+    async def test_chat_history_round_trip_with_xml_metacharacters(self, kernel: Kernel):
+        # Arrange
+        template = """{{#each chat_history}}{{#message role=role}}{{~content~}}{{/message}} {{/each}}"""
+        target = create_handlebars_prompt_template(template)
+        chat_history = ChatHistory()
+        chat_history.add_user_message("What does a < b mean in Python?")
+        chat_history.add_assistant_message('Use "&" carefully in XML and HTML.')
+
+        rendered = await target.render(kernel, KernelArguments(chat_history=chat_history))
+
+        assert "&lt;" in rendered
+        assert "&amp;" in rendered
+        assert '"&amp;"' in rendered
+        assert ChatHistory.from_rendered_prompt(rendered) == chat_history
+
+    async def test_message_helper_preserves_system_role_with_xml_metacharacters(self, kernel: Kernel):
+        # Arrange
+        template = (
+            """{{system_message}}{{#each chat_history}}{{#message role=role}}{{~content~}}{{/message}} {{/each}}"""
+        )
+        target = create_handlebars_prompt_template(template)
+        system_message = "You are a helpful assistant."
+        chat_history = ChatHistory()
+        chat_history.add_user_message("What does a < b mean in Python?")
+
+        rendered = await target.render(
+            kernel,
+            KernelArguments(system_message=system_message, chat_history=chat_history),
+        )
+
+        parsed = ChatHistory.from_rendered_prompt(rendered)
+        assert parsed.messages[0].role == AuthorRole.SYSTEM
+        assert parsed.messages[0].content == system_message
+        assert parsed.messages[1].role == AuthorRole.USER
+        assert parsed.messages[1].content == "What does a < b mean in Python?"

python/tests/unit/prompt_template/test_jinja2_prompt_template.py

@@ -264,6 +264,20 @@ async def test_helpers_message(kernel: Kernel):
     assert "Assistant message" in rendered
 
 
+async def test_helpers_message_escapes_xml_metacharacters(kernel: Kernel):
+    template = """{% for item in chat_history %}{{ message(item) }}{% endfor %}"""
+    target = create_jinja2_prompt_template(template, allow_dangerously_set_content=True)
+    chat_history = ChatHistory()
+    chat_history.add_user_message('What does a < b & "c" mean?')
+
+    rendered = await target.render(kernel, KernelArguments(chat_history=chat_history))
+
+    assert "&lt;" in rendered
+    assert "&amp;" in rendered
+    assert '"c"' in rendered
+    assert ChatHistory.from_rendered_prompt(rendered) == chat_history
+
+
 async def test_helpers_message_to_prompt(kernel: Kernel):
     template = """
     {% for chat in chat_history %}