Add "Switch to Agent Builder" doc for AI assistants #4438
Conversation
Vale Linting ResultsSummary: 1 warning, 12 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 46 | Elastic.DontUse | Don't use 'just'. |
💡 Suggestions (12)
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md | 19 | Elastic.FutureTense | 'will power' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md | 36 | Elastic.FutureTense | 'will prompt' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 44 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 46 | Elastic.FirstPerson | Avoid first-person pronouns such as 'me'. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 48 | Elastic.Wordiness | Consider using 'also' instead of 'In addition'. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 50 | Elastic.FirstPerson | Avoid first-person pronouns such as ' I '. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 51 | Elastic.FirstPerson | Avoid first-person pronouns such as ' I '. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 54 | Elastic.FutureTense | 'will be' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 56 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 56 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 56 | Elastic.FutureTense | 'will keep' might be in future tense. Write in the present tense to describe the state of the product as it is now. |
| explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md | 56 | Elastic.Wordiness | Consider using 'before' instead of 'prior to'. |
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.
Thanks for getting the ball rolling on this! I know the PR is very preliminary but since we last chatted a lot of previously open questions are now basically answered, so hopefully these little notes will help clarify a few things :-)
explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md
Outdated
Show resolved
Hide resolved
explore-analyze/ai-features/ai-chat-experiences/switch-to-ai-agent.md
Outdated
Show resolved
Hide resolved
explore-analyze/ai-features/ai-chat-experiences/switch-to-ai-agent.md
Outdated
Show resolved
Hide resolved
explore-analyze/ai-features/ai-chat-experiences/switch-to-ai-agent.md
Outdated
Show resolved
Hide resolved
leemthompo
changed the title
leemthompo
changed the title
explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md
Outdated
Show resolved
Hide resolved
explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md
Outdated
Show resolved
Hide resolved
…ic/docs-content into 4204-AI-agent-introduction
leemthompo
left a comment
leemthompo
left a comment
There was a problem hiding this comment.
This getting close to being fit-for-purpose I think, leaving a couple of comments right now, I might even find time to address them myself today :)
We might consider merging this and keeping the page hidden and then we just have to update the toc.yml whenever the changes are live on serverless.
explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md
Show resolved
Hide resolved
explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md
Outdated
Show resolved
Hide resolved
|
|
||
| :::: | ||
|
|
||
| In addition, the APIs vary for [Agent Builder](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-agent-builder), [AI Assistant for Security](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-security-ai-assistant-api), and [AI Assistant for Observability](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-observability_ai_assistant). No newline at end of file |
There was a problem hiding this comment.
I wonder if it might be good to do a table for APIs alone? 🤔 API functionalities could be very important to some users? (could also be in a followup)
Same remark as above, this feels a bit tacked on here.
There was a problem hiding this comment.
I don't think a single table simplify things much because looking at the APIs, there's not much overlap — though feel free to give it a try if you like! For now I tried putting these in their own section, let me know if it looks less tacked on to you.
|
|
||
| [{{agent-builder}}](/explore-analyze/ai-features/elastic-agent-builder.md) is a powerful and flexible platform for building AI agents, tools, and workflows. Agent Builder comes with built-in agents and [tools](/explore-analyze/ai-features/agent-builder/tools.md) for common use cases, and lets you create custom agents and tools for your specific needs. Eventually, it will power the default chat experience for all solutions and replace AI Assistant. | ||
|
|
||
| Agent Builder powers the AI Agent chat experience. Currently, AI Agent is available by default for Search users, and as an opt-in feature for Security and {{observability}} users. When you opt in, it replaces the AI Assistant chat experience. While Agent Builder offers expanded functionality compared to AI Assistant, it does not yet support a number of AI Assistant features. Users who rely on those AI Assistant features may not want to opt in immediately. For this reason, we've made it easy to try out Agent Builder and switch back to AI Assistant at any time. |
There was a problem hiding this comment.
| Agent Builder powers the AI Agent chat experience. Currently, AI Agent is available by default for Search users, and as an opt-in feature for Security and {{observability}} users. When you opt in, it replaces the AI Assistant chat experience. While Agent Builder offers expanded functionality compared to AI Assistant, it does not yet support a number of AI Assistant features. Users who rely on those AI Assistant features may not want to opt in immediately. For this reason, we've made it easy to try out Agent Builder and switch back to AI Assistant at any time. | |
| Agent Builder powers the AI Agent chat experience. Currently, AI Agent is available by default for {{es}} solution users, and as an opt-in feature for Security and {{observability}} users. When you opt in, it replaces the AI Assistant chat experience. While Agent Builder offers expanded functionality compared to AI Assistant, it does not yet support a number of AI Assistant features. Users who rely on those AI Assistant features may not want to opt in immediately. For this reason, we've made it easy to try out Agent Builder and switch back to AI Assistant at any time. |
There was a problem hiding this comment.
Search is no longer a thing
There was a problem hiding this comment.
likewise add "solution" after Security and Observability
There was a problem hiding this comment.
While Agent Builder offers expanded functionality compared to AI Assistant, it does not yet support a number of AI Assistant features. Users who rely on those AI Assistant features may not want to opt in immediately. For this reason, we've made it easy to try out Agent Builder and switch back to AI Assistant at any time.
I understand the reasoning behind this phrasing but it tells a bit too much users what to (not) do instead of helping them understand the current (and temporary) fundamental differences so that they choose themselves. I'd suggest:
- Addressing users directly
- Maybe refocusing the messaging a little bit to sound less negative/more neutral: "The AI Agent chat experience comes with the agent-based power of Agent Builder but is in preview for now and Elastic is working actively on it" for now, and "If you rely on AI Assistant capabilities today, consider the current differences between both experiences before opting in") - something like that
There was a problem hiding this comment.
yeah I mean we could tweak the wording until judgement day, but the message is the same :)
There was a problem hiding this comment.
Mostly LGTM from a docs standpoint - Thanks for all of the changes curious to get product eyes on this before formally approving (around naming between AI Agent/Agent Builder, overall presentation of things, messaging, etc.)
Maybe one thing missing would be to be able to link to a list of OOB agents (maybe after this PR if that doesn't exist yet--Do we have issues created for documenting/auto-generating docs for them?)
|
|
||
| [{{agent-builder}}](/explore-analyze/ai-features/elastic-agent-builder.md) is a powerful and flexible platform for building AI agents, tools, and workflows. Agent Builder comes with built-in agents and [tools](/explore-analyze/ai-features/agent-builder/tools.md) for common use cases, and lets you create custom agents and tools for your specific needs. Eventually, it will power the default chat experience for all solutions and replace AI Assistant. | ||
|
|
||
| Agent Builder powers the AI Agent chat experience. Currently, AI Agent is available by default for Search users, and as an opt-in feature for Security and {{observability}} users. When you opt in, it replaces the AI Assistant chat experience. While Agent Builder offers expanded functionality compared to AI Assistant, it does not yet support a number of AI Assistant features. Users who rely on those AI Assistant features may not want to opt in immediately. For this reason, we've made it easy to try out Agent Builder and switch back to AI Assistant at any time. |
There was a problem hiding this comment.
likewise add "solution" after Security and Observability
|
|
||
| [{{agent-builder}}](/explore-analyze/ai-features/elastic-agent-builder.md) is a powerful and flexible platform for building AI agents, tools, and workflows. Agent Builder comes with built-in agents and [tools](/explore-analyze/ai-features/agent-builder/tools.md) for common use cases, and lets you create custom agents and tools for your specific needs. Eventually, it will power the default chat experience for all solutions and replace AI Assistant. | ||
|
|
||
| Agent Builder powers the AI Agent chat experience. Currently, AI Agent is available by default for Search users, and as an opt-in feature for Security and {{observability}} users. When you opt in, it replaces the AI Assistant chat experience. While Agent Builder offers expanded functionality compared to AI Assistant, it does not yet support a number of AI Assistant features. Users who rely on those AI Assistant features may not want to opt in immediately. For this reason, we've made it easy to try out Agent Builder and switch back to AI Assistant at any time. |
There was a problem hiding this comment.
While Agent Builder offers expanded functionality compared to AI Assistant, it does not yet support a number of AI Assistant features. Users who rely on those AI Assistant features may not want to opt in immediately. For this reason, we've made it easy to try out Agent Builder and switch back to AI Assistant at any time.
I understand the reasoning behind this phrasing but it tells a bit too much users what to (not) do instead of helping them understand the current (and temporary) fundamental differences so that they choose themselves. I'd suggest:
- Addressing users directly
- Maybe refocusing the messaging a little bit to sound less negative/more neutral: "The AI Agent chat experience comes with the agent-based power of Agent Builder but is in preview for now and Elastic is working actively on it" for now, and "If you rely on AI Assistant capabilities today, consider the current differences between both experiences before opting in") - something like that
yeah that will be a follow-up, issue is here https://github.com/elastic/docs-content-internal/issues/633 |
There was a problem hiding this comment.
LGTM. We can finetune the intro wording based on product/eng/design team's feedback, but I think this page is fit-for-purpose now. Thanks for driving this Ben!
We can merge this in hidden mode, because this won't go live in next week's serverless release.
ℹ️ For other reviewers, know that we'll be documenting the standalone versus flyout mode UX differences in the main AB docs (PR is in draft).
| - file: ai-features/llm-guides/connect-to-lmstudio-security.md | ||
| - file: ai-features/llm-guides/connect-to-vLLM.md | ||
| - hidden: ai-features/ai-agent-or-ai-assistant.md | ||
| - file: ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md |
There was a problem hiding this comment.
update: we can keep this hidden because won't go live in serverless until week after next :)
| ::::{admonition} Requirements | ||
| {{agent-builder}} requires an **Enterprise [license](/deploy-manage/license.md)**. | ||
| :::: |
There was a problem hiding this comment.
Do we want to call the license level out explicitly?
Relevant Slack thread that you started, @benironside 😝
| --- | ||
| description: Learn about the differences between the AI Assistant and Agent Builder chat experiences and how to switch between the two. | ||
| applies_to: | ||
| stack: preview 9.3 |
There was a problem hiding this comment.
Can update this to new syntax
|
|
||
| There are two AI chat experiences which you can choose from: | ||
|
|
||
| - {applies_to}`stack: preview 9.3` {applies_to}`serverless: preview` [AI Agent](/explore-analyze/ai-features/elastic-agent-builder.md): Powered by Agent Builder, this chat experience lets you create custom agents for specific tasks, with specialized tools, and provides a unified chat experience across all of {{kib}}. |
There was a problem hiding this comment.
All of the tags in these changed files can be updated to use new explicit versioning syntax.
Addresses #4204, and partly addresses #522 by creating a new page in the explore-analyze AI section that describes the new AI Agent chat experience, and informs users about how to opt in to it in 9.3, and the feature differences.
I put the new page in a new subsection in the AI section we've been working on, in a new folder called ai-chat-experiences.
Generative AI disclosure
Live preview: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4438/explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant