-
Notifications
You must be signed in to change notification settings - Fork 195
Add "Switch to Agent Builder" doc for AI assistants #4438
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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 | 21 | 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 | 38 | 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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
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
|
Based on our sync yesterday, here are the todos:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?)
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
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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).
explore-analyze/toc.yml
Outdated
| - 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
update: we can keep this hidden because won't go live in serverless until week after next :)
mdbirnstiehl
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
| ::::{admonition} Requirements | ||
| {{agent-builder}} requires an **Enterprise [license](/deploy-manage/license.md)**. | ||
| :::: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to call the license level out explicitly?
Relevant Slack thread that you started, @benironside 😝
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tl;dr we need to be explicit here, it's an exception, because there are SDHs (and there's nothing on the subs page) :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ::::{admonition} Requirements | |
| {{agent-builder}} requires an **Enterprise [license](/deploy-manage/license.md)**. | |
| :::: | |
| ::::{admonition} Requirements | |
| {{agent-builder}} requires an **Enterprise [subscription](/deploy-manage/license.md)**. | |
| :::: |
Let's say subscription; Let's also figure out what the prereq is for Serverless and include it here too, because the subscription level has no effect on serverless feature availability (it's the feature tier of the project that does)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it will be Complete feature tier for Obs and Search
we might be able to just use the old generic wording here though once the subs pages are updated
I'm operating on the assumption that those pages won't be updated until 9.3 releases, so we'd need temporary, exceptionall explicit note until then to cover the earlier serverless availability 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the language here. Let me know what you all think
explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md
Outdated
Show resolved
Hide resolved
|
I am not sure if we do want to use Agent Builder name instead of Agent / AI Agent |
@KodeRad I think we need a smart(er) combination of both so that users can properly identify what we're talking about here, and also make the connection with the overall Agent Builder concept, which is important too. |
That's true 👍 We need both. Just want to make sure we are using it correctly. |
|
@benironside can you add "Integration with Elastic Workflows" into the comparison table. for this category it would be a yes for Agent Builder, no for Security AI Assistant. thank you! |
|
Nit: I think AI insights were added to Security (at least based on AI Assistant IIUC) in 9.3 by the entity analysis team, if we want to add it to the table |
kilfoyle
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM for the admin part! 🦘
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