docs(files): clarify files.content returns Response object #1672
+63
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated JSDoc for files.content() to explicitly document that it returns a Response object and provide examples showing how to consume the content using .text(), .blob(), or .arrayBuffer(). Fixes openai#958
suaysaimd
approved these changes
Oct 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes being requested
Updated documentation for
openai.files.content()to clarify that it returns aResponseobject, not raw file content. The previous JSDoc comment was ambiguous, leading users to expect file content directly.What changed:
.text(),.blob(), and.arrayBuffer()consumption methodsFiles modified:
src/resources/files.ts- Updated JSDoc (lines 66-85)examples/file-content-retrieval.ts- New example file (NEW)Additional context & links
This addresses the 15-month-old issue #958 where users were confused about the return type. The fix follows the exact pattern established in
src/resources/audio/speech.tsfor documenting Response-returning methods.Validation:
Fixes #958
Note: I understand that this repository is auto-generated and my pull request may not be merged. However, this documentation enhancement provides immediate value to users and follows the established patterns in the codebase. The
examples/directory is protected from generator overwrites, ensuring the example file persists.