Skip to content

fix: properly handle extra_body parameter in completions API #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VisargD merged 2 commits into from
Nov 25, 2025
Merged

fix: properly handle extra_body parameter in completions API #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b720d59
fix: properly handle extra_body parameter in completions API
roh26it Nov 25, 2025
1d9c53e
refactor: simplify extra_body passing per review feedback
roh26it Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 32 additions & 8 deletions portkey_ai/api_resources/apis/chat_complete.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,11 @@ def stream_create( # type: ignore[return]
store,
**kwargs,
) -> Union[ChatCompletions, Iterator[ChatCompletionChunk]]:
extra_headers = kwargs.get("extra_headers", {})
extra_headers = kwargs.pop("extra_headers", None)
extra_query = kwargs.pop("extra_query", None)
timeout = kwargs.pop("timeout", None)
user_extra_body = kwargs.pop("extra_body", None) or {}
Copy link

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using or {} after pop() will replace {} (falsy empty dict) with {}, but more critically, it will replace None with {} which masks the distinction. If the intent is to treat missing extra_body differently from explicit extra_body=None, this logic is incorrect. If extra_body={} is passed explicitly, it becomes falsy and gets replaced with a new empty dict. Consider using if user_extra_body is None: user_extra_body = {} or kwargs.pop('extra_body', {}) instead.

Suggested change
user_extra_body = kwargs.pop("extra_body", None) or {}
user_extra_body = kwargs.pop("extra_body", {})

