Skip to content

langchain-openai: support custom fallback content for tool-only messages #30803

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.

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

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
22 changes: 12 additions & 10 deletions libs/partners/openai/langchain_openai/chat_models/base.py
Original file line number Diff line number Diff line change
@@ -10,7 +10,6 @@
import ssl
import sys
import warnings
from collections.abc import AsyncIterator, Iterator, Mapping, Sequence
from functools import partial
from io import BytesIO
from json import JSONDecodeError
@@ -112,7 +111,7 @@
_FUNCTION_CALL_IDS_MAP_KEY = "__openai_function_call_ids__"


def _convert_dict_to_message(_dict: Mapping[str, Any]) -> BaseMessage:

Check failure on line 114 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.9

Ruff (F821)

langchain_openai/chat_models/base.py:114:37: F821 Undefined name `Mapping`

Check failure on line 114 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.13

Ruff (F821)

langchain_openai/chat_models/base.py:114:37: F821 Undefined name `Mapping`
"""Convert a dictionary to a LangChain message.

Args:
@@ -227,7 +226,7 @@
return formatted_content


def _convert_message_to_dict(message: BaseMessage) -> dict:
def _convert_message_to_dict(message: BaseMessage, content_null_value: Optional[str] = None) -> dict:

Check failure on line 229 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.9

Ruff (E501)

langchain_openai/chat_models/base.py:229:89: E501 Line too long (101 > 88)

Check failure on line 229 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.13

Ruff (E501)

langchain_openai/chat_models/base.py:229:89: E501 Line too long (101 > 88)
"""Convert a LangChain message to a dictionary.

Args:
@@ -267,7 +266,7 @@
pass
# If tool calls present, content null value should be None not empty string.
if "function_call" in message_dict or "tool_calls" in message_dict:
message_dict["content"] = message_dict["content"] or None
message_dict["content"] = message_dict["content"] or content_null_value

if "audio" in message.additional_kwargs:
# openai doesn't support passing the data back - only the id
@@ -297,7 +296,7 @@


def _convert_delta_to_message_chunk(
_dict: Mapping[str, Any], default_class: type[BaseMessageChunk]

Check failure on line 299 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.9

Ruff (F821)

langchain_openai/chat_models/base.py:299:12: F821 Undefined name `Mapping`

Check failure on line 299 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.13

Ruff (F821)

langchain_openai/chat_models/base.py:299:12: F821 Undefined name `Mapping`
) -> BaseMessageChunk:
id_ = _dict.get("id")
role = cast(str, _dict.get("role"))
@@ -499,8 +498,8 @@
when using one of the many model providers that expose an OpenAI-like
API but with different models. In those cases, in order to avoid erroring
when tiktoken is called, you can specify a model name to use here."""
default_headers: Union[Mapping[str, str], None] = None

Check failure on line 501 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.9

Ruff (F821)

langchain_openai/chat_models/base.py:501:28: F821 Undefined name `Mapping`

Check failure on line 501 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.13

Ruff (F821)

langchain_openai/chat_models/base.py:501:28: F821 Undefined name `Mapping`
default_query: Union[Mapping[str, object], None] = None

Check failure on line 502 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.9

Ruff (F821)

langchain_openai/chat_models/base.py:502:26: F821 Undefined name `Mapping`

Check failure on line 502 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.13

Ruff (F821)

langchain_openai/chat_models/base.py:502:26: F821 Undefined name `Mapping`
# Configure a custom httpx client. See the
# [httpx documentation](https://www.python-httpx.org/api/#client) for more details.
http_client: Union[Any, None] = Field(default=None, exclude=True)
@@ -512,7 +511,7 @@
http_client as well if you'd like a custom client for sync invocations."""
stop: Optional[Union[list[str], str]] = Field(default=None, alias="stop_sequences")
"""Default stop sequences."""
extra_body: Optional[Mapping[str, Any]] = None

Check failure on line 514 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.9

Ruff (F821)

langchain_openai/chat_models/base.py:514:26: F821 Undefined name `Mapping`

Check failure on line 514 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.13

Ruff (F821)

langchain_openai/chat_models/base.py:514:26: F821 Undefined name `Mapping`
"""Optional additional JSON properties to include in the request parameters when
making requests to OpenAI compatible APIs, such as vLLM."""
include_response_headers: bool = False
@@ -542,6 +541,9 @@

