Fix ai.agent step parameter placement in agents-and-workflows#7289
Open
leemthompo wants to merge 1 commit into
Open
Fix ai.agent step parameter placement in agents-and-workflows#7289leemthompo wants to merge 1 commit into
leemthompo wants to merge 1 commit into
Conversation
The ai.agent step config keys (agent-id, connector-id, inference-id, create-conversation) are hyphenated and set at the top level of the step, not inside the with block. The overview page incorrectly showed agent_id under with with underscore naming. Correct the how-to steps, YAML example, and parameters table to match run_agent_step.ts and the canonical ai-steps.md reference, and document connector-id / inference-id model routing. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.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
🔍 Preview links for changed docs |
Contributor
✅ Elastic Docs Style Checker (Vale)No 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. |
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.
Fixes an inaccuracy in the
ai.agentworkflow step documentation on the Agent Builder overview page.Problem
explore-analyze/ai-features/agent-builder/agents-and-workflows.mdshowedagent_idinside the step'swithblock with underscore naming, and scoped its parameters table to "thewithblock". That is wrong.Per the source of truth (
elastic/kibanax-pack/platform/plugins/shared/agent_builder/common/step_types/run_agent_step.ts):agent-id,connector-id,inference-id,create-conversation.withblock inputs are underscored:message,schema,conversation_id,attachments.The canonical
ai.agentreference already gets this right; this change brings the overview page in line with it.Changes
agent-idat the top level of the step with hyphenated naming.connector-id/inference-id(model routing, mutually exclusive),create-conversation,conversation_id, andattachments, and link to the canonical reference.Related
inference_idmodel routing on the Converse API (kibana-api.md,models.md). This PR owns theai.agentoverview page; no file overlap between the two.🤖 Generated with Claude Code