Skip to content

docs: add AzureDocumentIntelligenceConverter documentation#10969

Merged
sjrl merged 3 commits intodeepset-ai:mainfrom
xr843:docs/add-azure-document-intelligence-converter
Mar 30, 2026
Merged

docs: add AzureDocumentIntelligenceConverter documentation#10969
sjrl merged 3 commits intodeepset-ai:mainfrom
xr843:docs/add-azure-document-intelligence-converter

Conversation

@xr843
Copy link
Copy Markdown
Contributor

@xr843 xr843 commented Mar 29, 2026

Summary

  • Adds a documentation page for the AzureDocumentIntelligenceConverter component under docs/pipeline-components/converters/
  • Follows the exact structure of the existing AzureOCRDocumentConverter docs page and the component template
  • Adds the new page to sidebars.js in alphabetical order
  • Includes an info callout explaining the relationship to the legacy AzureOCRDocumentConverter

Details

The documentation covers:

  • Key-value summary table (pipeline position, init/run variables, output variables, links)
  • Overview section explaining the component, Azure setup requirements, available models, and Markdown output format
  • Installation instructions (pip install azure-doc-intelligence-haystack)
  • Usage examples: standalone and in a pipeline

Content is based on the source code in haystack-core-integrations and the integration page.

Closes #10932

Test plan

  • Verify the page renders correctly in Vercel preview deployment
  • Check all internal links resolve (preprocessors, data classes, legacy converter)
  • Confirm sidebar navigation includes the new entry in correct alphabetical position

🤖 Generated with Claude Code

Add documentation page for the AzureDocumentIntelligenceConverter component,
which uses the newer azure-ai-documentintelligence SDK and produces Markdown
output for better LLM/RAG integration.

Closes deepset-ai#10932

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
@xr843 xr843 requested a review from a team as a code owner March 29, 2026 00:24
@xr843 xr843 requested review from sjrl and removed request for a team March 29, 2026 00:24
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 29, 2026

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

A member of the Team first needs to authorize it.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 29, 2026

CLA assistant check
All committers have signed the CLA.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 30, 2026

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

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Mar 30, 2026 11:28am

Request Review

@sjrl
Copy link
Copy Markdown
Contributor

sjrl commented Mar 30, 2026

@xr843 thanks for working on this!

Could you also copy your changes to previous versions of our docs back to and including Haystack version 2.22?

You would need to make the same changes in these folders https://github.com/deepset-ai/haystack/tree/main/docs-website/reference_versioned_docs and https://github.com/deepset-ai/haystack/tree/main/docs-website/reference_versioned_sidebars

@sjrl
Copy link
Copy Markdown
Contributor

sjrl commented Mar 30, 2026

@xr843 we are also getting a broken link error from our docusaurus build

  • Broken link on source page path = /docs/next/azuredocumentintelligenceconverter:
    -> linking to /azureocrdocumentconverter

If you'd like you can also build the docs locally to catch these errors following the instructions here https://github.com/deepset-ai/haystack/blob/main/docs-website/CONTRIBUTING.md#tldr--your-first-docs-pr-in-10-minutes

…-2.26) and fix broken link

- Copy converter documentation to versioned_docs for versions 2.22 through 2.26
- Add sidebar entries in versioned_sidebars for versions 2.22 through 2.26
- Fix broken link: use relative path for AzureOCRDocumentConverter reference
@xr843
Copy link
Copy Markdown
Contributor Author

xr843 commented Mar 30, 2026

Thanks for the review @sjrl!

I've pushed an update that addresses both items:

  1. Versioned docs (2.22–2.26): Copied the converter documentation to versioned_docs/version-2.22 through version-2.26 and added the corresponding sidebar entries in versioned_sidebars/.

  2. Broken link fix: Changed the AzureOCRDocumentConverter link from an absolute path (/azureocrdocumentconverter) to a relative path (azureocrdocumentconverter.mdx) to resolve the docusaurus build error.

Please let me know if anything else needs to be adjusted!

@sjrl
Copy link
Copy Markdown
Contributor

sjrl commented Mar 30, 2026

@xr843 thanks! Sorry missed this in the first review but could you also update this file https://github.com/deepset-ai/haystack/blob/main/docs-website/docs/pipeline-components/converters.mdx to include the azure doc intelligence converter in the overview table for converters?

…able

Add entry for AzureDocumentIntelligenceConverter to the converters
overview table in converters.mdx and versioned docs (2.22-2.26).
@xr843
Copy link
Copy Markdown
Contributor Author

xr843 commented Mar 30, 2026

Done! Added AzureDocumentIntelligenceConverter to the converters overview table in converters.mdx and all versioned docs (2.22–2.26), placed alphabetically before AzureOCRDocumentConverter.

Copy link
Copy Markdown
Contributor

@sjrl sjrl left a comment

Choose a reason for hiding this comment

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

Thanks!

@sjrl sjrl merged commit 20487c3 into deepset-ai:main Mar 30, 2026
18 checks passed
xr843 added a commit to xr843/xr843 that referenced this pull request Mar 30, 2026
Merged:
- gradio-app/gradio#13159 (Starlette 1.0 compat)
- deepset-ai/haystack#10969 (Azure Doc Intelligence docs)

In Review: add Cherry Studio, Langflow, Goose, Pretext, DSPy PRs
Remove closed PRs (litellm#24543, FastChat#3820)
Reorder merged by project stars (high to low)
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.

Add documentation for AzureDocumentIntelligenceConverter in Haystack docs website

3 participants