free-form -> freeform

Author: matthewfranglen

pydantic_ai_slim/pydantic_ai/agent/__init__.py

@@ -1068,7 +1068,7 @@ async def spam(ctx: RunContext[str], y: float) -> float:
             schema_generator: The JSON schema generator class to use for this tool. Defaults to `GenerateToolJsonSchema`.
             strict: Whether to enforce JSON schema compliance (only affects OpenAI).
                 See [`ToolDefinition`][pydantic_ai.tools.ToolDefinition] for more info.
-            text_format: Used to invoke the function using free-form function calling (only affects OpenAI).
+            text_format: Used to invoke the function using freeform function calling (only affects OpenAI).
                 See [`ToolDefinition`][pydantic_ai.tools.ToolDefinition] for more info.
             requires_approval: Whether this tool requires human-in-the-loop approval. Defaults to False.
                 See the [tools documentation](../deferred-tools.md#human-in-the-loop-tool-approval) for more info.
@@ -1172,7 +1172,7 @@ async def spam(ctx: RunContext[str]) -> float:
             schema_generator: The JSON schema generator class to use for this tool. Defaults to `GenerateToolJsonSchema`.
             strict: Whether to enforce JSON schema compliance (only affects OpenAI).
                 See [`ToolDefinition`][pydantic_ai.tools.ToolDefinition] for more info.
-            text_format: Used to invoke the function using free-form function calling (only affects OpenAI).
+            text_format: Used to invoke the function using freeform function calling (only affects OpenAI).
                 See [`ToolDefinition`][pydantic_ai.tools.ToolDefinition] for more info.
             requires_approval: Whether this tool requires human-in-the-loop approval. Defaults to False.
                 See the [tools documentation](../deferred-tools.md#human-in-the-loop-tool-approval) for more info.

pydantic_ai_slim/pydantic_ai/models/openai.py

@@ -1024,7 +1024,7 @@ def _map_tool_definition(self, f: ToolDefinition) -> responses.FunctionToolParam
                 )
             if not f.only_takes_string_argument:
                 raise UserError(
-                    f'`{f.name}` is set as a free-form function but does not take a single string argument.'
+                    f'`{f.name}` is set as a freeform function but does not take a single string argument.'
                 )
             if f.text_format == 'text':
                 format: CustomToolInputFormat = {'type': 'text'}

pydantic_ai_slim/pydantic_ai/output.py

@@ -110,7 +110,7 @@ class Vehicle(BaseModel):
     strict: bool | None
     """Whether to use strict mode for the tool."""
     text_format: Literal['text'] | FunctionTextFormat | None = None
-    """Whether to invoke the function with free-form function calling for tool calls."""
+    """Whether to invoke the function with freeform function calling for tool calls."""
 
     def __init__(
         self,

pydantic_ai_slim/pydantic_ai/tools.py

@@ -220,9 +220,9 @@ class DeferredToolResults:
 
 @dataclass
 class FunctionTextFormat:
-    """Used to invoke the function with free-form function calling for tool calls.
+    """Used to invoke the function with freeform function calling for tool calls.
 
-    This class encapsulates the settings related to free-form function calling
+    This class encapsulates the settings related to freeform function calling
     as well as constraining the function call argument to a specific grammar.
     The function must take a single string argument.
 
@@ -232,15 +232,15 @@ class FunctionTextFormat:
     """
 
     syntax: Literal['lark', 'regex']
-    """The syntax type for the grammar to constrain the free-form function call.
+    """The syntax type for the grammar to constrain the freeform function call.
 
     For 'lark' the grammar attribute contains the lark grammar that the text must
     conform to.
     For 'regex' the grammar attribute contains the regex pattern that the text must
     conform to.
     """
     grammar: str
-    """The grammar to constrain the free-form function call.
+    """The grammar to constrain the freeform function call.
 
     When the syntax is 'lark' this attribute contains the lark grammar that the text must
     conform to.
@@ -382,7 +382,7 @@ async def prep_my_tool(
             schema_generator: The JSON schema generator class to use. Defaults to `GenerateToolJsonSchema`.
             strict: Whether to enforce JSON schema compliance (only affects OpenAI).
                 See [`ToolDefinition`][pydantic_ai.tools.ToolDefinition] for more info.
-            text_format: Used to invoke the function using free-form function calling (only affects OpenAI).
+            text_format: Used to invoke the function using freeform function calling (only affects OpenAI).
                 See [`ToolDefinition`][pydantic_ai.tools.ToolDefinition] for more info.
             requires_approval: Whether this tool requires human-in-the-loop approval. Defaults to False.
                 See the [tools documentation](../deferred-tools.md#human-in-the-loop-tool-approval) for more info.
@@ -526,7 +526,7 @@ class ToolDefinition:
     """
 
     text_format: Literal['text'] | FunctionTextFormat | None = None
-    """Whether to invoke the function with free-form function calling for tool calls.
+    """Whether to invoke the function with freeform function calling for tool calls.
 
     Setting this to a format while using a supported model prevents parallel tool calling
     in exchange for passing raw text payloads to your custom tool without wrapping the data in JSON.
@@ -557,7 +557,7 @@ def only_takes_string_argument(self) -> bool:
     @property
     def single_string_argument_name(self) -> str | None:
         # returns the name of the single argument that is a string
-        # used for free-form function calling
+        # used for freeform function calling
         # will return None if there is more or less than one argument,
         # or if the argument is not a string
         schema = self.parameters_json_schema

pydantic_ai_slim/pydantic_ai/toolsets/function.py

@@ -164,7 +164,7 @@ async def spam(ctx: RunContext[str], y: float) -> float:
                 If `None`, the default value is determined by the toolset.
             strict: Whether to enforce JSON schema compliance (only affects OpenAI).
                 See [`ToolDefinition`][pydantic_ai.tools.ToolDefinition] for more info.
-            text_format: Used to invoke the function using free-form function calling (only affects OpenAI).
+            text_format: Used to invoke the function using freeform function calling (only affects OpenAI).
                 See [`ToolDefinition`][pydantic_ai.tools.ToolDefinition] for more info.
             requires_approval: Whether this tool requires human-in-the-loop approval. Defaults to False.
                 See the [tools documentation](../deferred-tools.md#human-in-the-loop-tool-approval) for more info.
@@ -229,7 +229,7 @@ def add_function(
                 If `None`, the default value is determined by the toolset.
             strict: Whether to enforce JSON schema compliance (only affects OpenAI).
                 See [`ToolDefinition`][pydantic_ai.tools.ToolDefinition] for more info.
-            text_format: Used to invoke the function using free-form function calling (only affects OpenAI).
+            text_format: Used to invoke the function using freeform function calling (only affects OpenAI).
                 See [`ToolDefinition`][pydantic_ai.tools.ToolDefinition] for more info.
             requires_approval: Whether this tool requires human-in-the-loop approval. Defaults to False.
                 See the [tools documentation](../deferred-tools.md#human-in-the-loop-tool-approval) for more info.

tests/models/test_openai_responses.py

@@ -1206,7 +1206,7 @@ def test_openai_responses_model_freeform_function_unsupported_model_error():
     # GPT-4 doesn't support freeform function calling
     model = OpenAIResponsesModel('gpt-4o', provider=OpenAIProvider(api_key='foobar'))
 
-    with pytest.raises(UserError, match='uses free-form function calling but gpt-4o does not support'):
+    with pytest.raises(UserError, match='uses freeform function calling but gpt-4o does not support'):
         model._map_tool_definition(freeform_tool)  # type: ignore[reportPrivateUsage]