Skip to content

Document LLMFileAnalysisOperator's inherited LLM and HITL parameters - #71856

Open
ColtenOuO wants to merge 1 commit into
apache:mainfrom
ColtenOuO:common-ai-file-analysis-docstring
Open

Document LLMFileAnalysisOperator's inherited LLM and HITL parameters#71856
ColtenOuO wants to merge 1 commit into
apache:mainfrom
ColtenOuO:common-ai-file-analysis-docstring

Conversation

@ColtenOuO

Copy link
Copy Markdown
Contributor

Summary

LLMFileAnalysisOperator fully supports model_id, system_prompt, agent_params, and HITL review (require_approval, approval_timeout, allow_modifications) - all inherited from LLMOperator and exercised in execute(), but its docstring
documented none of them, unlike LLMSQLQueryOperator, LLMBranchOperator, and LLMSchemaCompareOperator, which all document these plus a require_approval example.

This is a docs-only change; no behavior changes.

Change

  • operators/llm_file_analysis.py: added :param model_id:, :param system_prompt:, :param agent_params: entries to LLMFileAnalysisOperator's docstring, plus the "Human-in-the-Loop approval parameters are inherited from LLMOperator..." paragraph every sibling operator already has.
  • decorators/llm_file_analysis.py: expanded _LLMFileAnalysisDecoratedOperator's one-line docstring to match the fuller format used by _LLMBranchDecoratedOperator / _LLMSQLDecoratedOperator.
  • example_dags/example_llm_file_analysis.py: added example_llm_file_analysis_approval, demonstrating require_approval=True this was the only file-analysis-family example DAG missing an approval example.
  • docs/operators/llm_file_analysis.rst: added a "Human-in-the-Loop Approval" section wiring the new example into the built docs, mirroring llm_sql.rst.

Was generative AI tooling used to co-author this PR?
  • Yes — Claude Code (Sonnet 5)

model_id, system_prompt, agent_params, and the require_approval /
approval_timeout / allow_modifications trio are fully supported here
but undocumented in the docstrings, unlike every sibling operator
(LLMSQLQueryOperator, LLMBranchOperator, LLMSchemaCompareOperator),
which document them and show a require_approval example.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant