Regression: ChatCompletionToolParam no longer a valid type in 1.99.2

[markbackman]

Confirm this is an issue with the Python library and not an underlying OpenAI API

• This is an issue with the Python library

Describe the bug

This bug fix commit introduces a breaking change in 1.99.2:
657f551

Use of the previous type ChatCompletionToolParam emits an error:

error processing frame: Cannot instantiate typing.Union

Rather than break, can their be a migration path to the new ChatCompletionFunctionToolParam type?

To Reproduce

Define a tool as:

    tools = [
        ChatCompletionToolParam(
            type="function",
            function={
                "name": "switch_voice",
                "description": "Switch your voice only when the user asks you to",
                "parameters": {
                    "type": "object",
                    "properties": {
                        "voice": {
                            "type": "string",
                            "description": "The voice the user wants you to use",
                        },
                    },
                    "required": ["voice"],
                },
            },
        )
    ]

Run application using this tool definition.

Code snippets

OS

macOS

Python version

Python 3.12.8

Library version

1.99.2

[rattrayalex]

Hi, thanks for reporting this. We recognize this is not great. It's trickier than one might expect to resolve; your patience is appreciated as we investigate.

[gabrielkoo]

It was refactored for a new custom tool a simple (dirty) trick for now would be to change your import from

from openai.types.chat import ChatCompletionToolParam

to

from openai.types.chat import (
    ChatCompletionFunctionToolParam as ChatCompletionToolParam,
)

openai-python/src/openai/types/chat/chat_completion_tool_param.py

Lines 8 to 13 in e4ec91e

	from .chat_completion_custom_tool_param import ChatCompletionCustomToolParam
	from .chat_completion_function_tool_param import ChatCompletionFunctionToolParam
	__all__ = ["ChatCompletionToolParam"]
	ChatCompletionToolParam: TypeAlias = Union[ChatCompletionFunctionToolParam, ChatCompletionCustomToolParam]

[RobertCraigie]

Thanks for the report and sorry for the regression, this will be fixed in 1.99.4 - #2531

[markbackman]

Thanks @RobertCraigie 🙌

This looks great!

ChatCompletionToolUnionParam: TypeAlias = Union[ChatCompletionFunctionToolParam, ChatCompletionCustomToolParam]

Appreciate the quick fix!

[RobertCraigie]

1.99.4 has been released!