diff --git a/api.md b/api.md index 0f5cdbbbbf..e0237803de 100644 --- a/api.md +++ b/api.md @@ -1,7 +1,7 @@ # Shared Types ```python -from openai.types import FunctionObject, FunctionParameters +from openai.types import FunctionDefinition, FunctionParameters ``` # Completions diff --git a/src/openai/types/__init__.py b/src/openai/types/__init__.py index 5840599a27..1b4fca26ee 100644 --- a/src/openai/types/__init__.py +++ b/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 diff --git a/src/openai/types/beta/assistant.py b/src/openai/types/beta/assistant.py index 63332123c0..a21206765a 100644 --- a/src/openai/types/beta/assistant.py +++ b/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`""" diff --git a/src/openai/types/beta/assistant_create_params.py b/src/openai/types/beta/assistant_create_params.py index ce7494efec..539897a7ba 100644 --- a/src/openai/types/beta/assistant_create_params.py +++ b/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`""" diff --git a/src/openai/types/beta/assistant_update_params.py b/src/openai/types/beta/assistant_update_params.py index 07a186a0d2..a0efd96ecd 100644 --- a/src/openai/types/beta/assistant_update_params.py +++ b/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`""" diff --git a/src/openai/types/beta/thread_create_and_run_params.py b/src/openai/types/beta/thread_create_and_run_params.py index 8e6b33249c..9f58dcd875 100644 --- a/src/openai/types/beta/thread_create_and_run_params.py +++ b/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`""" diff --git a/src/openai/types/beta/threads/run.py b/src/openai/types/beta/threads/run.py index 59a443f75b..ffbba1e504 100644 --- a/src/openai/types/beta/threads/run.py +++ b/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`""" diff --git a/src/openai/types/beta/threads/run_create_params.py b/src/openai/types/beta/threads/run_create_params.py index 27e5a86a8e..df92f4fd2c 100644 --- a/src/openai/types/beta/threads/run_create_params.py +++ b/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`""" diff --git a/src/openai/types/chat/chat_completion_tool_param.py b/src/openai/types/chat/chat_completion_tool_param.py index 97e73f17ce..54c223955e 100644 --- a/src/openai/types/chat/chat_completion_tool_param.py +++ b/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.""" diff --git a/src/openai/types/shared/__init__.py b/src/openai/types/shared/__init__.py index ab67c41471..05bc4ff9ba 100644 --- a/src/openai/types/shared/__init__.py +++ b/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 diff --git a/src/openai/types/shared/function_object.py b/src/openai/types/shared/function_definition.py similarity index 93% rename from src/openai/types/shared/function_object.py rename to src/openai/types/shared/function_definition.py index f566fe530d..bfcee50c85 100644 --- a/src/openai/types/shared/function_object.py +++ b/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. diff --git a/src/openai/types/shared_params/__init__.py b/src/openai/types/shared_params/__init__.py index ab67c41471..05bc4ff9ba 100644 --- a/src/openai/types/shared_params/__init__.py +++ b/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 diff --git a/src/openai/types/shared_params/function_object.py b/src/openai/types/shared_params/function_definition.py similarity index 92% rename from src/openai/types/shared_params/function_object.py rename to src/openai/types/shared_params/function_definition.py index d3f5d0aaf4..6bb6fa6ff2 100644 --- a/src/openai/types/shared_params/function_object.py +++ b/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.