docs/types: clarify abort flow, zod schema limits, file batch args, and files.content response type#1822
Open
however-yir wants to merge 1 commit intoopenai:masterfrom
Open
Conversation
…es.content response
Author
|
Hi maintainers, friendly ping for review when convenient. This PR addresses #996, #1337, #1017, and #958 by:
Scope is docs/types only (no API behavior changes). I couldn’t run repo lint locally in this environment because dependencies were not installed. Happy to revise quickly if you prefer a different wording or scope. |
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
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.
Summary
Abort on a function callhelper example and document expected behavior after intentional abortsvectorStores.fileBatches.uploadAndPollusage with{ files: ... }files.content()usage docs in README showingResponse.text()/Response.arrayBuffer()FileContenttype alias with runtime behavior (Response)Issues addressed
Abort on a function callexample is confusing #996openai.files.contentreturns raw Response object #958Testing