Skip to content

Add ImageContent documentation page#11331

Merged
anakin87 merged 4 commits into
deepset-ai:mainfrom
charliesheh:docs-imagecontent-page
Jun 26, 2026
Merged

Add ImageContent documentation page#11331
anakin87 merged 4 commits into
deepset-ai:mainfrom
charliesheh:docs-imagecontent-page

Conversation

@charliesheh

Copy link
Copy Markdown
Contributor

Summary
Adds a dedicated documentation page for the ImageContent data class.

Changes

  • Added imagecontent.mdx under docs-website/docs/concepts/data-classes/
  • Documented:
    • creating ImageContent
    • loading from file paths
    • loading from URLs
    • multimodal usage with ChatMessage
    • metadata support
    • validation behavior
    • serialization methods
    • image display support
  • Added navigation/reference entry in data-classes.mdx

Related Issue
Closes #10570

@charliesheh charliesheh requested a review from a team as a code owner May 17, 2026 22:46
@charliesheh charliesheh requested review from bogdankostic and removed request for a team May 17, 2026 22:46
@vercel

vercel Bot commented May 17, 2026

Copy link
Copy Markdown

@charliesheh is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant

CLAassistant commented May 17, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@sjrl sjrl requested a review from anakin87 May 18, 2026 04:54
@anakin87 anakin87 removed the request for review from bogdankostic May 18, 2026 08:11
@anakin87 anakin87 self-assigned this May 18, 2026
@vercel

vercel Bot commented May 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jun 26, 2026 12:13pm

Request Review

@anakin87 anakin87 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR!

I left some comments.

In addition, please copy these changes to haystack/docs-website/versioned_docs /version-2.29/. In fact, your current changes target the unstable docs version but should also target the latest stable version (2.29).

Comment thread docs-website/docs/concepts/data-classes/imagecontent.mdx Outdated
Comment thread docs-website/docs/concepts/data-classes/imagecontent.mdx
Comment thread docs-website/docs/concepts/data-classes/imagecontent.mdx
Comment thread docs-website/docs/concepts/data-classes/imagecontent.mdx Outdated
Comment thread docs-website/docs/concepts/data-classes.mdx Outdated
julian-risch and others added 2 commits June 26, 2026 11:11
# Conflicts:
#	docs-website/docs/concepts/data-classes.mdx
Apply reviewer suggestions on PR deepset-ai#11331:
- Link the ChatMessage documentation page
- Add a "Producing ImageContent with Converters" section covering
  ImageFileToImageContent and PDFToImageContent, with links
- Add a multimodal ChatPromptBuilder example using Jinja2 string
  templates and the | templatize_part filter
- Turn the Related Components list into links to the relevant pages
- Fix the broken data-classes.mdx link to the ImageContent page
  (use the .mdx target so Docusaurus resolves the slug)
- Normalize the page frontmatter so no stray rule leaks into the body

Mirror all changes into versioned_docs/version-2.30 (current latest
stable docs version).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@julian-risch

Copy link
Copy Markdown
Member

@anakin87 I took the liberty of addressing your comments so that we can merge the PR before it becomes more out-of-date. Could you please review again?

Comment thread docs-website/docs/concepts/data-classes/imagecontent.mdx Outdated
Comment thread docs-website/versioned_docs/version-2.30/concepts/data-classes/imagecontent.mdx Outdated

@anakin87 anakin87 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
Thank you!

@anakin87 anakin87 merged commit 59379b0 into deepset-ai:main Jun 26, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Add a docs page for ImageContent

4 participants