Skip to content

Commit e0ccee0

Browse files
Python: updates to chat_prompt and related (#4720)
### Motivation and Context <!-- 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. --> Fixes #4711 and #4705 and addresses some inconsistencies in the way the chat_prompt_template is created, now has more control. ### Description <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> Added parse flags to chatPromptTemplate to allow the user to control is something is loaded into messages or not. Added better docstrings and tests for this as well. ### 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 😄
1 parent ea4ec54 commit e0ccee0

5 files changed

Lines changed: 79 additions & 71 deletions

File tree

‎python/semantic_kernel/connectors/ai/open_ai/request_settings/open_ai_request_settings.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
from pydantic import Field, field_validator, model_validator
55

66
from semantic_kernel.connectors.ai.ai_request_settings import AIRequestSettings
7-
from semantic_kernel.connectors.ai.open_ai.const import DEFAULT_CHAT_SYSTEM_PROMPT
87

98
logger = logging.getLogger(__name__)
109

@@ -59,7 +58,7 @@ class OpenAIChatRequestSettings(OpenAIRequestSettings):
5958
tool_choice: Optional[str] = None
6059
function_call: Optional[str] = None
6160
functions: Optional[List[Dict[str, Any]]] = None
62-
messages: Optional[List[Dict[str, Any]]] = [{"role": "system", "content": DEFAULT_CHAT_SYSTEM_PROMPT}]
61+
messages: Optional[List[Dict[str, Any]]] = None
6362

6463
@field_validator("functions", "function_call", mode="after")
6564
@classmethod
Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
11
# Copyright (c) Microsoft. All rights reserved.
22

33
import logging
4-
from typing import Any, Dict, List, Optional
4+
from typing import Any, Optional
55

66
from semantic_kernel.connectors.ai.open_ai.models.chat.open_ai_chat_message import (
77
OpenAIChatMessage,
88
)
99
from semantic_kernel.semantic_functions.chat_prompt_template import ChatPromptTemplate
1010
from semantic_kernel.semantic_functions.prompt_template import PromptTemplate
11-
from semantic_kernel.semantic_functions.prompt_template_config import (
12-
PromptTemplateConfig,
13-
)
14-
from semantic_kernel.template_engine.protocols.prompt_templating_engine import (
15-
PromptTemplatingEngine,
16-
)
1711

1812
logger: logging.Logger = logging.getLogger(__name__)
1913

@@ -49,7 +43,7 @@ def add_message(self, role: str, message: Optional[str] = None, **kwargs: Any) -
4943
)
5044
)
5145
return
52-
self._log.warning("function_call is only used with role: assistant, ignoring")
46+
logger.warning("function_call is only used with role: assistant, ignoring")
5347
function_call = None
5448
self.messages.append(
5549
OpenAIChatMessage(
@@ -59,39 +53,3 @@ def add_message(self, role: str, message: Optional[str] = None, **kwargs: Any) -
5953
function_call=function_call,
6054
)
6155
)
62-
63-
@classmethod
64-
def restore(
65-
cls,
66-
messages: List[Dict[str, str]],
67-
template: str,
68-
template_engine: PromptTemplatingEngine,
69-
prompt_config: PromptTemplateConfig,
70-
log: Optional[Any] = None,
71-
) -> "OpenAIChatPromptTemplate":
72-
"""Restore a ChatPromptTemplate from a list of role and message pairs.
73-
74-
If there is a chat_system_prompt in the prompt_config.execution_settings settings,
75-
that takes precedence over the first message in the list of messages,
76-
if that is a system message.
77-
"""
78-
if log:
79-
logger.warning("The `log` parameter is deprecated. Please use the `logging` module instead.")
80-
chat_template = cls(template, template_engine, prompt_config)
81-
if prompt_config.execution_settings.chat_system_prompt and messages[0]["role"] == "system":
82-
existing_system_message = messages.pop(0)
83-
if existing_system_message["message"] != prompt_config.execution_settings.chat_system_prompt:
84-
logger.info(
85-
"Overriding system prompt with chat_system_prompt, old system message: %s, new system message: %s",
86-
existing_system_message["message"],
87-
prompt_config.execution_settings.chat_system_prompt,
88-
)
89-
for message in messages:
90-
chat_template.add_message(
91-
message["role"],
92-
message["message"],
93-
name=message["name"],
94-
function_call=message["function_call"],
95-
)
96-
97-
return chat_template

