Workflows: fix ai.agent examples in ai-driven-alert-triage.md, plus troubleshooting and ai-steps notes#6721
Open
benironside wants to merge 2 commits into
Open
Workflows: fix ai.agent examples in ai-driven-alert-triage.md, plus troubleshooting and ai-steps notes#6721benironside wants to merge 2 commits into
benironside wants to merge 2 commits into
Conversation
…roubleshooting and ai-steps notes Sister fix to PR #6393 (which fixed the same two bugs on the RCA page). Applies Tinsae's pattern from the Slack thread to the alert-triage page, plus two general-purpose notes that #6393 left out of scope. Closes #6720. Changes: - ai-driven-alert-triage.md: four ai.agent blocks updated. prompt: -> message: (4 occurrences). agent-id: "{{ consts.agent_id }}" -> literal agent-id: elastic-ai-agent (4 occurrences). Dropped templated connector-id (4 occurrences) — the agent encodes its connector. Pruned the now-unused agent_id and connector_id keys from consts:. Updated the prerequisites bullet to call out elastic-ai-agent as the default and ask users to substitute their agent ID. - authoring-techniques/troubleshooting.md: new entry under "AI steps" covering templated top-level fields not resolving (agent-id, connector-id, inference-id, conversation-id). Links to the engine-side bug at elastic/security-team#17236. - steps/ai-steps.md: extended the existing kebab-case important admonition with a paragraph noting that top-level fields don't currently resolve Liquid templating. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
Contributor
✅ Vale Linting ResultsNo issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
Rewrites the prose in two places to be clearer for readers who don't yet have a strong Liquid mental model, and drops 4 em dashes per review feedback. - ai-steps.md admonition: replaces the abstract "don't currently resolve Liquid templating ... passed through literally" wording with a plain rule, a concrete contrast (what's written vs. what gets sent), and a positive correct-form example. - troubleshooting.md (workflows-ts-ai-top-level-templating): Symptom uses parentheses for the "agent or connector" examples instead of em-dash asides. Cause names the mechanism (Liquid expressions aren't evaluated outside `with:`) up front, drops the unhelpful name/type/if/foreach mention, and follows with the concrete "arrives at the API as literal text" example. The YAML comments inside the troubleshooting code block keep their em dashes to match the existing in-file convention. Co-authored-by: Cursor <cursoragent@cursor.com>
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
1 participant
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.
Closes #6720.
Sister fix to PR #6393 (which fixed the same two bugs on the RCA page). Applies Tinsae's pattern from the Slack thread to the alert-triage page, and adds two notes.
Changes
ai-driven-alert-triage.md— fourai.agentblocks updated:prompt:→message:(4 occurrences).agent-id: "{{ consts.agent_id }}"→ literalagent-id: elastic-ai-agent(4 occurrences).connector-id: "{{ consts.connector_id }}"(4 occurrences) — the agent encodes its connector.agent_idandconnector_idkeys fromconsts:.elastic-ai-agentas the default and ask users to substitute their agent ID.authoring-techniques/troubleshooting.md— new entry under "AI steps" covering templated top-level fields not resolving (agent-id,connector-id,inference-id,conversation-id). Links to the engine-side bug at elastic/security-team#17236.steps/ai-steps.md— extended the existing kebab-caseimportantadmonition with a paragraph noting that top-level fields don't currently resolve Liquid templating.Generative AI disclosure