Skip to content

Commit d4039c5

Browse files
authored
[WIP] Agent Builder initial docs (hidden from TOC and search engines) (elastic#2857)
> [!WARNING] > We are merging this in `hidden` mode. The pages will be live but not indexed by search engines or visible in the docs TOC/nav.
1 parent 6cb095f commit d4039c5

17 files changed

+838
-1
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
.artifacts
33
.DS_store
44

5+
# Jetbrains files
6+
.idea
7+
*.iml
8+
59
# Add LLM/AI related files
610
AGENTS.md
711
.github/copilot-instructions.md

docset.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,4 +294,6 @@ subs:
294294
ece-apis: https://www.elastic.co/docs/api/doc/cloud-enterprise/
295295
intake-apis: https://www.elastic.co/docs/api/doc/observability-serverless/
296296
models-app: "Trained Models"
297-
kube-stack-version: 0.6.3
297+
agent-builder: "Elastic Agent Builder"
298+
kube-stack-version: 0.6.3
299+
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
navigation_title: "A2A server"
3+
applies_to:
4+
stack: preview 9.2
5+
serverless:
6+
elasticsearch: preview
7+
---
8+
9+
:::{warning}
10+
WIP
11+
12+
These pages are hidden from the docs TOC and have `noindexed` meta headers.
13+
:::
14+
15+
# Agent-to-Agent (A2A) server
16+
17+
The [**Agent-to-Agent (A2A) server**](https://github.com/a2aproject/A2A) enables external A2A clients to communicate with {{agent-builder}} agents.
18+
19+
## Agent cards endpoint
20+
21+
Returns metadata for a specific agent. The `agentId` is a path parameter that corresponds to your agent IDs:
22+
23+
```
24+
GET /api/agent_builder/a2a/{agentId}.json
25+
```
26+
27+
## A2A protocol endpoint
28+
29+
Interact with agents following the A2A protocol specification:
30+
31+
```
32+
POST /api/agent_builder/a2a/{agentId}
33+
```
34+
35+
:::{important}
36+
Both A2A endpoints require API key authentication. For more information about the A2A protocol, see the [A2A protocol specification](https://a2aprotocol.ai/docs/guide/a2a-protocol-specification-python#protocol-flow-diagram).
37+
:::
Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
navigation_title: "Agents"
3+
applies_to:
4+
stack: preview 9.2
5+
serverless:
6+
elasticsearch: preview
7+
---
8+
9+
:::{warning}
10+
WIP
11+
12+
These pages are hidden from the docs TOC and have `noindexed` meta headers.
13+
:::
14+
15+
# {{agent-builder}}: Agents
16+
17+
Agents engage in natural language conversations with users and interact with your {{es}} data through tools.
18+
Fundamentally, an agent is defined by its custom instructions and the set of tools it's assigned.
19+
20+
Each agent manages the conversation flow, interprets user requests, and provides responses based on its configured tools, instructions, and behavior settings.
21+
22+
## How agents work
23+
24+
When you ask a question to an agent, it analyzes your request, selects the most appropriate tool, and determines the right arguments to use. After receiving results, the agent evaluates the information and decides whether to use additional tools or formulate a response. This iterative process of tool selection, execution, and analysis continues until the agent can provide a complete answer.
25+
26+
{{agent-builder}} includes a default agent (named `Elastic AI Agent`) with access to all built-in tools. You can create specialized agents with custom instructions and selected tools to address specific use cases or workflows.
27+
28+
## Manage your agents
29+
30+
The **Agents** page provides a centralized view of all your agents. From this page you can:
31+
32+
- View all your agents with their names and labels
33+
- Search for specific agents using the search bar
34+
- Filter agents by labels using the **Labels** dropdown
35+
- Create new agents using the **+ New agent** button
36+
- Start chatting with an agent or perform other actions
37+
- **Elastic AI Agent**: you can **chat** or **clone** the default agent using the chat or clone buttons.
38+
:::{image} images/chat-and-clone-buttons.png
39+
:alt: Chat with agent and clone agent buttons
40+
:width: 120px
41+
:::
42+
- **Custom agents**: You can **chat**, **edit**, **clone**, or **delete** an agent from the management overview.
43+
:::{image} images/chat-edit-clone-delete.png
44+
:alt: Agent context menu showing Chat, Edit, Clone, and Delete options
45+
:width: 130px
46+
:::
47+
48+
## How to create a new agent
49+
50+
Follow these steps to create a new agent:
51+
52+
:::::{stepper}
53+
::::{step} Navigate to the Agents page
54+
55+
Navigate to the **Agents** page to access the agent management interface.
56+
57+
::::
58+
59+
::::{step} Create a new agent
60+
61+
Click the **New agent** button to start creating a new agent.
62+
63+
:::{image} images/new-agent-button.png
64+
:alt: Click the New agent button to create a new agent
65+
:width: 150px
66+
:::
67+
68+
69+
::::
70+
71+
::::{step} Configure essential settings
72+
73+
Configure the essential agent settings in the **settings** tab:
74+
75+
1. Enter an **Agent ID**, a unique identifier for reference in code.
76+
1. Add **Custom instructions**.<br><br>Custom instructions define the agent's personality and determine how it will interact with users and perform tasks.
77+
78+
:::{note}
79+
Your custom instructions are added to the system prompt to define the agent's behavior. The system prompt enables core features like visualization and citations.
80+
:::
81+
1. Set the **Display name** that users will see.
82+
1. Add a **Display description** to explain the agent's purpose
83+
84+
::::
85+
86+
::::{step} Assign tools
87+
88+
Switch to the **Tools** tab to assign [tools](tools.md) to your agent.
89+
90+
Select the combination of built-in and custom tools available to the agent, based on your use case.
91+
92+
::::
93+
94+
::::{step} Customize appearance (optional)
95+
96+
Optionally customize the agent's appearance and organization:
97+
98+
- Add **Labels** to organize your agents
99+
- Choose an **Avatar color** and **Avatar symbol** to help visually distinguish the agent
100+
101+
::::
102+
103+
::::{step} Save your changes
104+
105+
Click **Save** to create your agent, or **Save and chat** to create the agent and immediately start a conversation with it.
106+
107+
:::{image} images/save-and-chat-buttons.png
108+
:alt: Save and Save and chat buttons
109+
:width: 270px
110+
:::
111+
112+
::::
113+
:::::
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
navigation_title: "Agent Chat UI"
3+
applies_to:
4+
stack: preview 9.2
5+
serverless:
6+
elasticsearch: preview
7+
---
8+
9+
:::{warning}
10+
WIP
11+
12+
These pages are hidden from the docs TOC and have `noindexed` meta headers.
13+
:::
14+
15+
# {{agent-builder}}: Agent Chat UI
16+
17+
18+
The **Agent Chat** UI is the synchronous chat interface for interacting with agents through natural language. The chat UI enables real-time communication where you can ask questions, request data analysis, and receive immediate responses from your configured agents.
19+
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
navigation_title: "Get started"
3+
applies_to:
4+
stack: preview 9.2
5+
serverless:
6+
elasticsearch: preview
7+
---
8+
9+
:::{warning}
10+
WIP
11+
12+
These pages are hidden from the docs TOC and have `noindexed` meta headers.
13+
:::
14+
15+
# Get started with {{agent-builder}}
16+
17+
:::{tip}
18+
See the [overview page](../elastic-agent-builder.md) for full list of docs pages.
19+
:::
20+
% TODO: Delete this tip when unhide pages
21+
22+
Learn how get started by enabling the {{agent-builder}} features and begin chatting with your data.
23+
24+
:::::{stepper}
25+
::::{step} Set up an Elastic deployment
26+
27+
If you don't already have an Elastic deployment, refer to [Choose your deployment type](/solutions/search/get-started.md#choose-your-deployment-type).
28+
29+
:::{note}
30+
For {{ech}} deployments, make sure you are using the solution navigation instead of classic navigation.
31+
You can set up a new [space](/deploy-manage/manage-spaces.md) to use the solution nav.
32+
:::
33+
34+
::::
35+
36+
::::{step} Enable {{agent-builder}}
37+
38+
{{agent-builder}} is disabled by default in the initial release, so you'll need to enable the feature to get started.
39+
40+
You can enable the features using the UI:
41+
42+
1. Navigate to **Stack Management > Settings**
43+
2. Find **AI > Agent Builder** in the left-hand navigation
44+
3. Toggle **{{agent-builder}}** to on
45+
4. Click **Save changes**
46+
47+
Refresh the browser page and find **Agents** in the navigation menu to start using the feature.
48+
You can also search for **Agent Builder** in the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md).
49+
50+
51+
::::
52+
53+
::::{step} Ingest some data
54+
55+
Before you get started with agents, you need some data in your {{es}} cluster. Otherwise, you'll just be chatting to the underlying LLM without any retrieval-augmented context.
56+
57+
To learn about adding data for search use cases, go to [](/solutions/search/ingest-for-search.md).
58+
For a broader overview of ingestion options, go to [](/manage-data/ingest.md).
59+
60+
:::{tip}
61+
If you're not ready to add your own data, you can use the Elastic [sample data](/manage-data/ingest/sample-data.md) or create small data sets when you follow the instructions in the [quickstarts](/solutions/search/get-started/quickstarts.md).
62+
% TODO: we can link to a an agent builder tutorial if we add one in the docs
63+
:::
64+
65+
::::
66+
67+
::::{step} Start chatting
68+
69+
The **Agent Chat** UI provides a conversational interface where you can interact with agents and explore your data using natural language. {{agent-builder}} includes a default agent named `Elastic AI Agent` with access to all built-in tools, so you can start chatting immediately.
70+
71+
Learn more in [Agent Chat](chat.md).
72+
73+
74+
::::
75+
76+
::::{step} Start building agents and tools
77+
78+
Once you've tested the default **Elastic AI Agent** with the [built-in Elastic tools](tools.md), you'll want to start [building your own agents](agent-builder-agents.md#create-a-new-agent) with custom instructions and [creating your own tools](tools.md#create-custom-tools) to assign them.
79+
80+
::::
81+
82+
:::::
5.69 KB
Loading
19.9 KB
Loading
9.33 KB
Loading
13.8 KB
Loading

0 commit comments

Comments
 (0)