Refactor for better prompt and tool description organization #350
Conversation
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
…o include all prompts in the config to track the prompt versions through it Signed-off-by: Hsin Chen <hsinc@nvidia.com>
Signed-off-by: Hsin Chen <hsinc@nvidia.com>
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the configuration of prompt-engineerable strings by consolidating tool descriptions and prompts into dedicated classes in prompt.py and corresponding config objects. Key changes include:
- Replacing inline prompt strings with references to centralized prompt classes.
- Updating imports and configuration fields across multiple tool modules.
- Adjusting test cases and helper functions to utilize the new prompt configurations.
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| examples/alert_triage_agent/tests/test_host_performance_check_tool.py | Updated test mocks to use HostPerformanceCheckPrompts for parsing prompt values. |
| examples/alert_triage_agent/src/aiq_alert_triage_agent/telemetry_metrics_host_performance_check_tool.py | Changed system prompt references to use TelemetryMetricsHostPerformanceCheckPrompts and added new analysis prompt configuration. |
| examples/alert_triage_agent/src/aiq_alert_triage_agent/telemetry_metrics_host_heartbeat_check_tool.py | Updated to reference TelemetryMetricsHostHeartbeatCheckPrompts for heartbeat prompt generation. |
| examples/alert_triage_agent/src/aiq_alert_triage_agent/telemetry_metrics_analysis_agent.py | Refactored to use TelemetryMetricsAnalysisAgentPrompts in place of the old prompts. |
| examples/alert_triage_agent/src/aiq_alert_triage_agent/prompts.py | Consolidated prompt definitions into individual classes for each tool, improving organization and maintainability. |
| examples/alert_triage_agent/src/aiq_alert_triage_agent/network_connectivity_check_tool.py | Updated prompt usage for network connectivity checks with NetworkConnectivityCheckPrompts. |
| examples/alert_triage_agent/src/aiq_alert_triage_agent/monitoring_process_check_tool.py | Aligned the monitoring process check tool configuration with MonitoringProcessCheckPrompts. |
| examples/alert_triage_agent/src/aiq_alert_triage_agent/maintenance_check.py | Modified maintenance check tool to accept prompt template as a parameter and updated prompt references. |
| examples/alert_triage_agent/src/aiq_alert_triage_agent/host_performance_check_tool.py | Adjusted both parsing and analysis prompt configuration to use HostPerformanceCheckPrompts. |
| examples/alert_triage_agent/src/aiq_alert_triage_agent/hardware_check_tool.py | Updated hardware check tool to use the new HardwareCheckPrompts for prompt and description. |
| examples/alert_triage_agent/src/aiq_alert_triage_agent/categorizer.py | Refactored categorizer configuration to use CategorizerPrompts for a unified description and prompt. |
Comments suppressed due to low confidence (1)
examples/alert_triage_agent/src/aiq_alert_triage_agent/prompts.py:208
- There appears to be a typo in the prompt text ('You arg' instead of 'You're a'). Please correct the wording to improve clarity.
PROMPT = "You arg a helpful alert triage assistant. Your task is to investigate an alert that was just triggered on a specific host. You will be given two inputs:"
AnuradhaKaruppiah
added
improvement
AnuradhaKaruppiah
approved these changes
Jun 9, 2025
|
/ok to test 44f4d3b |
|
/merge |
AnuradhaKaruppiah
pushed a commit
to AnuradhaKaruppiah/oss-agentiq
that referenced
this pull request
Aug 4, 2025
) This PR moves the default values of tool descriptions into prompt.py and the default prompts into the config objects, so all "prompt-engineerable" strings are tracked in a centralized file and also by the config for easier prompt engineering and version tracking. Authors: - https://github.com/hsin-c Approvers: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) URL: NVIDIA#350
scheckerNV
pushed a commit
to scheckerNV/aiq-factory-reset
that referenced
this pull request
Aug 22, 2025
) This PR moves the default values of tool descriptions into prompt.py and the default prompts into the config objects, so all "prompt-engineerable" strings are tracked in a centralized file and also by the config for easier prompt engineering and version tracking. Authors: - https://github.com/hsin-c Approvers: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) URL: NVIDIA#350
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.
This PR moves the default values of tool descriptions into prompt.py and the default prompts into the config objects, so all "prompt-engineerable" strings are tracked in a centralized file and also by the config for easier prompt engineering and version tracking.