Skip to content

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
however-yir:fix-doc-issues-996-1337-1017-958
Open

docs/types: clarify abort flow, zod schema limits, file batch args, and files.content response type#1822
however-yir wants to merge 1 commit intoopenai:masterfrom
however-yir:fix-doc-issues-996-1337-1017-958

Conversation

@however-yir
Copy link
Copy Markdown

Summary

  • clarify the Abort on a function call helper example and document expected behavior after intentional aborts
  • fix polling helper examples with extra parentheses typos
  • clarify vectorStores.fileBatches.uploadAndPoll usage with { files: ... }
  • add explicit files.content() usage docs in README showing Response.text() / Response.arrayBuffer()
  • align FileContent type alias with runtime behavior (Response)

Issues addressed

Testing

  • docs/type-only changes
  • repo lint not run locally because dependencies are not installed in this environment

@however-yir however-yir requested a review from a team as a code owner April 11, 2026 09:13
Copy link
Copy Markdown
Author

Hi maintainers, friendly ping for review when convenient.

This PR addresses #996, #1337, #1017, and #958 by:

  • clarifying the abort example behavior in helpers.md
  • fixing polling helper snippet typos
  • clarifying fileBatches.uploadAndPoll argument shape
  • documenting files.content() as returning a Response
  • aligning the FileContent type alias accordingly

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant