Skip to content

Clarify index docstring for AnnotationFileCitation and AnnotationFilePath (GH#2512) #2594

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

Clarify index docstring for AnnotationFileCitation and AnnotationFilePath (GH#2512) #2594

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a7aef9
Clarify index docstring for AnnotationFilePath and AnnotationFileCita…
Aniketsy Aug 30, 2025
87ca5d5
Clarify index docstring for AnnotationFilePath and AnnotationFileCita…
Aniketsy Aug 30, 2025
ce5e78a
Clarify index docstring for AnnotationFilePath and AnnotationFileCita…
Aniketsy Aug 30, 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
4 changes: 2 additions & 2 deletions src/openai/types/responses/response_output_text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class AnnotationFileCitation(BaseModel):
"""The filename of the file cited."""

index: int
"""The index of the file in the list of files."""
"""The index at which to insert the file citation in the message text (zero-based character index)."""

type: Literal["file_citation"]
"""The type of the file citation. Always `file_citation`."""
Expand Down Expand Up @@ -74,7 +74,7 @@ class AnnotationFilePath(BaseModel):
"""The ID of the file."""

index: int
"""The index of the file in the list of files."""
"""The index at which to insert the file path annotation in the message text (zero-based character index)."""

type: Literal["file_path"]
"""The type of the file path. Always `file_path`."""
Expand Down