feat: support runtime progress bar overrides - #13093
Draft
RAMZI0TO99 wants to merge 1 commit into
Draft
RAMZI0TO99 wants to merge 1 commit into
RAMZI0TO99 wants to merge 1 commit into
Conversation
Contributor
|
@RAMZI0TO99 is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
1 task done
This branch has not been deployed
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
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
Proposed Changes:
Setting
HAYSTACK_PROGRESS_BARS=0now disables progress bars in the current core components, including their asynchronous execution paths. The override is read during execution, so changing the variable between runs takes effect on existing component instances without changing their stored or serializedprogress_barsetting.A private helper resolves case-insensitive, whitespace-trimmed values:
1,true,yes, andonenable progress bars;0,false,no, andoffdisable them. Missing, empty, or unrecognized values preserve the component setting.The helper is used by
OpenAIDocumentEmbedder(also inherited byAzureOpenAIDocumentEmbedder),MarkdownToDocument, andLLMEvaluator(also used byFaithfulnessEvaluatorandContextRelevanceEvaluator). The FAQ, parameter docstrings, and release note describe the behavior.How did you test it?
hatch run test:typespassed: no issues in 553 source files.hatch run docspassed: all 28 API-reference configurations generated. On Windows, this requiredPYTHONUTF8=1to match Linux CI's text encoding.docusaurus-mdx-checker@3.0.0passed on Node 22: all 28 generated API-reference pages and both edited FAQ pages compiled without errors.text/csv, while Windows returnsapplication/vnd.ms-excel. It reproduces on clean upstream commit87dba65; neither the test nor ByteStream is changed here.caf, which appears in unchanged encoded-byte fixtures in the Markdown test module. The repository hook configuration is unchanged.Tests were run through Hatch on Windows with Python 3.13.5. The test commands used
--no-covbecause coverage collection crashed during shutdown in this environment. The same test assertions still ran.Notes for the reviewer
The implementation deliberately resolves the override at execution time and keeps the helper private. It covers the progress loops present in core; it does not modify components that have moved to integrations. The original constructor values remain the serialization source.
This PR was fully generated with an AI assistant. The implementation and regression coverage were reviewed using AI assistants, and the checks listed above were run. The contributor must personally review and understand the changes and accept the CLA; those personal requirements are not represented as completed here.
The PR remains a draft pending these requirements. Haystack's first-time-contributor CLA workflow returns unsigned PRs to draft. The upstream test, API-reference, release-note, and CodeQL workflows currently require maintainer approval to run, and the Vercel documentation preview requires team authorization. Maintainer edits are enabled.
Checklist