‎python/semantic_kernel/semantic_functions/chat_prompt_template.py‎

Lines changed: 58 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,43 @@ def __init__(
3131
template: str,
3232
template_engine: PromptTemplatingEngine,
3333
prompt_config: PromptTemplateConfig,
34-
log: Optional[Any] = None,
34+
parse_chat_system_prompt: bool = False,
35+
parse_messages: bool = False,
36+
**kwargs: Any,
3537
) -> None:
38+
"""Initialize a chat prompt template.
39+
40+
if there is a field 'chat_system_prompt' in the prompt_config.execution_settings.extension_data,
41+
that value is added to the messages list as a system message,
42+
can be controlled by setting the parse_chat_system_prompt parameter to True.
43+
44+
After that any messages that are in messages in the prompt_config.execution_settings
45+
are added to the messages list.
46+
Can be controlled by setting the parse_messages parameter to True.
47+
48+
Arguments:
49+
template {str} -- The template to use for the chat prompt.
50+
template_engine {PromptTemplatingEngine} -- The templating engine to use.
51+
prompt_config {PromptTemplateConfig} -- The prompt config to use.
52+
parse_chat_system_prompt {bool} -- Whether to parse the chat_system_prompt from
53+
the prompt_config.execution_settings.extension_data.
54+
parse_messages {bool} -- Whether to parse the messages from the prompt_config.execution_settings.
55+
56+
"""
3657
super().__init__(template, template_engine, prompt_config)
37-
if log:
58+
if "log" in kwargs:
3859
logger.warning("The `log` parameter is deprecated. Please use the `logging` module instead.")
39-
self._messages = []
40-
if self.prompt_config.execution_settings.extension_data.get("chat_system_prompt"):
60+
61+
if parse_chat_system_prompt and "chat_system_prompt" in self.prompt_config.execution_settings.extension_data:
4162
self.add_system_message(self.prompt_config.execution_settings.extension_data["chat_system_prompt"])
63+
4264
if (
43-
hasattr(self.prompt_config.execution_settings, "messages")
65+
parse_messages
66+
and hasattr(self.prompt_config.execution_settings, "messages")
4467
and self.prompt_config.execution_settings.messages
4568
):
4669
for message in self.prompt_config.execution_settings.messages:
47-
self.add_message(message["role"], message["content"])
70+
self.add_message(**message)
4871

