Typing: when stream is completed, delta in ChatCompletionChunk from azure openai is None; should be ChoiceDelta
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 31.6k
- Forks
- 5.7k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 96
Description
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
When streaming from azure open ai API the delta of the choice is None. In the python open ai client v1.42.0 delta is type ChoiceDelta i.e. not None.
To Reproduce
Run this code in line with
completion = await self._client.chat.completions.create(
model=self.deployment.name,
messages=cast(list[ChatCompletionMessageParam], messages),
stream=True,
temperature=temperature,
)
async for response_chunk in completion:
...
The types are:
response_chunk: ChatCompletionChunk
response_chunk.choices: list[Choice]
response_chunk.choices[0].delta: ChoiceDelta
The response from azure open ai API returns delta=Nonewhen stream ends
Response example:
Choice(delta=None, finish_reason=None ...........)
Code snippets
No response
OS
linux, ubuntu 20.04
Python version
3.12.1
Library version
openai v 1.42.0
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the async streaming call shown in the issue and inspect ChatCompletionChunk, Choice, and ChoiceDelta handling for the final Azure OpenAI chunk. Verify that a completed stream produces a ChoiceDelta rather than delta=None, while preserving the expected completion response behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 40/100