Create Workflows guide for Agent Builder #4717
Conversation
charlotte-hoblik
added
documentation
✅ 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. |
leemthompo
left a comment
leemthompo
left a comment
There was a problem hiding this comment.
Just a quick initial set of comments :)
| :alt: Screenshot of the JSON raw response modal | ||
| ::: | ||
|
|
||
| ### Create a workflow tool |
There was a problem hiding this comment.
This might need to be a standalone page under Tools
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
leemthompo
left a comment
leemthompo
left a comment
There was a problem hiding this comment.
@charlotte-hoblik workflows.md conflates overview/integration information and reference content for the workflow tool type. What you have now is looking great, we just need to:
- pull the reference stuff into a separate page under
tools/ - let's move
workflows.mdto be a child of that new tool reference page for the moment, it shouldn't be orphaned in the TOC like it is now
|
|
||
| # Integrate workflows with {{agent-builder}} | ||
|
|
||
| {{agent-builder}} integrates bi-directionally with [Elastic Workflows](/explore-analyze/workflows.md). This integration bridges the gap between conversational reasoning and automated execution: |
There was a problem hiding this comment.
Let's just use working links or comment these out for the moment so we get a working URL preview on this PR
|
|
||
| # Integrate workflows with {{agent-builder}} | ||
|
|
||
| {{agent-builder}} integrates bi-directionally with [Elastic Workflows](/explore-analyze/workflows.md). This integration bridges the gap between conversational reasoning and automated execution: |
There was a problem hiding this comment.
This is a bit vague right now. I'd reword intro slightly with something like:
Workflows and {{agent-builder}} are built to work together:
- Assign agents workflow tools to trigger workflows from your chats.
- Add
ai.agentsteps to invoke agents in your workflows.Agents chat with your data by retrieving, summarizing, and reasoning. Workflows execute reliably with business-grade guardrails. Together, they combine flexible reasoning with deterministic execution.
Adding links once available
| :::{image} images/create-new-tool-workflows.png | ||
| :screenshot: | ||
| :width: 900px | ||
| :alt: Screenshot of the JSON raw response modal |
| 2. Open the **Agent chat** and ask a question that triggers the workflow. | ||
| 3. The agent extracts the necessary parameters from the conversation, runs the workflow, and returns the workflow's final output to the chat. | ||
|
|
||
| :::{image} images/agent-builder-worflow-tool.png |
There was a problem hiding this comment.
nit: let's fix the typo in the png filename
| :::{image} images/agent-builder-worflow-tool.png | ||
| :screenshot: | ||
| :width: 500px | ||
| :alt: Screenshot of the JSON raw response modal |
| 1. **agent_id**: The ID of the agent you want to call (must exist in Agent Builder). | ||
| 2. **message**: The prompt sent to the agent. You can use template variables (like `{{ steps.step_name.output }}`) to inject data dynamically. | ||
|
|
||
| ### Call Agent Builder APIs |
There was a problem hiding this comment.
If ai.agent step works we might not need this section. Let's check with product folks on Monday to confirm.
This PR adds a new guide on how to integrate workflows with Agent Builder, documenting the bi-directional integration between the two features.
Connected to: https://github.com/elastic/docs-content-internal/issues/643