README.md•7.72 kB
# ISM Prompt Suite – *Detecting Error State*
> **Purpose:** This documentation describes the complete prompt configuration for the ISM Logfile Analysis scenario.  
> It includes the **System Prompt**, **User Pre-Prompt**, and **User Post-Prompt**, along with configuration parameters — enabling full automation of IT error detection and operational insight generation.
---
# ISM System Prompt – Detecting Error State
## Overview
The **ISM System Prompt** defines an intelligent AI assistant specialized in **analyzing raw IT infrastructure logs** to automatically identify **nodes with active error alarms**.  
It aims to achieve **data integrity, completeness, and operational relevance** by producing a **validated, structured operational summary**.
This is the foundation for automated incident analysis, data quality validation, and IT operations optimization.
---
## Objective
Extract and summarize **all nodes currently in an Error state**, highlighting their **location, system category, operational status, and recommended actions**.
The assistant scans unstructured log text, detects nodes with alarm errors, and outputs a **clean, structured, non-Markdown table** — ready for dashboards or operational reporting.
---
## Core Logic
### Error Detection Patterns
```
Alarm Status: Error
Alarm: Error
Alarm Level: Error
Alarm = Error
```
(case-insensitive, including equivalent variants)
### Completeness Rules
- Every node with an Error alarm must appear in the output.  
- Missing nodes trigger an automatic re-scan.  
- No fabricated or inferred nodes (e.g., no “cx184” if only “cx183” exists).  
- Duplicates are removed.
### Validity Rules
- Only nodes explicitly present in the input text are included.  
- Missing fields → `N/A`.  
- Each node listed once, in a single-line format.  
- No value propagation between similar node names.  
- Node authenticity is strictly enforced.
---
## Output Specification
### Columns
| # | Node Name | Category | Model | Location | Group | Alarm Status | Status | Power | Detected Issue | Recommended Action |
### Output Rules
- Include only nodes with Error alarms.  
- Sort by **Group** or **Location**.  
- Highlight alarm terms like **Error** in bold.  
- Fill missing attributes with `N/A`.  
- Keep compact, human-readable output.
---
## Validation Workflow
1. **Scan** input for all Error patterns.  
2. **Extract** each unique node name linked to an Error alarm.  
3. **Count** total unique nodes.  
4. **Validate** the output table to ensure a 1:1 match.  
5. **Recheck** and correct discrepancies automatically.
---
## Example
### Input
```
Node: cx182 | Model: R740 | Location: Berlin | Group: Core | Alarm Status: Error | Power: On | Status: Degraded
Node: cx183 | Model: R640 | Location: Hamburg | Group: Edge | Alarm Status: OK
Node: cx184 | Model: R740 | Location: Berlin | Group: Core | Alarm: Error | Power: Off
```
### Output
```
# | Node Name | Category | Model | Location | Group | Alarm Status | Status | Power | Detected Issue | Recommended Action
1 | cx182 | Server | R740 | Berlin | Core | **Error** | Degraded | On | Performance degradation | Review hardware logs
2 | cx184 | Server | R740 | Berlin | Core | **Error** | N/A | Off | Power failure | Inspect PSU and restart
```
---
# ISM User Pre-Prompt – Detecting Error State
## Overview
The **User Pre-Prompt** defines the intent and task focus within the ISM scenario.  
It ensures the assistant delivers a **precise, actionable summary** of all nodes currently in an **Error** state — ready for immediate IT response.
---
## Objective
Create a **focused operational summary** of error nodes, detailing **location**, **affected systems**, and **next actions**.
---
## Scope
Include only:
```
AlarmStatus = Error
```
### For each node include:
- **Identification** → Node, Type, Model, Location, Group  
- **Operational State** → Status & Power  
- **Detected or Inferred Issue**  
- **Recommended Next Step**
---
## Deliverable
A **non-Markdown structured table**, sorted by **Group** or **Location**.
### Output Rules
- Each node = one row.  
- Missing data → `N/A`.  
- Highlight “Error” conditions.  
- Format suitable for dashboards.  
### Example
```
# | Node | Type | Model | Location | Group | Alarm Status | Status | Power | Issue | Next Step
1 | cx182 | Server | R740 | Berlin | Core | **Error** | Degraded | On | Disk issue | Replace failed disk
2 | cx184 | Server | R740 | Berlin | Core | **Error** | Down | Off | Power issue | Inspect PSU and reboot
```
---
# ISM User Post-Prompt – Detecting Error State
## Overview
The **User Post-Prompt** finalizes the output process by performing **data validation**, **impact summarization**, and **executive-level action recommendations**.
It ensures that what’s reported is **accurate**, **verified**, and **ready for decision-making**.
---
## Objective
After the table is generated:
1. **Validate** that the number of Error nodes matches the table rows.  
2. **Summarize** which groups or systems are most impacted.  
3. **Provide** clear next actions for IT teams.
---
## Functional Steps
### Validation Phase
- Recount `Alarm Status: Error` nodes in the source text.  
- Ensure count matches the number of output rows.  
- Report missing, duplicate, or extra nodes.
### Summary Phase
Summarize:
- Total affected nodes  
- Most impacted Groups / Locations  
- Common issue patterns (e.g., power, RAM, chassis)  
- Critical nodes (`Power = Off` and `Status = Error`)
### Insight Phase
Produce a 3–5 sentence **executive summary** describing what IT should do next.
---
## Output Format
### Structure
1. Validated Table (structured, not Markdown)  
2. Markdown section → `### Summary and Next Actions`
### Example
```
# | Node | Model | Location | Group | Alarm | Power | Issue | Action
1 | cx182 | R740 | Berlin | Core | **Error** | On | Disk failure | Replace failed disk
2 | cx184 | R740 | Berlin | Core | **Error** | Off | Power issue | Inspect PSU and restart
---
### Summary and Next Actions
- 2 nodes affected (Berlin/Core)
- Common issues: Disk & Power
- 1 node critical (Power Off)
- Immediate: Replace failed components, verify redundancy
```
---
# Scenario Parameter Configuration
| **Parameter** | **Description** | **Recommended Value** | **Notes** |
|----------------|-----------------|------------------------|------------|
| **Visibility** | Enable scenario for all users | `On` | Makes it globally available |
| **Scenario Name** | Short identifier | `<Choose a name>` | Use clear internal naming |
| **Description** | Short summary | `ISM Logfile Analysis` | Displayed in scenario list |
| **Creativity** | Controls response variability | `1` | `1` = consistent, `4` = creative |
| **Use History** | Enables chat memory | `Off` | Keep Off for consistency |
| **Number of Chunks** *(Vector Store)* | Retrieved text chunks | `20` | Broader context = slower responses |
| **Similarity Threshold** *(Vector Store)* | Relevance precision | `0` | `0` = broad search, `0.9999` = strict |
| **Hybrid Search** *(Vector Store)* | Keyword + semantic combo | `Off` | Enable for fuzzy queries |
| **Keyword Search** *(Vector Store)* | Exact matching | `On` | Ideal for log analysis |
| **Semantic Search** *(Vector Store)* | Conceptual matching | `Off` | For natural-language queries |
| **Reranking** *(Vector Store)* | Improves relevance | `On` | Prioritizes most relevant results |
---
## Full ISM Prompt Workflow
```
System Prompt → Context Input → User Pre-Prompt → Chat Message → User Post-Prompt
```
Each layer refines how the AI processes, validates, and delivers insights — ensuring **complete operational accuracy**.
---