4972
async def render_async(self, context: "KernelContext") -> str:
5073
raise NotImplementedError(
@@ -75,6 +98,9 @@ def add_message(self, role: str, message: Optional[str] = None, **kwargs: Any) -
7598
# When the type is not explicitly set, it is still the typevar, replace with generic ChatMessage
7699
if isinstance(concrete_message, TypeVar):
77100
concrete_message = ChatMessage
101+
assert issubclass(concrete_message, ChatMessage)
102+
if not message and "content" in kwargs:
103+
message = kwargs["content"]
78104
self.messages.append(
79105
concrete_message(
80106
role=role,
@@ -104,26 +130,35 @@ def restore(
104130
template: str,
105131
template_engine: PromptTemplatingEngine,
106132
prompt_config: PromptTemplateConfig,
107-
log: Optional[Any] = None,
133+
parse_chat_system_prompt: bool = False,
134+
parse_messages: bool = False,
135+
**kwargs: Any,
108136
) -> "ChatPromptTemplate":
109137
"""Restore a ChatPromptTemplate from a list of role and message pairs.
110138
111-
If there is a chat_system_prompt in the prompt_config.execution_settings settings,
112-
that takes precedence over the first message in the list of messages,
113-
if that is a system message.
139+
The parse_messages and parse_chat_system_prompt parameters control whether
140+
the messages and chat_system_prompt from the prompt_config.execution_settings
141+
are parsed and added to the messages list, not whether or not the 'messages'
142+
from the messages parameter are parsed, those are always parsed.
143+
144+
Arguments:
145+
messages {List[Dict[str, str]]} -- The messages to restore,
146+
the default format is [{"role": "user", "message": "Hi there"}].
147+
if the ChatPromptTemplate is created with a different message type,
148+
the messages should contain any fields that are relevant to the message,
149+
for instance: ChatPromptTemplate[OpenAIChatMessage].restore can be used with a format:
150+
[{"role": "assistant", "function_call": FunctionCall()}].
151+
template {str} -- The template to use for the chat prompt.
152+
template_engine {PromptTemplatingEngine} -- The templating engine to use.
153+
prompt_config {PromptTemplateConfig} -- The prompt config to use.
154+
parse_chat_system_prompt {bool} -- Whether to parse the chat_system_prompt from the
155+
prompt_config.execution_settings.extension_data.
156+
parse_messages {bool} -- Whether to parse the messages from the prompt_config.execution_settings.
157+
114158
"""
115-
if log:
116-
logger.warning("The `log` parameter is deprecated. Please use the `logging` module instead.")
117-
chat_template = cls(template, template_engine, prompt_config)
118-
if prompt_config.execution_settings.chat_system_prompt and messages[0]["role"] == "system":
119-
existing_system_message = messages.pop(0)
120-
if existing_system_message["message"] != prompt_config.execution_settings.chat_system_prompt:
121-
logger.info(
122-
"Overriding system prompt with chat_system_prompt, old system message: %s, new system message: %s",
123-
existing_system_message["message"],
124-
prompt_config.execution_settings.chat_system_prompt,
125-
)
159+
chat_template = cls(
160+
template, template_engine, prompt_config, parse_chat_system_prompt, parse_messages, **kwargs
161+
)
126162
for message in messages:
127-
chat_template.add_message(message["role"], message["message"])
128-
163+
chat_template.add_message(**message)
129164
return chat_template

‎python/tests/unit/ai/open_ai/test_openai_request_settings.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def test_default_openai_chat_request_settings():
2626
assert settings.stop is None
2727
assert settings.number_of_responses == 1
2828
assert settings.logit_bias == {}
29-
assert settings.messages[0]["content"] == "Assistant is a large language model."
29+
assert settings.messages is None
3030

3131

3232
def test_custom_openai_chat_request_settings():

‎python/tests/unit/plugin_definition/test_prompt_templates.py‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,15 +151,31 @@ def test_chat_prompt_template():
151151
assert chat_prompt_template.messages == []
152152

153153

154-
def test_chat_prompt_template_with_system_prompt():
154+
def test_chat_prompt_template_with_messages():
155155
prompt_template_config = PromptTemplateConfig[OpenAIChatRequestSettings].from_execution_settings(
156156
messages=[{"role": "system", "content": "Custom system prompt."}],
157157
)
158+
chat_prompt_template = ChatPromptTemplate[OpenAIChatMessage](
159+
"{{$user_input}}",
160+
PromptTemplateEngine(),
161+
prompt_config=prompt_template_config,
162+
parse_messages=True,
163+
)
164+
print(chat_prompt_template.messages)
165+
assert len(chat_prompt_template.messages) == 1
166+
assert chat_prompt_template.messages[0].role == "system"
167+
assert chat_prompt_template.messages[0].content_template.template == "Custom system prompt."
168+
158169

170+
def test_chat_prompt_template_with_system_prompt():
171+
prompt_template_config = PromptTemplateConfig[OpenAIChatRequestSettings].from_execution_settings(
172+
chat_system_prompt="Custom system prompt.",
173+
)
159174
chat_prompt_template = ChatPromptTemplate[OpenAIChatMessage](
160175
"{{$user_input}}",
161176
PromptTemplateEngine(),
162177
prompt_config=prompt_template_config,
178+
parse_chat_system_prompt=True,
163179
)
164180
print(chat_prompt_template.messages)
165181
assert len(chat_prompt_template.messages) == 1

0 commit comments

Comments
 (0)