Skip to content

Commit f1ff493

Browse files
authored
Merge branch 'main' into patch-2
2 parents 821e088 + 516617e commit f1ff493

18 files changed

+192
-115
lines changed
22.4 KB
Loading

solutions/search/agent-builder/a2a-server.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,10 @@ applies_to:
44
stack: preview 9.2
55
serverless:
66
elasticsearch: preview
7+
observability: unavailable
8+
security: unavailable
79
---
810

9-
:::{warning}
10-
These pages are currently hidden from the docs TOC and have `noindexed` meta headers.
11-
12-
**Go to the docs [landing page](/solutions/search/elastic-agent-builder.md).**
13-
:::
14-
1511
# Agent-to-Agent (A2A) server
1612

1713
The [**Agent-to-Agent (A2A) server**](https://github.com/a2aproject/A2A) enables external A2A clients to communicate with {{agent-builder}} agents.

solutions/search/agent-builder/agent-builder-agents.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,10 @@ applies_to:
44
stack: preview 9.2
55
serverless:
66
elasticsearch: preview
7+
observability: unavailable
8+
security: unavailable
79
---
810

9-
:::{warning}
10-
These pages are currently hidden from the docs TOC and have `noindexed` meta headers.
11-
12-
**Go to the docs [landing page](/solutions/search/elastic-agent-builder.md).**
13-
:::
14-
1511
# {{agent-builder}}: Agents
1612

1713
Agents are AI models (LLMs) defined with custom instructions and a set of assigned [tools](tools.md). Users [chat](chat.md) with agents using natural language, in the Agent Builder UI or programmatically.

solutions/search/agent-builder/chat.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
---
2-
navigation_title: "Agent Chat UI"
2+
navigation_title: "Chat"
33
applies_to:
44
stack: preview 9.2
55
serverless:
66
elasticsearch: preview
7+
observability: unavailable
8+
security: unavailable
79
---
810

9-
:::{warning}
10-
These pages are currently hidden from the docs TOC and have `noindexed` meta headers.
11-
12-
**Go to the docs [landing page](/solutions/search/elastic-agent-builder.md).**
13-
:::
14-
1511
# {{agent-builder}}: Agent Chat
1612

17-
**Agent Chat** is the synchronous chat interface for natural language conversations with your [agents](agent-builder-agents.md).
13+
**Agent Chat** is the chat interface for natural language conversations with your [agents](agent-builder-agents.md).
1814

1915
The chat GUI and programmatic interfaces enable real-time communication where you can ask questions, request data analysis, and receive immediate responses from your configured agents.
2016

solutions/search/agent-builder/get-started.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,15 @@ applies_to:
44
stack: preview 9.2
55
serverless:
66
elasticsearch: preview
7+
observability: unavailable
8+
security: unavailable
79
---
810

9-
:::{warning}
10-
These pages are currently hidden from the docs TOC and have `noindexed` meta headers.
11-
12-
**Go to the docs [landing page](/solutions/search/elastic-agent-builder.md).**
13-
:::
14-
1511
# Get started with {{agent-builder}}
1612

17-
:::{tip}
18-
Refer to the [overview page](../elastic-agent-builder.md) for the full list of Agent Builder docs.
19-
:::
20-
% TODO: Remove this tip when unhide pages
21-
2213
Learn how to get started by enabling the {{agent-builder}} features and begin chatting with your data.
2314

24-
:::::{stepper}
15+
::::::{stepper}
2516
::::{step} Set up an Elastic deployment
2617

2718
If you don't already have an Elastic deployment, refer to [Select your deployment type](/solutions/search/get-started.md#choose-your-deployment-type).
@@ -33,25 +24,39 @@ You can set up a new [space](/deploy-manage/manage-spaces.md) to use the solutio
3324

3425
::::
3526

36-
::::{step} Enable {{agent-builder}}
27+
:::::{step} Enable {{agent-builder}}
3728

38-
{{agent-builder}} is turned off by default in the initial release, so you need to enable the feature to get started.
29+
::::{applies-switch}
30+
31+
:::{applies-item} { "serverless": "preview", "elasticsearch" }
32+
33+
{{agent-builder}} is enabled by default in serverless {{es}} projects.
34+
35+
Find **Agents** in the navigation menu to begin using the feature, or search for **Agents** in the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
36+
37+
:::
38+
39+
:::{applies-item} stack: preview 9.2
40+
41+
You have to enable {{agent-builder}} to get started on non-serverless deployments.
3942

4043
You can enable the features using the UI:
4144

42-
1. Navigate to **Agent Builder** under **AI** using the navigation menu or the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
45+
1. Search for **AI / Agent Builder** in the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
4346
2. Toggle **{{agent-builder}}** to on.
4447
3. Select **Save changes**.
4548

46-
Refresh the browser page and find **Agents** in the navigation menu to begin using the feature.
47-
You can also search for **Agent Builder** in the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md).
49+
Find **Agents** in the navigation menu to begin using the feature, or search for **Agents** in the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
4850

