docs: replace migrated component imports with haystack_integrations paths - #11860
Merged
Conversation
…aths Components deprecated in core ahead of Haystack 3.0 (SentenceTransformers embedders/rankers, Transformers components, Hugging Face API components, langdetect, Tika, Azure OCR, OpenAPI, Whisper, web search, tracers) are still imported from their old haystack.components/haystack.tracing paths in docs pages and core docstrings. - Rewrite old imports to the new haystack_integrations paths in docs-website/docs (61 pages), including serialized-pipeline YAML type paths and the renamed classes (HuggingFaceLocalChatGenerator -> TransformersChatGenerator, ExtractiveReader -> TransformersExtractiveReader) - Add install notes for the new PyPI packages where a page's examples now need them - Update usage examples in docstrings of non-deprecated core components (retrievers, DocumentJoiner, EmbeddingBasedDocumentSplitter, PipelineTool) - Remove explicit warm_up() calls from examples of components whose run() auto-invokes warm-up Pages documenting a deprecated component itself and the historical 1.x->2.x migration guide intentionally keep old imports. Related to deepset-ai/haystack-private#449 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Coverage report
This PR does not seem to contain any modification to coverable code. |
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. |
sjrl
approved these changes
Jul 6, 2026
sjrl
left a comment
sjrl
left a comment
Contributor
There was a problem hiding this comment.
Looks good! I think the language is fine in regards to explaining that components were moved to a new package. It at least provides context if users look at older Haystack docs compared to these new ones
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
2 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
Several components were deprecated in core and moved to
haystack-core-integrations(SentenceTransformers embedders/rankers, Transformers components, Hugging Face API components, langdetect, Tika, Azure OCR, OpenAPI, Whisper transcribers, SearchApi/SerperDev web search, Datadog/OpenTelemetry tracers). Docs pages and core docstrings still showed the oldfrom haystack.components.../from haystack.tracing...imports.Proposed Changes:
from haystack_integrations...paths in 61 hand-maintaineddocs-website/docspages, including:type:paths (e.g.haystack.components.embedders.sentence_transformers_text_embedder.SentenceTransformersTextEmbedder→haystack_integrations.components.embedders.sentence_transformers.sentence_transformers_text_embedder.SentenceTransformersTextEmbedder)HuggingFaceLocalChatGenerator→TransformersChatGenerator,ExtractiveReader→TransformersExtractiveReader(incl. cross-page links)pip install sentence-transformers-haystack) on pages whose examples now require an integration packageInMemoryEmbeddingRetriever,MultiRetriever,MultiQueryEmbeddingRetriever,TextEmbeddingRetriever,DocumentJoiner,EmbeddingBasedDocumentSplitter,PipelineTool)warm_up()calls from examples only where the component'srun()was verified to auto-invoke warm-up (SentenceTransformers embedders,ChineseDocumentSplitter,AmazonTextractConverter,FunASRTranscriber, LlamaCpp generators)Intentionally unchanged:
extractivereader.mdx,huggingfacelocalchatgenerator.mdx,namedentityextractor.mdx) — they carry a deprecation banner and document the old classoverview/migration.mdx— historical 1.x→2.x guide with snippets labeled "Haystack 2.x"versioned_docs/**How did you test it?
docs-website/docs(outside the intentional skip list)hatch run fmt,hatch run test:types, and unit tests for the touched modules (448 passed)Notes for the reviewer
The bulk of the changes are mechanical import rewrites; the interesting files to review are
overview/get-started.mdx,overview/migrating-from-langgraphlangchain-to-haystack.mdx, and the install notes.I used the phrasing
The examples on this page use SerperDev web search component that have moved to the serperdev-haystack package. Install it to run the examples:for the instructions regardingpip install. We could discuss shortening that:Install serperdev-haystack to run the examples:We should check why
warm_up()is still needed inE2BToolset/SupabaseDocumentStoreexamples separately.Checklist
🤖 Generated with Claude Code