Change8

v2.0.0

Breaking Changes
📦 openai-python-sdk
1 breaking2 features🔧 3 symbols

Summary

This major release introduces support for multi-modal function call outputs (images and files) and BatchUsage, while changing the output type of tool call response items from string to a union type.

⚠️ Breaking Changes

  • ResponseFunctionToolCallOutputItem.output and ResponseCustomToolCallOutput.output now return a union type (string | Array<ResponseInputText | ResponseInputImage | ResponseInputFile>) instead of a plain string. Code assuming a string return type will fail.

Migration Steps

  1. Update logic handling ResponseFunctionToolCallOutputItem.output and ResponseCustomToolCallOutput.output to check if the value is a string or an array of input objects before processing.

✨ New Features

  • Added support for images and files for function call outputs in responses.
  • Added BatchUsage support.

🔧 Affected Symbols

ResponseFunctionToolCallOutputItem.outputResponseCustomToolCallOutput.outputBatchUsage