51+
:::
4952

5053
::::
5154

55+
:::::
56+
5257
::::{step} Ingest some data
5358

54-
Before you begin with agents, you need some data in your {{es}} cluster. Otherwise, you will be chatting to the underlying LLM without any retrieval-augmented context.
59+
Before you begin with agents, you need some data in {{es}}. Otherwise, you will be chatting to the underlying LLM without any retrieval-augmented context.
5560

5661
To learn about adding data for search use cases, go to [](/solutions/search/ingest-for-search.md).
5762
For a broader overview of ingestion options, go to [](/manage-data/ingest.md).
@@ -74,10 +79,16 @@ Learn more in [Agent Chat](chat.md).
7479

7580
::::
7681

82+
::::{step} Configure model (optional)
83+
84+
By default, {{agent-builder}} uses the Elastic Managed LLM. To use a different model, refer to [model selection and configuration](models.md).
85+
86+
::::
87+
7788
::::{step} Begin building agents and tools
7889

7990
Once you've tested the default **Elastic AI Agent** with the [built-in Elastic tools](tools.md), you can begin [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.
8091

8192
::::
8293

83-
:::::
94+
::::::

solutions/search/agent-builder/kibana-api.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,10 @@ applies_to:
44
stack: preview 9.2
55
serverless:
66
elasticsearch: preview
7+
observability: unavailable
8+
security: unavailable
79
---
810

9-
:::{warning}
10-
These pages are currently hidden from the docs TOC and have `noindexed` meta headers.
11-
12-
**Go to the docs [landing page](/solutions/search/elastic-agent-builder.md).**
13-
:::
14-
1511
# Work with {{agent-builder}} using the APIs
1612