Copilot uses AI. Check for mistakes.
merged_extra_body = {**user_extra_body, **kwargs}
return self.openai_client.chat.completions.create(
model=model,
messages=messages,
Expand All @@ -90,7 +94,9 @@ def stream_create( # type: ignore[return]
reasoning_effort=reasoning_effort,
store=store,
extra_headers=extra_headers,
extra_body=kwargs,
extra_query=extra_query,
extra_body=merged_extra_body,
timeout=timeout,
)

def normal_create(
Expand All @@ -110,7 +116,11 @@ def normal_create(
store,
**kwargs,
) -> ChatCompletions:
extra_headers = kwargs.get("extra_headers", {})
extra_headers = kwargs.pop("extra_headers", None)
extra_query = kwargs.pop("extra_query", None)
timeout = kwargs.pop("timeout", None)
user_extra_body = kwargs.pop("extra_body", None) or {}
merged_extra_body = {**user_extra_body, **kwargs}
response = self.openai_client.with_raw_response.chat.completions.create(
model=model,
messages=messages,
Expand All @@ -126,7 +136,9 @@ def normal_create(
reasoning_effort=reasoning_effort,
store=store,
extra_headers=extra_headers,
extra_body=kwargs,
extra_query=extra_query,
extra_body=merged_extra_body,
timeout=timeout,
)
data = ChatCompletions(**json.loads(response.text))
data._headers = response.headers
Expand Down Expand Up @@ -472,7 +484,11 @@ async def stream_create(
store,
**kwargs,
) -> Union[ChatCompletions, AsyncIterator[ChatCompletionChunk]]:
extra_headers = kwargs.get("extra_headers", {})
extra_headers = kwargs.pop("extra_headers", None)
extra_query = kwargs.pop("extra_query", None)
timeout = kwargs.pop("timeout", None)
user_extra_body = kwargs.pop("extra_body", None) or {}
merged_extra_body = {**user_extra_body, **kwargs}
return await self.openai_client.chat.completions.create(
model=model,
messages=messages,
Expand All @@ -488,7 +504,9 @@ async def stream_create(
reasoning_effort=reasoning_effort,
store=store,
extra_headers=extra_headers,
extra_body=kwargs,
extra_query=extra_query,
extra_body=merged_extra_body,
timeout=timeout,
)

async def normal_create(
Expand All @@ -508,7 +526,11 @@ async def normal_create(
store,
**kwargs,
) -> ChatCompletions:
extra_headers = kwargs.get("extra_headers", {})
extra_headers = kwargs.pop("extra_headers", None)
extra_query = kwargs.pop("extra_query", None)
timeout = kwargs.pop("timeout", None)
user_extra_body = kwargs.pop("extra_body", None) or {}
merged_extra_body = {**user_extra_body, **kwargs}
response = await self.openai_client.with_raw_response.chat.completions.create(
model=model,
messages=messages,
Expand All @@ -524,7 +546,9 @@ async def normal_create(
reasoning_effort=reasoning_effort,
store=store,
extra_headers=extra_headers,
extra_body=kwargs,
extra_query=extra_query,
extra_body=merged_extra_body,
timeout=timeout,
)
data = ChatCompletions(**json.loads(response.text))
data._headers = response.headers
Expand Down
40 changes: 36 additions & 4 deletions portkey_ai/api_resources/apis/complete.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ def stream_create( # type: ignore[return]
stream_options,
**kwargs,
) -> Union[TextCompletion, Iterator[TextCompletionChunk]]:
extra_headers = kwargs.pop("extra_headers", None)
extra_query = kwargs.pop("extra_query", None)
timeout = kwargs.pop("timeout", None)
user_extra_body = kwargs.pop("extra_body", None) or {}
Copy link

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using or {} after pop() will replace {} (falsy empty dict) with {}, but more critically, it will replace None with {} which masks the distinction. If the intent is to treat missing extra_body differently from explicit extra_body=None, this logic is incorrect. If extra_body={} is passed explicitly, it becomes falsy and gets replaced with a new empty dict. Consider using if user_extra_body is None: user_extra_body = {} or kwargs.pop('extra_body', {}) instead.

Suggested change
user_extra_body = kwargs.pop("extra_body", None) or {}
user_extra_body = kwargs.pop("extra_body", None)
if user_extra_body is None:
user_extra_body = {}

Copilot uses AI. Check for mistakes.
merged_extra_body = {**user_extra_body, **kwargs}
return self.openai_client.completions.create(
model=model,
prompt=prompt,
Expand All @@ -58,7 +63,10 @@ def stream_create( # type: ignore[return]
suffix=suffix,
user=user,
stream_options=stream_options,
extra_body=kwargs,
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=merged_extra_body,
timeout=timeout,
)

def normal_create(
Expand All @@ -83,6 +91,11 @@ def normal_create(
stream_options,
**kwargs,
) -> TextCompletion:
extra_headers = kwargs.pop("extra_headers", None)
extra_query = kwargs.pop("extra_query", None)
timeout = kwargs.pop("timeout", None)
user_extra_body = kwargs.pop("extra_body", None) or {}
merged_extra_body = {**user_extra_body, **kwargs}
response = self.openai_client.with_raw_response.completions.create(
model=model,
prompt=prompt,
Expand All @@ -102,7 +115,10 @@ def normal_create(
suffix=suffix,
user=user,
stream_options=stream_options,
extra_body=kwargs,
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=merged_extra_body,
timeout=timeout,
)
data = TextCompletion(**json.loads(response.text))
data._headers = response.headers
Expand Down Expand Up @@ -206,6 +222,11 @@ async def stream_create(
stream_options,
**kwargs,
) -> Union[TextCompletion, AsyncIterator[TextCompletionChunk]]:
extra_headers = kwargs.pop("extra_headers", None)
extra_query = kwargs.pop("extra_query", None)
timeout = kwargs.pop("timeout", None)
user_extra_body = kwargs.pop("extra_body", None) or {}
merged_extra_body = {**user_extra_body, **kwargs}
return await self.openai_client.completions.create(
model=model,
prompt=prompt,
Expand All @@ -225,7 +246,10 @@ async def stream_create(
suffix=suffix,
user=user,
stream_options=stream_options,
extra_body=kwargs,
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=merged_extra_body,
timeout=timeout,
)

async def normal_create(
Expand All @@ -250,6 +274,11 @@ async def normal_create(
stream_options,
**kwargs,
) -> TextCompletion:
extra_headers = kwargs.pop("extra_headers", None)
extra_query = kwargs.pop("extra_query", None)
timeout = kwargs.pop("timeout", None)
user_extra_body = kwargs.pop("extra_body", None) or {}
merged_extra_body = {**user_extra_body, **kwargs}
response = await self.openai_client.with_raw_response.completions.create(
model=model,
prompt=prompt,
Expand All @@ -269,7 +298,10 @@ async def normal_create(
suffix=suffix,
user=user,
stream_options=stream_options,
extra_body=kwargs,
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=merged_extra_body,
timeout=timeout,
)
data = TextCompletion(**json.loads(response.text))
data._headers = response.headers
Expand Down
Loading