Skip to content

fix(openai): Read input_text parts for the Responses API #7333

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

Open
alexander-alderman-webb wants to merge 4 commits into from
Open

fix(openai): Read input_text parts for the Responses API #7333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
66c95ec
fix(openai): Read input_text parts for the Responses API
alexander-alderman-webb Sep 2, 2026
a815206
.
alexander-alderman-webb Sep 2, 2026
b698b74
Merge branch 'master' into webb/openai/fix-responses-instructions
alexander-alderman-webb Sep 2, 2026
558362b
adapt openai agents as well
alexander-alderman-webb Sep 2, 2026
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
38 changes: 36 additions & 2 deletions sentry_sdk/ai/_openai_responses_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
from typing import TYPE_CHECKING, Iterable
from typing import TYPE_CHECKING, Iterable, cast

if TYPE_CHECKING:
from typing import Iterable, Union

from openai.types.responses import (
ResponseInputItemParam,
ResponseInputParam,
ResponseInputTextParam,
ToolParam,
)
from openai.types.responses.easy_input_message_param import EasyInputMessageParam
from openai.types.responses.response_input_item_param import Message

from sentry_sdk._types import ToolDefinition
from sentry_sdk._types import TextPart, ToolDefinition


def _is_system_instruction(message: "ResponseInputItemParam") -> bool:
Expand All @@ -28,6 +31,37 @@ def _get_system_instructions(
return [message for message in messages if _is_system_instruction(message)]


def _transform_system_instructions(
system_instructions: "list[Union[EasyInputMessageParam, Message]]",
) -> "list[TextPart]":
instruction_text_parts: "list[TextPart]" = []

for instruction in system_instructions:
if not isinstance(instruction, dict):
continue

content = instruction.get("content")
if content is None:
continue

if isinstance(content, str):
instruction_text_parts.append({"type": "text", "content": content})
continue

if not isinstance(content, Iterable):
continue

for part in content:
if not isinstance(part, dict) or part.get("type") != "input_text":
continue

text = cast("ResponseInputTextParam", part).get("text", None)
if text is not None:
instruction_text_parts.append({"type": "text", "content": text})

return instruction_text_parts
Comment thread
alexander-alderman-webb marked this conversation as resolved.


def _transform_tool_definitions(tools: "Iterable[ToolParam]") -> "list[ToolDefinition]":
"""
Transform tool definitions to the schema used by the "gen_ai.tool.definitions" attribute.
Expand Down
15 changes: 10 additions & 5 deletions sentry_sdk/integrations/openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
)
from sentry_sdk.ai._openai_completions_api import (
_get_text_items,
_transform_system_instructions,
)
from sentry_sdk.ai._openai_completions_api import (
_is_system_instruction as _is_system_instruction_completions,
)
from sentry_sdk.ai._openai_completions_api import (
_transform_system_instructions as _transform_system_instructions_completions,
)
from sentry_sdk.ai._openai_completions_api import (
_transform_tool_definitions as _transform_tool_definitions_completions,
)
Expand All @@ -26,6 +28,9 @@
from sentry_sdk.ai._openai_responses_api import (
_is_system_instruction as _is_system_instruction_responses,
)
from sentry_sdk.ai._openai_responses_api import (
_transform_system_instructions as _transform_system_instructions_responses,
)
from sentry_sdk.ai._openai_responses_api import (
_transform_tool_definitions as _transform_tool_definitions_responses,
)
Expand Down Expand Up @@ -428,9 +433,9 @@ def _set_responses_api_input_data(
)

system_instructions = _get_system_instructions_responses(messages)
# Deliberate use of function accepting completions API type because
# of shared structure FOR THIS PURPOSE ONLY.
instructions_text_parts += _transform_system_instructions(system_instructions)
instructions_text_parts += _transform_system_instructions_responses(
system_instructions
)
if len(instructions_text_parts) > 0:
set_on_span(
SPANDATA.GEN_AI_SYSTEM_INSTRUCTIONS,
Expand Down Expand Up @@ -570,7 +575,7 @@ def _set_completions_api_input_data(
if len(system_instructions) > 0:
set_on_span(
SPANDATA.GEN_AI_SYSTEM_INSTRUCTIONS,
json.dumps(_transform_system_instructions(system_instructions)),
json.dumps(_transform_system_instructions_completions(system_instructions)),
)

non_system_messages = [
Expand Down
4 changes: 1 addition & 3 deletions sentry_sdk/integrations/openai_agents/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
from typing import TYPE_CHECKING

import sentry_sdk
from sentry_sdk.ai._openai_completions_api import _transform_system_instructions
from sentry_sdk.ai._openai_responses_api import (
_get_system_instructions,
_is_system_instruction,
_transform_system_instructions,
)
from sentry_sdk.ai.utils import (
GEN_AI_ALLOWED_MESSAGE_ROLES,
Expand Down Expand Up @@ -140,8 +140,6 @@ def _set_input_data(

system_instructions = _get_system_instructions(messages)

# Deliberate use of function accepting completions API type because
# of shared structure FOR THIS PURPOSE ONLY.
instructions_text_parts += _transform_system_instructions(system_instructions)

if len(instructions_text_parts) > 0:
Expand Down
24 changes: 12 additions & 12 deletions tests/integrations/openai/test_openai.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5466,8 +5466,8 @@ def test_ai_client_span_responses_tool_definitions(
{
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
{"type": "input_text", "text": "You are a helpful assistant."},
{"type": "input_text", "text": "Be concise and clear."},
],
},
{
Expand Down Expand Up @@ -5499,8 +5499,8 @@ def test_ai_client_span_responses_tool_definitions(
"type": "message",
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
{"type": "input_text", "text": "You are a helpful assistant."},
{"type": "input_text", "text": "Be concise and clear."},
],
},
{
Expand Down Expand Up @@ -6586,8 +6586,8 @@ def test_error_in_responses_api(
{
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
{"type": "input_text", "text": "You are a helpful assistant."},
{"type": "input_text", "text": "Be concise and clear."},
],
},
{
Expand Down Expand Up @@ -6619,8 +6619,8 @@ def test_error_in_responses_api(
"type": "message",
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
{"type": "input_text", "text": "You are a helpful assistant."},
{"type": "input_text", "text": "Be concise and clear."},
],
},
{
Expand Down Expand Up @@ -6901,8 +6901,8 @@ async def test_ai_client_span_responses_async_api(
{
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
{"type": "input_text", "text": "You are a helpful assistant."},
{"type": "input_text", "text": "Be concise and clear."},
],
},
{
Expand Down Expand Up @@ -6934,8 +6934,8 @@ async def test_ai_client_span_responses_async_api(
"type": "message",
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
{"type": "input_text", "text": "You are a helpful assistant."},
{"type": "input_text", "text": "Be concise and clear."},
],
},
{
Expand Down
16 changes: 8 additions & 8 deletions tests/integrations/openai_agents/test_openai_agents.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1453,8 +1453,8 @@ async def test_data_collection_outputs(
{
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
{"type": "input_text", "text": "You are a helpful assistant."},
{"type": "input_text", "text": "Be concise and clear."},
],
},
{
Expand Down Expand Up @@ -1494,8 +1494,8 @@ async def test_data_collection_outputs(
"type": "message",
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
{"type": "input_text", "text": "You are a helpful assistant."},
{"type": "input_text", "text": "Be concise and clear."},
],
},
{
Expand Down Expand Up @@ -2160,8 +2160,8 @@ def test_agent_invocation_span_sync_no_pii(
{
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
{"type": "input_text", "text": "You are a helpful assistant."},
{"type": "input_text", "text": "Be concise and clear."},
],
},
{
Expand Down Expand Up @@ -2201,8 +2201,8 @@ def test_agent_invocation_span_sync_no_pii(
"type": "message",
"role": "system",
"content": [
{"type": "text", "text": "You are a helpful assistant."},
{"type": "text", "text": "Be concise and clear."},
{"type": "input_text", "text": "You are a helpful assistant."},
{"type": "input_text", "text": "Be concise and clear."},
],
},
{
Expand Down
Loading