1713
This page provides a quick overview of the main Kibana API endpoints for {{agent-builder}}. For complete details including all available parameters, request/response schemas, and error handling, refer to the [Kibana serverless API reference](https://www.elastic.co/docs/api/doc/serverless/group/endpoint-agent-builder).

solutions/search/agent-builder/limitations-known-issues.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,31 @@ applies_to:
44
stack: preview 9.2
55
serverless:
66
elasticsearch: preview
7+
observability: unavailable
8+
security: unavailable
79
---
810

9-
:::{warning}
10-
These pages are currently hidden from the docs TOC and have `noindexed` meta headers.
11-
12-
**Go to the docs [landing page](/solutions/search/elastic-agent-builder.md).**
13-
:::
14-
1511
# Limitations and known issues in {{agent-builder}}
1612

1713
## Limitations
1814

19-
### Agent Builder not enabled by default
15+
### Feature availability
2016

21-
While in private technical preview, {{agent-builder}} is not enabled by default. Refer to [Get started](get-started.md#enable-agent-builder) for instructions.
17+
#### Non-serverless deployments
2218

23-
### Model selection
19+
{{agent-builder}} is enabled by default in {{serverless-full}} for {{es}} projects.
2420

25-
Initially, {{agent-builder}} only supports working with the [Elastic Managed LLM](kibana://reference/connectors-kibana/elastic-managed-llm.md) running on the [Elastic Inference Service](/explore-analyze/elastic-inference/eis.md) {applies_to}`serverless: preview` {applies_to}`ess: preview 9.2`.
21+
However, it must be enabled for non-serverless deployments {applies_to}`stack: preview 9.2`. Refer to [Get started](get-started.md#enable-agent-builder) for instructions.
2622

27-
Learn about [pricing](https://www.elastic.co/pricing/serverless-search) for the Elastic Managed LLM.
23+
#### Serverless deployments
24+
25+
In the first release of {{agent-builder}} on serverless, the feature is **only available on {{es}} projects**.
2826

2927
## Known issues
3028

3129
### Incompatible LLMs
3230

33-
While Elastic offers LLM [connectors](kibana://reference/connectors-kibana.md) for many different vendors and models, not all LLMs are robust enough to be used with {{agent-builder}}. We recommend using the [Elastic Managed LLM](kibana://reference/connectors-kibana/elastic-managed-llm.md) (the default).
31+
While Elastic offers LLM [connectors](kibana://reference/connectors-kibana.md) for many different vendors and models, not all LLMs are robust enough to be used with {{agent-builder}}. We recommend using the [Elastic Managed LLM](kibana://reference/connectors-kibana/elastic-managed-llm.md) (the default). Learn more in [](models.md).
3432

3533
The following errors suggest your selected model may not be compatible with {{agent-builder}}:
3634

@@ -46,6 +44,8 @@ Error executing agent: No tool calls found in the response.
4644

4745
{{esql}} tools are subject to the current limitations of the {{esql}} language itself. For example, [named parameters](elasticsearch://reference/query-languages/esql/esql-syntax.md#esql-function-named-params) (`?parameter_name`) do not currently work with the `LIKE` and `RLIKE` operators ([issue #131356](https://github.com/elastic/elasticsearch/issues/131356)).
4846

47+
For non-serverless deployments, ensure your cluster supports the {{esql}} features you intend to use.
48+
4949
For a complete list of {{esql}} limitations, refer to the the [{{esql}} limitations documentation](elasticsearch://reference/query-languages/esql/limitations.md).
5050

5151
### Misinterpreted SQL syntax as ES|QL
@@ -67,4 +67,4 @@ This results in parsing errors like this:
6767
]
6868
```
6969

70-
70+

solutions/search/agent-builder/mcp-server.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,12 @@ applies_to:
44
stack: preview 9.2
55
serverless:
66
elasticsearch: preview
7+
observability: unavailable
8+
security: unavailable
79
---
810

911
# Model Context Protocol (MCP) server
1012

11-
:::{warning}
12-
These pages are currently hidden from the docs TOC and have `noindexed` meta headers.
13-
14-
**Go to the docs [landing page](/solutions/search/elastic-agent-builder.md).**
15-
:::
16-
1713
The [**Model Context Protocol (MCP) server**](https://modelcontextprotocol.io/docs/getting-started/intro) provides a standardized interface for external clients to access {{agent-builder}} tools.
1814

1915
## MCP server endpoint
Lines changed: 84 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,94 @@
11
---
2-
navigation_title: "Use different models"
2+
navigation_title: "Models"
33
applies_to:
44
stack: preview 9.2
55
serverless:
66
elasticsearch: preview
7+
observability: unavailable
8+
security: unavailable
79
---
810

9-
:::{warning}
10-
These pages are currently hidden from the docs TOC and have `noindexed` meta headers.
11+
# Using different models in {{agent-builder}}
1112

12-
**Go to the docs [landing page](/solutions/search/elastic-agent-builder.md).**
13+
{{agent-builder}} uses large language models (LLMs) to power agent reasoning and decision-making. By default, agents use the Elastic Managed LLM, but you can configure other models through Kibana connectors.
14+
15+
## Default model configuration
16+
17+
By default, {{agent-builder}} uses the Elastic Managed LLM connector running on the [Elastic Inference Service](/explore-analyze/elastic-inference/eis.md) {applies_to}`serverless: preview` {applies_to}`ess: preview 9.2`.
18+
19+
This managed service requires zero setup and no additional API key management.
20+
21+
Learn more about the [Elastic Managed LLM connector](kibana://reference/connectors-kibana/elastic-managed-llm.md) and [pricing](https://www.elastic.co/pricing).
22+
23+
## Change the default model
24+
25+
By default, {{agent-builder}} uses the Elastic Managed LLM. To use a different model, select a configured connector and set it as the default.
26+
27+
### Use a pre-configured connector
28+
29+
1. Search for **GenAI Settings** in the global search field
30+
2. Select your preferred connector from the **Default AI Connector** dropdown
31+
3. Save your changes
32+
33+
### Create a new connector in the UI
34+
35+
1. Find connectors under **Alerts and Insights / Connectors** in the [global search bar](/explore-analyze/find-and-organize/find-apps-and-objects.md)
36+
2. Select **Create Connector** and select your model provider
37+
3. Configure the connector with your API credentials and preferred model
38+
4. Search for **GenAI Settings** in the global search field
39+
5. Select your new connector from the **Default AI Connector** dropdown under **Custom connectors**
40+
6. Save your changes
41+
42+
For detailed instructions on creating connectors, refer to [Connectors](https://www.elastic.co/docs/deploy-manage/manage-connectors).
43+
44+
Learn more about [preconfigured connectors](https://www.elastic.co/docs/reference/kibana/connectors-kibana/pre-configured-connectors).
45+
46+
#### Connect a local LLM
47+
48+
You can connect a locally hosted LLM to Elastic using the OpenAI connector. This requires your local LLM to be compatible with the OpenAI API format.
49+
50+
Refer to the [OpenAI connector documentation](kibana://reference/connectors-kibana/openai-action-type.md) for detailed setup instructions.
51+
52+
## Connectors API
53+
54+
For programmatic access to connector management, refer to the [Connectors API documentation]({{kib-serverless-apis}}group/endpoint-connectors).
55+
56+
## Recommended models
57+
58+
{{agent-builder}} requires models with strong reasoning and tool-calling capabilities. State-of-the-art models perform significantly better than smaller or older models.
59+
60+
The following models are known to work well with {{agent-builder}}:
61+
62+
- **OpenAI**: GPT-4.1, GPT-4o
63+
- **Anthropic**: Claude Sonnet 4.5, Claude Sonnet 4, Claude Sonnet 3.7
64+
- **Google**: Gemini 2.5 Pro
65+
66+
### Why model quality matters
67+
68+
Agent Builder relies on advanced LLM capabilities including:
69+
70+
- **Function calling**: Models must accurately select appropriate tools and construct valid parameters from natural language requests
71+
- **Multi-step reasoning**: Agents need to plan, execute, and adapt based on tool results across multiple iterations
72+
- **Structured output**: Models must produce properly formatted responses that the agent framework can parse
73+
74+
Smaller or less capable models may produce errors like:
75+
76+
```console-response
77+
Error: Invalid function call syntax
78+
```
79+
80+
```console-response
81+
Error executing agent: No tool calls found in the response.
82+
```
83+
84+
While any chat-completion-compatible connector can technically be configured, we strongly recommend using state-of-the-art models for reliable agent performance.
85+
86+
:::{note}
87+
GPT-4o-mini and similar smaller models are not recommended for {{agent-builder}} as they lack the necessary capabilities for reliable agent workflows.
1388
:::
1489

15-
# Using different models in {{agent-builder}}
90+
## Related resources
91+
92+
- [Limitations and known issues](limitations-known-issues.md): Current limitations around model selection
93+
- [Get started](get-started.md): Initial setup and configuration
94+
- [Connectors](/deploy-manage/manage-connectors.md): Detailed connector configuration guide

solutions/search/agent-builder/programmatic-access.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,10 @@ applies_to:
44
stack: preview 9.2
55
serverless:
66
elasticsearch: preview
7+
observability: unavailable
8+
security: unavailable
79
---
810

9-
:::{warning}
10-
These pages are currently hidden from the docs TOC and have `noindexed` meta headers.
11-
12-
**Go to the docs [landing page](/solutions/search/elastic-agent-builder.md).**
13-
:::
14-
1511
# Work programmatically with {{agent-builder}}
1612

1713
{{agent-builder}} provides comprehensive integration options for programmatic access and automation.

0 commit comments

Comments
 (0)