Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python: Add parallel_tool_calls attribute to OpenAI chat prompt execution settings #9479

Merged
merged 3 commits into from
Oct 30, 2024
Merged

Python: Add parallel_tool_calls attribute to OpenAI chat prompt execution settings #9479

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4be3d4
Add parallel_tool_calls attribute to OpenAI chat prompt execution set…
moonbox3 Oct 30, 2024
98bf49a
Remove unnecessary Pydantic field.
moonbox3 Oct 30, 2024
2012a8f
Don't send parallel tool calls if no tools are specified.
moonbox3 Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...rnel/connectors/ai/open_ai/prompt_execution_settings/open_ai_prompt_execution_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ class OpenAIChatPromptExecutionSettings(OpenAIPromptExecutionSettings):
functions: list[dict[str, Any]] | None = None
messages: list[dict[str, Any]] | None = None
function_call_behavior: FunctionCallBehavior | None = Field(None, exclude=True)
parallel_tool_calls: bool = True
moonbox3 marked this conversation as resolved.
Show resolved Hide resolved
tools: list[dict[str, Any]] | None = Field(
None,
max_length=64,
Expand Down
64 changes: 64 additions & 0 deletions python/tests/unit/connectors/ai/open_ai/services/test_azure_chat_completion.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,34 @@ async def test_cmc(
mock_create.assert_awaited_once_with(
model=azure_openai_unit_test_env["AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"],
stream=False,
parallel_tool_calls=True,
messages=azure_chat_completion._prepare_chat_history_for_request(chat_history),
)


@pytest.mark.asyncio
@patch.object(AsyncChatCompletions, "create", new_callable=AsyncMock)
async def test_cmc_parallel_tool_calls_disabled(
mock_create,
kernel: Kernel,
azure_openai_unit_test_env,
chat_history: ChatHistory,
mock_chat_completion_response: ChatCompletion,
) -> None:
mock_create.return_value = mock_chat_completion_response
chat_history.add_user_message("hello world")
complete_prompt_execution_settings = AzureChatPromptExecutionSettings(
service_id="test_service_id", parallel_tool_calls=False
)

azure_chat_completion = AzureChatCompletion()
await azure_chat_completion.get_chat_message_contents(
chat_history=chat_history, settings=complete_prompt_execution_settings, kernel=kernel
)
mock_create.assert_awaited_once_with(
model=azure_openai_unit_test_env["AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"],
stream=False,
parallel_tool_calls=False,
messages=azure_chat_completion._prepare_chat_history_for_request(chat_history),
)

Expand Down Expand Up @@ -217,6 +245,7 @@ async def test_cmc_with_logit_bias(
model=azure_openai_unit_test_env["AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"],
messages=azure_chat_completion._prepare_chat_history_for_request(chat_history),
stream=False,
parallel_tool_calls=True,
logit_bias=token_bias,
)

Expand Down Expand Up @@ -245,6 +274,7 @@ async def test_cmc_with_stop(
model=azure_openai_unit_test_env["AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"],
messages=azure_chat_completion._prepare_chat_history_for_request(chat_history),
stream=False,
parallel_tool_calls=True,
stop=stop,
)

Expand Down Expand Up @@ -314,6 +344,7 @@ async def test_azure_on_your_data(
model=azure_openai_unit_test_env["AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"],
messages=azure_chat_completion._prepare_chat_history_for_request(messages_out),
stream=False,
parallel_tool_calls=True,
extra_body=expected_data_settings,
)

Expand Down Expand Up @@ -383,6 +414,7 @@ async def test_azure_on_your_data_string(
model=azure_openai_unit_test_env["AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"],
messages=azure_chat_completion._prepare_chat_history_for_request(messages_out),
stream=False,
parallel_tool_calls=True,
extra_body=expected_data_settings,
)

Expand Down Expand Up @@ -441,6 +473,7 @@ async def test_azure_on_your_data_fail(
model=azure_openai_unit_test_env["AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"],
messages=azure_chat_completion._prepare_chat_history_for_request(messages_out),
stream=False,
parallel_tool_calls=True,
extra_body=expected_data_settings,
)

Expand Down Expand Up @@ -542,6 +575,7 @@ async def test_cmc_function_calling(
messages=azure_chat_completion._prepare_chat_history_for_request(chat_history),
stream=False,
functions=functions,
parallel_tool_calls=True,
function_call=complete_prompt_execution_settings.function_call,
)

Expand Down Expand Up @@ -592,6 +626,7 @@ async def test_cmc_tool_calling(
model=azure_openai_unit_test_env["AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"],
messages=azure_chat_completion._prepare_chat_history_for_request(chat_history),
stream=False,
parallel_tool_calls=True,
)


Expand Down Expand Up @@ -787,5 +822,34 @@ async def test_cmc_streaming(
mock_create.assert_awaited_once_with(
model=azure_openai_unit_test_env["AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"],
stream=True,
parallel_tool_calls=True,
messages=azure_chat_completion._prepare_chat_history_for_request(chat_history),
)


@pytest.mark.asyncio
@patch.object(AsyncChatCompletions, "create", new_callable=AsyncMock)
async def test_cmc_streaming_parallel_tool_calls_disabled(
mock_create,
kernel: Kernel,
azure_openai_unit_test_env,
chat_history: ChatHistory,
mock_streaming_chat_completion_response: AsyncStream[ChatCompletionChunk],
) -> None:
mock_create.return_value = mock_streaming_chat_completion_response
chat_history.add_user_message("hello world")
complete_prompt_execution_settings = AzureChatPromptExecutionSettings(
service_id="test_service_id", parallel_tool_calls=False
)

azure_chat_completion = AzureChatCompletion()
async for msg in azure_chat_completion.get_streaming_chat_message_contents(
chat_history=chat_history, settings=complete_prompt_execution_settings, kernel=kernel
):
assert msg is not None
mock_create.assert_awaited_once_with(
model=azure_openai_unit_test_env["AZURE_OPENAI_CHAT_DEPLOYMENT_NAME"],
stream=True,
parallel_tool_calls=False,
messages=azure_chat_completion._prepare_chat_history_for_request(chat_history),
)
90 changes: 90 additions & 0 deletions python/tests/unit/connectors/ai/open_ai/services/test_open_ai_chat_completion_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,34 @@ async def test_cmc(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=False,
parallel_tool_calls=True,
messages=openai_chat_completion._prepare_chat_history_for_request(chat_history),
)


@pytest.mark.asyncio
@patch.object(AsyncChatCompletions, "create", new_callable=AsyncMock)
async def test_cmc_parallel_tool_calls_disabled(
mock_create,
kernel: Kernel,
chat_history: ChatHistory,
mock_chat_completion_response: ChatCompletion,
openai_unit_test_env,
):
mock_create.return_value = mock_chat_completion_response
chat_history.add_user_message("hello world")
complete_prompt_execution_settings = OpenAIChatPromptExecutionSettings(
service_id="test_service_id", parallel_tool_calls=False
)

openai_chat_completion = OpenAIChatCompletion()
await openai_chat_completion.get_chat_message_contents(
chat_history=chat_history, settings=complete_prompt_execution_settings, kernel=kernel
)
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=False,
parallel_tool_calls=False,
messages=openai_chat_completion._prepare_chat_history_for_request(chat_history),
)

Expand All @@ -113,6 +141,7 @@ async def test_cmc_singular(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=False,
parallel_tool_calls=True,
messages=openai_chat_completion._prepare_chat_history_for_request(chat_history),
)

Expand All @@ -137,6 +166,7 @@ async def test_cmc_prompt_execution_settings(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=False,
parallel_tool_calls=True,
messages=openai_chat_completion._prepare_chat_history_for_request(chat_history),
)

Expand Down Expand Up @@ -187,6 +217,7 @@ async def test_cmc_function_call_behavior(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=False,
parallel_tool_calls=True,
messages=openai_chat_completion._prepare_chat_history_for_request(orig_chat_history),
)
mock_process_function_call.assert_awaited()
Expand Down Expand Up @@ -238,6 +269,7 @@ async def test_cmc_function_choice_behavior(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=False,
parallel_tool_calls=True,
messages=openai_chat_completion._prepare_chat_history_for_request(orig_chat_history),
)
mock_process_function_call.assert_awaited()
Expand Down Expand Up @@ -317,6 +349,7 @@ async def test_cmc_no_fcc_in_response(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=False,
parallel_tool_calls=True,
messages=openai_chat_completion._prepare_chat_history_for_request(orig_chat_history),
)

Expand Down Expand Up @@ -413,6 +446,7 @@ async def test_scmc_prompt_execution_settings(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=True,
parallel_tool_calls=True,
stream_options={"include_usage": True},
messages=openai_chat_completion._prepare_chat_history_for_request(chat_history),
)
Expand Down Expand Up @@ -481,6 +515,55 @@ async def test_scmc(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=True,
parallel_tool_calls=True,
stream_options={"include_usage": True},
messages=openai_chat_completion._prepare_chat_history_for_request(orig_chat_history),
)


@pytest.mark.asyncio
@patch.object(AsyncChatCompletions, "create", new_callable=AsyncMock)
async def test_scmc_parallel_tool_calls_disabled(
mock_create,
kernel: Kernel,
chat_history: ChatHistory,
openai_unit_test_env,
):
content1 = ChatCompletionChunk(
id="test_id",
choices=[],
created=0,
model="test",
object="chat.completion.chunk",
)
content2 = ChatCompletionChunk(
id="test_id",
choices=[ChunkChoice(index=0, delta=ChunkChoiceDelta(content="test", role="assistant"), finish_reason="stop")],
created=0,
model="test",
object="chat.completion.chunk",
)
stream = MagicMock(spec=AsyncStream)
stream.__aiter__.return_value = [content1, content2]
mock_create.return_value = stream
chat_history.add_user_message("hello world")
orig_chat_history = deepcopy(chat_history)
complete_prompt_execution_settings = OpenAIChatPromptExecutionSettings(
service_id="test_service_id", parallel_tool_calls=False
)

openai_chat_completion = OpenAIChatCompletion()
async for msg in openai_chat_completion.get_streaming_chat_message_contents(
chat_history=chat_history,
settings=complete_prompt_execution_settings,
kernel=kernel,
arguments=KernelArguments(),
):
assert isinstance(msg[0], StreamingChatMessageContent)
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=True,
parallel_tool_calls=False,
stream_options={"include_usage": True},
messages=openai_chat_completion._prepare_chat_history_for_request(orig_chat_history),
)
Expand Down Expand Up @@ -526,6 +609,7 @@ async def test_scmc_singular(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=True,
parallel_tool_calls=True,
stream_options={"include_usage": True},
messages=openai_chat_completion._prepare_chat_history_for_request(orig_chat_history),
)
Expand Down Expand Up @@ -606,6 +690,7 @@ async def test_scmc_function_call_behavior(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=True,
parallel_tool_calls=True,
stream_options={"include_usage": True},
messages=openai_chat_completion._prepare_chat_history_for_request(orig_chat_history),
)
Expand Down Expand Up @@ -642,6 +727,7 @@ async def test_scmc_function_choice_behavior(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=True,
parallel_tool_calls=True,
stream_options={"include_usage": True},
messages=openai_chat_completion._prepare_chat_history_for_request(orig_chat_history),
)
Expand Down Expand Up @@ -713,6 +799,7 @@ async def test_scmc_no_fcc_in_response(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=True,
parallel_tool_calls=True,
stream_options={"include_usage": True},
messages=openai_chat_completion._prepare_chat_history_for_request(orig_chat_history),
)
Expand Down Expand Up @@ -816,6 +903,7 @@ async def test_tc(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=False,
parallel_tool_calls=True,
messages=[{"role": "user", "content": "test"}],
)

Expand All @@ -838,6 +926,7 @@ async def test_stc(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=True,
parallel_tool_calls=True,
messages=[{"role": "user", "content": "test"}],
)

Expand All @@ -862,6 +951,7 @@ async def test_stc_with_msgs(
mock_create.assert_awaited_once_with(
model=openai_unit_test_env["OPENAI_CHAT_MODEL_ID"],
stream=True,
parallel_tool_calls=True,
messages=[{"role": "system", "content": "system prompt"}, {"role": "user", "content": "test"}],
)

Expand Down
Loading