.. versionadded:: 0.3.9
"""

content_null_value: Optional[str] = None
"""The value to use for content when it is null. Should be set to some non-empty string for Gemini API for example."""

Check failure on line 546 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.9

Ruff (E501)

langchain_openai/chat_models/base.py:546:89: E501 Line too long (122 > 88)

Check failure on line 546 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.13

Ruff (E501)

langchain_openai/chat_models/base.py:546:89: E501 Line too long (122 > 88)

model_config = ConfigDict(populate_by_name=True)

@@ -746,7 +748,7 @@
stop: Optional[list[str]] = None,
run_manager: Optional[CallbackManagerForLLMRun] = None,
**kwargs: Any,
) -> Iterator[ChatGenerationChunk]:

Check failure on line 751 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.9

Ruff (F821)

langchain_openai/chat_models/base.py:751:10: F821 Undefined name `Iterator`

Check failure on line 751 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.13

Ruff (F821)

langchain_openai/chat_models/base.py:751:10: F821 Undefined name `Iterator`
kwargs["stream"] = True
payload = self._get_request_payload(messages, stop=stop, **kwargs)
if self.include_response_headers:
@@ -780,7 +782,7 @@
stop: Optional[list[str]] = None,
run_manager: Optional[AsyncCallbackManagerForLLMRun] = None,
**kwargs: Any,
) -> AsyncIterator[ChatGenerationChunk]:

Check failure on line 785 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.9

Ruff (F821)

langchain_openai/chat_models/base.py:785:10: F821 Undefined name `AsyncIterator`

Check failure on line 785 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.13

Ruff (F821)

langchain_openai/chat_models/base.py:785:10: F821 Undefined name `AsyncIterator`
kwargs["stream"] = True
payload = self._get_request_payload(messages, stop=stop, **kwargs)
if self.include_response_headers:
@@ -837,7 +839,7 @@
*,
stream_usage: Optional[bool] = None,
**kwargs: Any,
) -> Iterator[ChatGenerationChunk]:

Check failure on line 842 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.9

Ruff (F821)

langchain_openai/chat_models/base.py:842:10: F821 Undefined name `Iterator`

Check failure on line 842 in libs/partners/openai/langchain_openai/chat_models/base.py

GitHub Actions / cd libs/partners/openai / make lint #3.13

Ruff (F821)

langchain_openai/chat_models/base.py:842:10: F821 Undefined name `Iterator`
kwargs["stream"] = True
stream_usage = self._should_stream_usage(stream_usage, **kwargs)
if stream_usage:
@@ -967,9 +969,9 @@

payload = {**self._default_params, **kwargs}
if self._use_responses_api(payload):
payload = _construct_responses_api_payload(messages, payload)
payload = _construct_responses_api_payload(messages, payload, content_null_value=self.content_null_value)
else:
payload["messages"] = [_convert_message_to_dict(m) for m in messages]
payload["messages"] = [_convert_message_to_dict(m, content_null_value=self.content_null_value) for m in messages]
return payload

def _create_chat_result(
@@ -1261,7 +1263,7 @@
" for information on how messages are converted to tokens."
)
num_tokens = 0
messages_dict = [_convert_message_to_dict(m) for m in messages]
messages_dict = [_convert_message_to_dict(m, content_null_value=self.content_null_value) for m in messages]
for message in messages_dict:
num_tokens += tokens_per_message
for key, value in message.items():
@@ -2924,7 +2926,7 @@


def _construct_responses_api_payload(
messages: Sequence[BaseMessage], payload: dict
messages: Sequence[BaseMessage], payload: dict, content_null_value: Optional[str] = None
) -> dict:
# Rename legacy parameters
for legacy_token_param in ["max_tokens", "max_completion_tokens"]:
@@ -2933,7 +2935,7 @@
if "reasoning_effort" in payload:
payload["reasoning"] = {"effort": payload.pop("reasoning_effort")}

payload["input"] = _construct_responses_api_input(messages)
payload["input"] = _construct_responses_api_input(messages, content_null_value=content_null_value)
if tools := payload.pop("tools", None):
new_tools: list = []
for tool in tools:
@@ -3014,10 +3016,10 @@
return computer_call_output


def _construct_responses_api_input(messages: Sequence[BaseMessage]) -> list:
def _construct_responses_api_input(messages: Sequence[BaseMessage], content_null_value: Optional[str] = None) -> list:
input_ = []
for lc_msg in messages:
msg = _convert_message_to_dict(lc_msg)
msg = _convert_message_to_dict(lc_msg, content_null_value=content_null_value)
# "name" parameter unsupported
if "name" in msg:
msg.pop("name")