rename to extra parameters

Arize-ai · Feb 1, 2025 · 961c448 · 961c448
1 parent 53670ea
commit 961c448
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 22 deletions.
diff --git a/schemas/openapi.json b/schemas/openapi.json
@@ -2217,17 +2217,17 @@
             "type": "object",
             "title": "Schema"
           },
-          "additional_parameters": {
+          "extra_parameters": {
             "type": "object",
-            "title": "Additional Parameters"
+            "title": "Extra Parameters"
           }
         },
         "additionalProperties": false,
         "type": "object",
         "required": [
           "type",
           "name",
-          "additional_parameters"
+          "extra_parameters"
         ],
         "title": "PromptFunctionToolV1"
       },

diff --git a/src/phoenix/server/api/helpers/prompts/models.py b/src/phoenix/server/api/helpers/prompts/models.py
@@ -151,7 +151,7 @@ class PromptFunctionToolV1(PromptModel):
         default=UNDEFINED,
         alias="schema",  # avoid conflict with pydantic schema class method
     )
-    additional_parameters: dict[str, Any]
+    extra_parameters: dict[str, Any]
 
 
 class PromptToolsV1(PromptModel):
@@ -242,15 +242,15 @@ def _openai_to_prompt_tool(
     name = function_definition.name
     description = function_definition.description
     parameters = function_definition.parameters
-    additional_parameters = {}
+    extra_parameters = {}
     if (strict := function_definition.strict) is not UNDEFINED:
-        additional_parameters["strict"] = strict
+        extra_parameters["strict"] = strict
     return PromptFunctionToolV1(
         type="function-tool-v1",
         name=name,
         description=description,
         schema=parameters,
-        additional_parameters=additional_parameters,
+        extra_parameters=extra_parameters,
     )
 
 
@@ -263,35 +263,35 @@ def _prompt_to_openai_tool(
             name=tool.name,
             description=tool.description,
             parameters=tool.schema_,
-            strict=tool.additional_parameters.get("strict", UNDEFINED),
+            strict=tool.extra_parameters.get("strict", UNDEFINED),
         ),
     )
 
 
 def _anthropic_to_prompt_tool(
     tool: AnthropicToolDefinition,
 ) -> PromptFunctionToolV1:
-    additional_parameters: dict[str, Any] = {}
+    extra_parameters: dict[str, Any] = {}
     if (cache_control := tool.cache_control) is not UNDEFINED:
         if cache_control is None:
-            additional_parameters["cache_control"] = None
+            extra_parameters["cache_control"] = None
         elif isinstance(cache_control, AnthropicCacheControlEphemeralParam):
-            additional_parameters["cache_control"] = cache_control.model_dump()
+            extra_parameters["cache_control"] = cache_control.model_dump()
         else:
             assert_never(cache_control)
     return PromptFunctionToolV1(
         type="function-tool-v1",
         name=tool.name,
         description=tool.description,
         schema=tool.input_schema,
-        additional_parameters=additional_parameters,
+        extra_parameters=extra_parameters,
     )
 
 
 def _prompt_to_anthropic_tool(
     tool: PromptFunctionToolV1,
 ) -> AnthropicToolDefinition:
-    cache_control = tool.additional_parameters.get("cache_control", UNDEFINED)
+    cache_control = tool.extra_parameters.get("cache_control", UNDEFINED)
     anthropic_cache_control: Optional[AnthropicCacheControlEphemeralParam]
     if cache_control is UNDEFINED:
         anthropic_cache_control = UNDEFINED

diff --git a/tests/unit/server/api/helpers/prompts/test_models.py b/tests/unit/server/api/helpers/prompts/test_models.py
@@ -39,7 +39,7 @@
                         },
                     },
                 },
-                "additional_parameters": {},
+                "extra_parameters": {},
             },
             id="minimal-tool",
         ),
@@ -68,7 +68,7 @@
                         },
                     },
                 },
-                "additional_parameters": {},
+                "extra_parameters": {},
             },
             id="tool-with-description",
         ),
@@ -98,7 +98,7 @@
                         },
                     },
                 },
-                "additional_parameters": {
+                "extra_parameters": {
                     "cache_control": {
                         "type": "ephemeral",
                     },
@@ -130,7 +130,7 @@
                         },
                     },
                 },
-                "additional_parameters": {
+                "extra_parameters": {
                     "cache_control": None,
                 },
             },
@@ -180,7 +180,7 @@ def test_anthropic_tool_normalization_and_round_tripping_preserves_data(
                         },
                     },
                 },
-                "additional_parameters": {},
+                "extra_parameters": {},
             },
             id="minimal-tool",
         ),
@@ -212,7 +212,7 @@ def test_anthropic_tool_normalization_and_round_tripping_preserves_data(
                         },
                     },
                 },
-                "additional_parameters": {},
+                "extra_parameters": {},
             },
             id="tool-with-description",
         ),
@@ -226,7 +226,7 @@ def test_anthropic_tool_normalization_and_round_tripping_preserves_data(
             {
                 "type": "function-tool-v1",
                 "name": "tool-name",
-                "additional_parameters": {},
+                "extra_parameters": {},
             },
             id="tool-with-no-parameters",
         ),
@@ -241,7 +241,7 @@ def test_anthropic_tool_normalization_and_round_tripping_preserves_data(
             {
                 "type": "function-tool-v1",
                 "name": "tool-name",
-                "additional_parameters": {"strict": True},
+                "extra_parameters": {"strict": True},
             },
             id="tool-with-strict-set-to-bool",
         ),
@@ -256,7 +256,7 @@ def test_anthropic_tool_normalization_and_round_tripping_preserves_data(
             {
                 "type": "function-tool-v1",
                 "name": "tool-name",
-                "additional_parameters": {"strict": None},
+                "extra_parameters": {"strict": None},
             },
             id="tool-with-strict-set-to-none",
         ),