[Bug]: It does not support OpenAI's new parameter include_usage to retrieve completion token usage at the end of the stream chunk.

[niknir]

Description

[Bug]: It does not support OpenAI's new parameter include_usage to retrieve completion token usage at the end of the stream chunk.

Please support in your SDK.

Steps To Reproduce

$promt = [
                    'model' => $model,
                    'temperature' => $temperature,
                    'response_format' => ["type" => "json_object"],
                    'messages' => [['role' => 'user', 'content' => $prompt]],
                    'stream' => true,
                    'stream_options' => ['include_usage' => true]
                ];
                $stream = OpenAI::chat()->createStreamed($promtLog);

OpenAI PHP Client Version

^0.7.8

PHP Version

8.2

Notes

No response

[iBotPeaches]

➜  openai-php-laravel-test git:(master) ✗ php artisan app:chat-stream-include-usage-test
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"role":"assistant","content":""},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"{\n"},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":" "},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":" \""},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"country"},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"\":"},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":" \""},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"France"},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"\",\n"},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":" "},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":" \""},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"capital"},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"\":"},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":" \""},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"Paris"},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"\"\n"},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":{"content":"}"},"finish_reason":null}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[{"index":0,"delta":[],"finish_reason":"stop"}]}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26
"{"id":"chatcmpl-BjPabsZvkAoZ5IHPbjCCXKDrVF4lD","object":"chat.completion.chunk","created":1750162825,"model":"gpt-4o-mini-2024-07-18","choices":[],"usage":{"prompt_tokens":20,"completion_tokens":16,"total_tokens":36,"prompt_tokens_details":{"cached_tokens":0,"audio_tokens":0},"completion_tokens_details":{"reasoning_tokens":0,"accepted_prediction_tokens":0,"rejected_prediction_tokens":0,"audio_tokens":0}}}" // app/Console/Commands/ChatStreamIncludeUsageTest.php:26

I could not replicate this: https://github.com/iBotPeaches/openai-php-laravel-test/blob/master/app/Console/Commands/ChatStreamIncludeUsageTest.php

I'd say based on your version that you are years out of date. So closing as not reproducible and I urge you to update to a more modern version of the SDK.