docs: add FileContent data class page#11444
Open
jdoughty04 wants to merge 2 commits into
Open
Conversation
|
@jdoughty04 is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
|
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
bogdankostic
reviewed
Jun 4, 2026
Contributor
bogdankostic
left a comment
bogdankostic
left a comment
There was a problem hiding this comment.
Thank you so much for your PR @jdoughty04!
It looks already good, but we released v2.30 in the meantime. Can you make sure that the pages are also present in the latest version? Thanks :)
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
3 participants
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.
Related Issues
FileContent#10571Proposed Changes:
Adds a dedicated
FileContentconcept page to the data classes docs. The page covers what the dataclass stores, how to create it from a local file, URL, or existing base64 data, how to use it insideChatMessage, and how serialization works.I also linked the new page from the Data Classes overview and sidebar for both the unstable docs and the latest stable versioned docs.
How did you test it?
npm.cmd run buildfromdocs-website(passes)node -e "import('./docs-website/sidebars.js').then(...)"to verify the new sidebar entry is presentnode -e "JSON.parse(...version-2.29-sidebars.json...)"to verify the versioned sidebar JSON parsesgit diff --checkNotes for the reviewer
This keeps the page focused on user-facing usage and links to the generated API reference for the complete method signatures.
AI assistance disclosure: this PR was prepared with OpenAI Codex. I reviewed the changes and ran the relevant docs checks.
Checklist
fixes #10571; I did not add a separate issue comment.fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:and added!in case the PR includes breaking changes.npm.cmd run buildpassed.