refactor(api): rename FunctionObject to FunctionDefinition (#746)

api.md

@@ -1,7 +1,7 @@
 # Shared Types
 
 ```python
-from openai.types import FunctionObject, FunctionParameters
+from openai.types import FunctionDefinition, FunctionParameters
 ```
 
 # Completions

src/openai/types/__init__.py

@@ -5,7 +5,7 @@
 from .edit import Edit as Edit
 from .image import Image as Image
 from .model import Model as Model
-from .shared import FunctionObject as FunctionObject
+from .shared import FunctionDefinition as FunctionDefinition
 from .shared import FunctionParameters as FunctionParameters
 from .embedding import Embedding as Embedding
 from .fine_tune import FineTune as FineTune

src/openai/types/beta/assistant.py

@@ -4,7 +4,7 @@
 from typing import List, Union, Optional
 from typing_extensions import Literal
 
-from ..shared import FunctionObject
+from ..shared import FunctionDefinition
 from ..._models import BaseModel
 
 __all__ = ["Assistant", "Tool", "ToolCodeInterpreter", "ToolRetrieval", "ToolFunction"]
@@ -21,7 +21,7 @@ class ToolRetrieval(BaseModel):
 
 
 class ToolFunction(BaseModel):
-    function: FunctionObject
+    function: FunctionDefinition
 
     type: Literal["function"]
     """The type of tool being defined: `function`"""

src/openai/types/beta/assistant_create_params.py

@@ -73,7 +73,7 @@ class ToolAssistantToolsRetrieval(TypedDict, total=False):
 
 
 class ToolAssistantToolsFunction(TypedDict, total=False):
-    function: Required[shared_params.FunctionObject]
+    function: Required[shared_params.FunctionDefinition]
 
     type: Required[Literal["function"]]
     """The type of tool being defined: `function`"""

src/openai/types/beta/assistant_update_params.py

@@ -75,7 +75,7 @@ class ToolAssistantToolsRetrieval(TypedDict, total=False):
 
 
 class ToolAssistantToolsFunction(TypedDict, total=False):
-    function: Required[shared_params.FunctionObject]
+    function: Required[shared_params.FunctionDefinition]
 
     type: Required[Literal["function"]]
     """The type of tool being defined: `function`"""

src/openai/types/beta/thread_create_and_run_params.py

@@ -112,7 +112,7 @@ class ToolAssistantToolsRetrieval(TypedDict, total=False):
 
 
 class ToolAssistantToolsFunction(TypedDict, total=False):
-    function: Required[shared_params.FunctionObject]
+    function: Required[shared_params.FunctionDefinition]
 
     type: Required[Literal["function"]]
     """The type of tool being defined: `function`"""

src/openai/types/beta/threads/run.py

@@ -4,7 +4,7 @@
 from typing import List, Union, Optional
 from typing_extensions import Literal
 
-from ...shared import FunctionObject
+from ...shared import FunctionDefinition
 from ...._models import BaseModel
 from .required_action_function_tool_call import RequiredActionFunctionToolCall
 
@@ -52,7 +52,7 @@ class ToolAssistantToolsRetrieval(BaseModel):
 
 
 class ToolAssistantToolsFunction(BaseModel):
-    function: FunctionObject
+    function: FunctionDefinition
 
     type: Literal["function"]
     """The type of tool being defined: `function`"""

src/openai/types/beta/threads/run_create_params.py

@@ -64,7 +64,7 @@ class ToolAssistantToolsRetrieval(TypedDict, total=False):
 
 
 class ToolAssistantToolsFunction(TypedDict, total=False):
-    function: Required[shared_params.FunctionObject]
+    function: Required[shared_params.FunctionDefinition]
 
     type: Required[Literal["function"]]
     """The type of tool being defined: `function`"""

src/openai/types/chat/chat_completion_tool_param.py

@@ -10,7 +10,7 @@
 
 
 class ChatCompletionToolParam(TypedDict, total=False):
-    function: Required[shared_params.FunctionObject]
+    function: Required[shared_params.FunctionDefinition]
 
     type: Required[Literal["function"]]
     """The type of the tool. Currently, only `function` is supported."""

src/openai/types/shared/__init__.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless.
 
-from .function_object import FunctionObject as FunctionObject
+from .function_definition import FunctionDefinition as FunctionDefinition
 from .function_parameters import FunctionParameters as FunctionParameters

src/openai/types/shared/function_object.py → src/openai/types/shared/function_definition.py

@@ -5,10 +5,10 @@
 from ..._models import BaseModel
 from .function_parameters import FunctionParameters
 
-__all__ = ["FunctionObject"]
+__all__ = ["FunctionDefinition"]
 
 
-class FunctionObject(BaseModel):
+class FunctionDefinition(BaseModel):
     name: str
     """The name of the function to be called.
 

src/openai/types/shared_params/__init__.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless.
 
-from .function_object import FunctionObject as FunctionObject
+from .function_definition import FunctionDefinition as FunctionDefinition
 from .function_parameters import FunctionParameters as FunctionParameters

src/openai/types/shared_params/function_object.py → src/openai/types/shared_params/function_definition.py

@@ -6,10 +6,10 @@
 
 from ...types import shared_params
 
-__all__ = ["FunctionObject"]
+__all__ = ["FunctionDefinition"]
 
 
-class FunctionObject(TypedDict, total=False):
+class FunctionDefinition(TypedDict, total=False):
     name: Required[str]
     """The name of the function to be called.