Skip to content

Commit 4c3b166

Browse files
benironsideflorent-leborgnemdbirnstiehlleemthompo
authored
Add "Switch to Agent Builder" doc for AI assistants (#4438)
Addresses #4204, and partly addresses [#522](/elastic/docs-content-internal/issues/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 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [ x] No ## 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 --------- Co-authored-by: florent-leborgne <florent.leborgne@elastic.co> Co-authored-by: Mike Birnstiehl <114418652+mdbirnstiehl@users.noreply.github.com> Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Co-authored-by: Liam Thompson <leemthompo@gmail.com>
1 parent 94822ba commit 4c3b166

File tree

10 files changed

+146
-27
lines changed

10 files changed

+146
-27
lines changed

deploy-manage/reference-architectures/hotfrozen-high-availability.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This Hot/Frozen – High Availability architecture is intended for organizations
2727
* Have a requirement for cost effective long term data storage (many months or years).
2828
* Provide insights and alerts using logs, metrics, traces, or various event types to ensure optimal performance and quick issue resolution for applications.
2929
* Apply [machine learning anomaly detection](/explore-analyze/machine-learning/anomaly-detection.md) to help detect patterns in time series data to find root cause and resolve problems faster.
30-
* Use an AI assistant ([Observability](/explore-analyze/ai-features/ai-assistant.md), [Security](/solutions/security/ai/ai-assistant.md), or [Playground](/solutions/search/rag/playground.md)) for investigation, incident response, reporting, query generation, or query conversion from other languages using natural language.
30+
* Use an AI assistant ([Observability](/explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md), [Security](/solutions/security/ai/ai-assistant.md), or [Playground](/solutions/search/rag/playground.md)) for investigation, incident response, reporting, query generation, or query conversion from other languages using natural language.
3131
* Deploy an architecture model that allows for maximum flexibility between storage cost and performance.
3232

3333
::::{important}

explore-analyze/ai-features/ai-agent-or-ai-assistant.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
applies_to:
3+
stack: preview 9.3+
4+
serverless: preview
5+
products:
6+
- id: kibana
7+
- id: observability
8+
- id: security
9+
- id: cloud-serverless
10+
---
11+
12+
# AI chat experiences
13+
14+
AI chat can help with a wide range of tasks throughout {{kib}}, such as helping to answer questions about your data, suggesting next steps, and explaining how to use Elastic's software.
15+
16+
There are two AI chat experiences which you can choose from:
17+
18+
- {applies_to}`stack: preview 9.3+` {applies_to}`serverless: preview` **AI Agent**: Powered by [{{agent-builder}}](/explore-analyze/ai-features/elastic-agent-builder.md), this chat experience lets you create custom agents for specific tasks, with specialized tools, and provides a unified chat experience across all of {{kib}}.
19+
- [AI Assistant](/explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md): Elastic's original AI chat, AI Assistant offers features like chat sharing, data anonymization, and knowledge base that are not yet present in Agent Builder. The AI Assistant for {{observability}} and {{es}} operates independently from the AI Assistant for Security.
20+
21+
To compare them and learn how to switch between them, refer to [](/explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md).
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
description: Learn about the differences between the AI Assistant and Agent Builder chat experiences and how to switch between the two.
3+
applies_to:
4+
stack: preview 9.3+
5+
serverless: preview
6+
products:
7+
- id: kibana
8+
- id: observability
9+
- id: security
10+
- id: cloud-serverless
11+
---
12+
13+
# Compare Agent Builder and AI Assistant
14+
15+
::::{admonition} Requirements
16+
- {{stack}} users: an **Enterprise [subscription](/deploy-manage/license.md)**.
17+
- {{sec-serverless}} users: the **Security Analytics Complete** or **Elastic AI Soc Engine (EASE)** feature tier.
18+
- {{obs-serverless}} and {{es-serverless}} users: the **Complete** feature tier.
19+
::::
20+
21+
[{{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.
22+
23+
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 solution and {{observability}} solution users. When you opt in, it replaces the AI Assistant chat experience. You can opt in to Agent Builder and switch back to AI Assistant at any time.
24+
25+
While Agent Builder offers expanded functionality compared to AI Assistant, it does not yet support a number of AI Assistant features. If you rely on AI Assistant capabilities today, consider the differences between each experience before opting in.
26+
27+
Use this page to learn about:
28+
29+
- [How to switch between the AI Assistant and Agent Builder chat experiences](#switch-between-chat-experiences)
30+
- [Feature differences between AI Assistant and Agent Builder](#feature-differences-between-agent-builder-and-ai-assistant)
31+
32+
## Switch between chat experiences
33+
34+
:::{important}
35+
Agent Builder cannot access your chats, prompts, or knowledge base entries from AI Assistant. However, this data remains accessible if you switch back to the AI Assistant chat experience.
36+
:::
37+
38+
{{kib}} will prompt you to switch to the Agent Builder chat experience if your deployment supports it and you have sufficient privileges. You can opt-in from this prompt immediately.
39+
40+
You can also switch chat experiences at any time:
41+
42+
1. Use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md) to find [**GenAI Settings**](/explore-analyze/ai-features/manage-access-to-ai-assistant.md).
43+
2. Toggle between the two experiences under **Chat Experience**.
44+
45+
% TODO: Link to /solutions/search/agent-builder/standalone-and-flyout-modes.md once that page exists
46+
47+
## Feature differences between Agent Builder and AI Assistant
48+
49+
Agent Builder doesn't yet support all AI Assistant features. The specific differences vary by solution:
50+
51+
::::{tab-set}
52+
:group: example-group
53+
54+
:::{tab-item} {{elastic-sec}}
55+
:sync: tab1
56+
57+
| Feature | Agent Builder | AI Assistant |
58+
| :--- | :---: | :---: |
59+
| **Knowledge Base** |||
60+
| **Data anonymization** |||
61+
| **Time awareness** |||
62+
| **Chat sharing** |||
63+
| **Citations** |||
64+
| **Audit logging** |||
65+
| **Quick prompts** |||
66+
| **In-chat previews of attached data** |||
67+
| **AI insights** |||
68+
| **Use-case specific agents** |||
69+
| **Custom agent creation** |||
70+
| **Custom tool selection** |||
71+
| **Integration with Elastic workflows** |||
72+
73+
:::
74+
75+
:::{tab-item} Elastic {{observability}} and Search
76+
:sync: tab2
77+
78+
| Feature | Agent Builder | AI Assistant |
79+
| :--- | :---: | :---: |
80+
| **Knowledge Base** |||
81+
| **Data anonymization** |||
82+
| **Chat sharing** |||
83+
| **Chat duplication** |||
84+
| **Chat archiving** |||
85+
| **Alerting rule connector action** |||
86+
| **AI insights** |||
87+
| **Use-case specific agents** |||
88+
| **Custom agent creation** |||
89+
| **Custom tool selection** |||
90+
91+
:::
92+
93+
::::
94+
95+
## API differences between Agent Builder and AI Assistant
96+
97+
Each AI chat experience has different APIs. To learn which actions each option supports, refer to:
98+
99+
- [Agent Builder](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-agent-builder)
100+
- [AI Assistant for Security](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-security-ai-assistant-api)
101+
- [AI Assistant for Observability](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-observability_ai_assistant)

explore-analyze/ai-features/ai-assistant.md renamed to explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ $$$token-limits$$$
3333

3434
AI Assistant requires specific privileges and a large language model (LLM) connector. The capabilities and ways to interact with AI Assistant can differ for each solution. To learn more about how it works in each solution, refer to:
3535

36-
- [{{obs-ai-assistant}}](../../solutions/observability/observability-ai-assistant.md)
37-
- [AI Assistant for Security](../../solutions/security/ai/ai-assistant.md)
36+
- [{{obs-ai-assistant}}](/solutions/observability/observability-ai-assistant.md)
37+
- [AI Assistant for Security](/solutions/security/ai/ai-assistant.md)
3838

3939
To learn more about configuring LLM connectors, refer to:
4040

@@ -43,7 +43,7 @@ To learn more about configuring LLM connectors, refer to:
4343
## Prompt best practices [rag-for-esql]
4444
Elastic AI Assistant allows you to take full advantage of the Elastic platform to improve your operations. It can help you write an ES|QL query for a particular use case, or answer general questions about how to use the platform. Its ability to assist you depends on the specificity and detail of your questions. The more context and detail you provide, the more tailored and useful its responses will be.
4545

46-
To maximize its usefulness, consider using more detailed prompts or asking for additional information. For instance, after asking for an ES|QL query example, you could ask a follow-up question like, “Could you give me some other examples?” You can also ask for clarification or further exposition, for example "Provide comments explaining the query you just gave."
46+
To maximize its usefulness, consider using more detailed prompts or asking for additional information. For instance, after asking for an ES|QL query example, you could ask a follow-up question like, “Could you give me some other examples?” You can also ask for clarification or further exposition, for example "Provide comments explaining the query you just gave".
4747

4848
In addition to practical advice, AI Assistant can offer conceptual advice, tips, and best practices for enhancing your security measures. You can ask it, for example:
4949

@@ -57,5 +57,5 @@ Elastic does not control third-party tools, and assumes no responsibility or lia
5757

5858
## Elastic Managed LLM [elastic-managed-llm-ai-assistant]
5959

60-
:::{include} ../../solutions/_snippets/elastic-managed-llm.md
60+
:::{include} /solutions/_snippets/elastic-managed-llm.md
6161
:::

explore-analyze/ai-features/llm-guides/llm-connectors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Elastic's [AI features](/explore-analyze/ai-features.md) work with the out-of-th
1818

1919
## Elastic Managed LLMs
2020

21-
:::{include} ../../../solutions/_snippets/elastic-managed-llm.md
21+
:::{include} /solutions/_snippets/elastic-managed-llm.md
2222
:::
2323

2424
## Connect to a third-party or self-managed LLM

explore-analyze/ai-features/manage-access-to-ai-assistant.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
applies_to:
3-
stack: ga 9.2
3+
stack: ga 9.2+
44
serverless: ga
55
products:
66
- id: kibana
@@ -15,7 +15,7 @@ The GenAI Settings page lets you control access to AI-powered features in the fo
1515

1616
- Manage which AI connectors are available in your environment.
1717
- Enable or disable AI Assistant and other AI-powered features in your environment.
18-
- {applies_to}`stack: ga 9.2` {applies_to}`serverless: unavailable` Specify in which Elastic solutions the `AI Assistant for Observability and Search` and the `AI Assistant for Security` appear.
18+
- {applies_to}`stack: ga 9.2+` {applies_to}`serverless: unavailable` Specify in which Elastic solutions the `AI Assistant for Observability and Search` and the `AI Assistant for Security` appear.
1919

2020
## Requirements
2121

@@ -39,7 +39,7 @@ The **GenAI Settings** page has the following settings:
3939

4040
:::
4141

42-
:::{applies-item} stack: ga 9.2
42+
:::{applies-item} stack: ga 9.2+
4343

4444
![GenAI Settings page for Stack](/explore-analyze/images/ai-assistant-settings-page.png "")
4545

@@ -51,11 +51,12 @@ The **GenAI Settings** page has the following settings:
5151
- If **Elastic Managed LLM** or a custom LLM connector is selected, AI-powered features will default to that connector regardless of which connector was used most recently in your environment.
5252
- **Disallow all other connectors**: When this setting is disabled, whenever you use an AI-powered feature you can select which connector should power it. Enable it to prevent connectors other than the default connector from being used in your space. Default setting: disabled.
5353
- **AI feature visibility**: This button opens the current Space's settings page, where you can specify which features are enabled in your environment, including AI-powered features.
54+
- **Chat experience**: {applies_to}`stack: preview 9.3+` Select whether to use AI Assistant or AI Agent. For information about choosing one, refer to [Compare AI Agent and AI Assistant](/explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md).
5455
- **AI Assistant visibility**: This setting allows you to choose which AI Assistants are available to use and where. There are several options:
5556
- **Only in their solutions** (default): The Security AI Assistant appears in {{elastic-sec}}, and the {{obs-ai-assistant}} appears in {{es}} and {{observability}}.
5657
- **{{obs-ai-assistant}} in other apps**: The {{obs-ai-assistant}} appears throughout {{kib}} regardless of solution. The Security AI Assistant does not appear anywhere.
5758
- **Security AI Assistant in other apps**: The Security AI Assistant appears throughout {{kib}} regardless of solution. The {{obs-ai-assistant}} does not appear anywhere.
58-
- **Hide all assistants**: Disables AI Assistant throughout {{kib}}.
59+
- **Hide all assistants**: Turns off AI Assistant throughout {{kib}}.
5960

6061
:::
6162

explore-analyze/toc.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,10 @@ toc:
188188
- file: ai-features/agent-builder/monitor-usage.md
189189
- file: ai-features/agent-builder/permissions.md
190190
- file: ai-features/agent-builder/limitations-known-issues.md
191-
- file: ai-features/ai-assistant.md
191+
- file: ai-features/ai-chat-experiences.md
192+
children:
193+
- hidden: ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md
194+
- file: ai-features/ai-chat-experiences/ai-assistant.md
192195
- file: ai-features/manage-access-to-ai-assistant.md
193196
- file: ai-features/llm-guides/llm-connectors.md
194197
children:
@@ -201,7 +204,6 @@ toc:
201204
- file: ai-features/llm-guides/connect-to-lmstudio-observability.md
202205
- file: ai-features/llm-guides/connect-to-lmstudio-security.md
203206
- file: ai-features/llm-guides/connect-to-vLLM.md
204-
- hidden: ai-features/ai-agent-or-ai-assistant.md
205207
- file: discover.md
206208
children:
207209
- file: discover/discover-get-started.md

get-started/the-stack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ With {{kib}}, you can:
8484
- Configure notifications for significant data events and track incidents with [alerts and cases](/explore-analyze/alerts-cases.md).
8585
- Manage resources such as processors, pipelines, data streams, trained models, and more.
8686

87-
Each solution or project type provides access to customized features in {{kib}} such as built-in dashboards and [AI assistants](/explore-analyze/ai-features/ai-assistant.md).
87+
Each solution or project type provides access to customized features in {{kib}} such as built-in dashboards and [AI assistants](/explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md).
8888

8989
{{kib}} also has [query tools](/explore-analyze/query-filter/tools.md) such as **Console**, which provides an interactive way to send requests directly to the {{es}} API and view the responses.
9090
For secure, automated access, you can create and manage API keys to authenticate your scripts and applications.

redirects.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,7 @@ redirects:
585585

586586
# Moved explore-analyze AI assistant content into a subfolder (docs-content-internal/issues/455)
587587
'explore-analyze/manage-access-to-ai-assistant.md': 'explore-analyze/ai-features/manage-access-to-ai-assistant.md'
588-
'explore-analyze/ai-assistant.md': 'explore-analyze/ai-features/ai-assistant.md'
588+
'explore-analyze/ai-assistant.md': 'explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md'
589589

590590
# Related to https://github.com/elastic/docs-content/pull/3685
591591
'deploy-manage/monitor/autoops/cc-cloud-connect-autoops-faq.md': 'deploy-manage/monitor/autoops/ec-autoops-faq.md'
@@ -632,6 +632,9 @@ redirects:
632632
'solutions/search/cross-cluster-search.md': 'explore-analyze/cross-cluster-search.md'
633633
'solutions/search/using-resolve-cluster-endpoint-before-cross-cluster-search.md': 'explore-analyze/cross-cluster-search/using-resolve-cluster-endpoint-before-cross-cluster-search.md'
634634

635+
# Related to https://github.com/elastic/docs-content/pull/4438
636+
'explore-analyze/ai-features/ai-agent-or-ai-assistant.md': 'explore-analyze/ai-features/ai-chat-experiences/ai-agent-or-ai-assistant.md'
637+
635638
# Related to agent builder restructure - moved agent builder docs to explore-analyze/
636639
'solutions/search/elastic-agent-builder.md': 'explore-analyze/ai-features/elastic-agent-builder.md'
637640
'solutions/search/agent-builder/tools/esql-tools.md': 'explore-analyze/ai-features/agent-builder/tools/esql-tools.md'
@@ -647,4 +650,7 @@ redirects:
647650
'solutions/search/agent-builder/monitor-usage.md': 'explore-analyze/ai-features/agent-builder/monitor-usage.md'
648651
'solutions/search/agent-builder/permissions.md': 'explore-analyze/ai-features/agent-builder/permissions.md'
649652
'solutions/search/agent-builder/programmatic-access.md': 'explore-analyze/ai-features/agent-builder/programmatic-access.md'
650-
'solutions/search/agent-builder/tools.md': 'explore-analyze/ai-features/agent-builder/tools.md'
653+
'solutions/search/agent-builder/tools.md': 'explore-analyze/ai-features/agent-builder/tools.md'
654+
655+
# Related to https://github.com/elastic/docs-content/pull/4438
656+
'explore-analyze/ai-features/ai-assistant.md': 'explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md'

0 commit comments

Comments
 (0)