Skip to content

fix: type response output text annotation events #3467

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
nightcityblade wants to merge 2 commits into
base: main
Choose a base branch
from
+29 −2
Open

fix: type response output text annotation events #3467

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8e04a2
fix: type response output text annotation events
Jul 3, 2026
c5c6a36
fix: use version-neutral parser in annotation event test
Jul 4, 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
3 changes: 2 additions & 1 deletion src/openai/types/responses/response_output_text_annotation_added_event.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@
from typing_extensions import Literal

from ..._models import BaseModel
from .response_output_text import Annotation

__all__ = ["ResponseOutputTextAnnotationAddedEvent"]


class ResponseOutputTextAnnotationAddedEvent(BaseModel):
"""Emitted when an annotation is added to output text content."""

annotation: object
annotation: Annotation
"""The annotation object being added. (See annotation schema for details.)"""

annotation_index: int
Expand Down
25 changes: 25 additions & 0 deletions tests/test_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
from openai._utils import PropertyInfo
from openai._compat import PYDANTIC_V1, parse_obj, model_dump, model_json
from openai._models import DISCRIMINATOR_CACHE, BaseModel, construct_type
from openai.types.responses import ResponseOutputTextAnnotationAddedEvent
from openai.types.responses.response_output_text import AnnotationURLCitation


class BasicModel(BaseModel):
Expand Down Expand Up @@ -961,3 +963,26 @@ def __getattr__(self, attr: str) -> Item: ...
assert model.a.prop == 1
assert isinstance(model.a, Item)
assert model.other == "foo"


def test_response_output_text_annotation_added_event_uses_annotation_union() -> None:
event = ResponseOutputTextAnnotationAddedEvent.model_validate(

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 3, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Use the pydantic-version-neutral parser

This new test is run in the repo's Pydantic v1 job (scripts/test invokes nox -s test-pydantic-v1, and noxfile.py installs pydantic<2), but model_validate only exists on Pydantic v2 models and this project only shims dump methods on its v1 BaseModel. Under the v1 test job this line raises AttributeError before exercising the regression; use the already imported _compat.parse_obj/model_parse helper or skip the test for PYDANTIC_V1.

Useful? React with 👍 / 👎.

{
"annotation": {
"type": "url_citation",
"title": "Example",
"url": "https://example.com",
"start_index": 0,
"end_index": 7,
},
"annotation_index": 0,
"content_index": 0,
"item_id": "item_123",
"output_index": 0,
"sequence_number": 1,
"type": "response.output_text.annotation.added",
}
)

assert isinstance(event.annotation, AnnotationURLCitation)
assert event.annotation.url == "https://example.com"