feat(drivers-azure): bump api_version in Azure Prompt/Embedding Drivers

Author: collindutter

CHANGELOG.md

@@ -43,6 +43,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Improved mime type detection in `FileManagerTool`.
 - Improve `SqlDriver.get_table_schema` speed.
 - Cache `SqlDriver.get_table_schema` results.
+- Updated Azure Drivers to use the latest Azure OpenAI API version, `2024-10-21`.
 
 ### Deprecated
 

griptape/drivers/embedding/azure_openai_embedding_driver.py

@@ -36,7 +36,7 @@ class AzureOpenAiEmbeddingDriver(OpenAiEmbeddingDriver):
         default=None,
         metadata={"serializable": False},
     )
-    api_version: str = field(default="2023-05-15", kw_only=True, metadata={"serializable": True})
+    api_version: str = field(default="2024-10-21", kw_only=True, metadata={"serializable": True})
     tokenizer: OpenAiTokenizer = field(
         default=Factory(lambda self: OpenAiTokenizer(model=self.model), takes_self=True),
         kw_only=True,

griptape/drivers/prompt/azure_openai_chat_prompt_driver.py

@@ -37,7 +37,7 @@ class AzureOpenAiChatPromptDriver(OpenAiChatPromptDriver):
         default=None,
         metadata={"serializable": False},
     )
-    api_version: str = field(default="2023-05-15", kw_only=True, metadata={"serializable": True})
+    api_version: str = field(default="2024-10-21", kw_only=True, metadata={"serializable": True})
     _client: openai.AzureOpenAI = field(default=None, kw_only=True, alias="client", metadata={"serializable": False})
 
     @lazy_property()
@@ -54,13 +54,11 @@ def client(self) -> openai.AzureOpenAI:
 
     def _base_params(self, prompt_stack: PromptStack) -> dict:
         params = super()._base_params(prompt_stack)
-        # TODO: Add `seed` parameter once Azure supports it.
-        if "seed" in params:
+        if self.api_version < "2024-02-01" and "seed" in params:
             del params["seed"]
-        # TODO: Add `stream_options` parameter once Azure supports it.
-        if "stream_options" in params:
-            del params["stream_options"]
-        # TODO: Add `parallel_tool_calls` parameter once Azure supports it.
-        if "parallel_tool_calls" in params:
-            del params["parallel_tool_calls"]
+        if self.api_version < "2024-10-21":
+            if "stream_options" in params:
+                del params["stream_options"]
+            if "parallel_tool_calls" in params:
+                del params["parallel_tool_calls"]
         return params

tests/unit/configs/drivers/test_azure_openai_drivers_config.py

@@ -26,7 +26,7 @@ def test_to_dict(self, config):
                 "model": "gpt-4o",
                 "azure_deployment": "gpt-4o",
                 "azure_endpoint": "http://localhost:8080",
-                "api_version": "2023-05-15",
+                "api_version": "2024-10-21",
                 "organization": None,
                 "parallel_tool_calls": True,
                 "reasoning_effort": "medium",
@@ -47,7 +47,7 @@ def test_to_dict(self, config):
             "embedding_driver": {
                 "base_url": None,
                 "model": "text-embedding-3-small",
-                "api_version": "2023-05-15",
+                "api_version": "2024-10-21",
                 "azure_deployment": "text-embedding-3-small",
                 "azure_endpoint": "http://localhost:8080",
                 "organization": None,
@@ -70,7 +70,7 @@ def test_to_dict(self, config):
                 "embedding_driver": {
                     "base_url": None,
                     "model": "text-embedding-3-small",
-                    "api_version": "2023-05-15",
+                    "api_version": "2024-10-21",
                     "azure_deployment": "text-embedding-3-small",
                     "azure_endpoint": "http://localhost:8080",
                     "organization": None,

tests/unit/drivers/prompt/test_azure_openai_chat_prompt_driver.py

@@ -68,13 +68,15 @@ def test_init(self):
 
     @pytest.mark.parametrize("use_native_tools", [True, False])
     @pytest.mark.parametrize("structured_output_strategy", ["native", "tool"])
+    @pytest.mark.parametrize("api_version", ["2023-05-15", "2024-02-01", "2024-06-01", "2024-10-21"])
     def test_try_run(
         self,
         mock_chat_completion_create,
         prompt_stack,
         messages,
         use_native_tools,
         structured_output_strategy,
+        api_version,
     ):
         # Given
         driver = AzureOpenAiChatPromptDriver(
@@ -84,6 +86,7 @@ def test_try_run(
             use_native_tools=use_native_tools,
             structured_output_strategy=structured_output_strategy,
             extra_params={"foo": "bar"},
+            api_version=api_version,
         )
 
         # When
@@ -95,6 +98,16 @@ def test_try_run(
             temperature=driver.temperature,
             user=driver.user,
             messages=messages,
+            **{
+                "seed": driver.seed,
+            }
+            if driver.api_version >= "2024-02-01"
+            else {},
+            **{
+                "parallel_tool_calls": driver.parallel_tool_calls,
+            }
+            if driver.api_version >= "2024-10-21" and prompt_stack.tools and driver.use_native_tools
+            else {},
             **{
                 "tools": self.OPENAI_TOOLS,
                 "tool_choice": "required" if structured_output_strategy == "tool" else driver.tool_choice,
@@ -125,13 +138,15 @@ def test_try_run(
 
     @pytest.mark.parametrize("use_native_tools", [True, False])
     @pytest.mark.parametrize("structured_output_strategy", ["native", "tool"])
+    @pytest.mark.parametrize("api_version", ["2023-05-15", "2024-02-01", "2024-06-01", "2024-10-21"])
     def test_try_stream_run(
         self,
         mock_chat_completion_stream_create,
         prompt_stack,
         messages,
         use_native_tools,
         structured_output_strategy,
+        api_version,
     ):
         # Given
         driver = AzureOpenAiChatPromptDriver(
@@ -142,6 +157,7 @@ def test_try_stream_run(
             use_native_tools=use_native_tools,
             structured_output_strategy=structured_output_strategy,
             extra_params={"foo": "bar"},
+            api_version=api_version,
         )
 
         # When
@@ -161,6 +177,16 @@ def test_try_stream_run(
             }
             if use_native_tools
             else {},
+            **{
+                "seed": driver.seed,
+            }
+            if driver.api_version >= "2024-02-01"
+            else {},
+            **{
+                "parallel_tool_calls": driver.parallel_tool_calls,
+            }
+            if driver.api_version >= "2024-10-21" and prompt_stack.tools and driver.use_native_tools
+            else {},
             **{
                 "response_format": {
                     "type": "json_schema",
@@ -174,6 +200,11 @@ def test_try_stream_run(
             if structured_output_strategy == "native"
             else {},
             foo="bar",
+            **{
+                "stream_options": {"include_usage": True},
+            }
+            if driver.api_version >= "2024-10-21"
+            else {},
         )
 
         assert isinstance(event.content, TextDeltaMessageContent)