Skip to content

Commit 3443f90

Browse files
Merge branch 'main' into issue-5291-expand-flyout-removed
2 parents 4fa4b76 + f69a2df commit 3443f90

File tree

165 files changed

+1059
-1056
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

165 files changed

+1059
-1056
lines changed

.github/workflows/co-docs-builder.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,16 @@ on:
2121
jobs:
2222
publish:
2323
if: contains(github.event.pull_request.labels.*.name, 'ci:doc-build')
24-
uses: elastic/workflows/.github/workflows/docs-elastic-co-publish.yml@main
24+
uses: elastic/workflows/.github/workflows/docs-versioned-publish.yml@main
2525
with:
26-
subdirectory: 'docs/serverless/'
26+
# Refers to Vercel project
27+
project-name: elastic-dot-co-docs-preview-docs
28+
# Which prebuild step (dev or not)
29+
prebuild: wordlake-docs
30+
# Docsmobile project dir
31+
site-repo: docs-site
2732
secrets:
2833
VERCEL_GITHUB_TOKEN: ${{ secrets.VERCEL_GITHUB_TOKEN_PUBLIC }}
2934
VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN_PUBLIC }}
3035
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID_PUBLIC }}
31-
VERCEL_PROJECT_ID_DOCS_CO: ${{ secrets.VERCEL_PROJECT_ID_DOCS_CO_PUBLIC }}
36+
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID_ELASTIC_DOT_CO_DOCS_PRODUCTION_PUBLIC }}

docs/assistant/ai-alert-triage.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[assistant-triage]]
2-
= Triage alerts with Elastic AI Assistant
2+
= Triage alerts
33
Elastic AI Assistant can help you enhance and streamline your alert triage workflows by assessing multiple recent alerts in your environment, and helping you interpret an alert and its context.
44

55
When you view an alert in {elastic-sec}, details such as related documents, hosts, and users appear alongside a synopsis of the events that triggered the alert. This data provides a starting point for understanding a potential threat. AI Assistant can answer questions about this data and offer insights and actionable recommendations to remediate the issue.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[[esql-queries-assistant]]
2+
= Generate, customize, and learn about {esql} queries
3+
4+
:frontmatter-description: Elastic AI Assistant can help you write ES|QL queries.
5+
:frontmatter-tags-products: [security]
6+
:frontmatter-tags-content-type: [guide]
7+
:frontmatter-tags-user-goals: [get-started]
8+
9+
Elastic AI Assistant can help you learn about and leverage the Elasticsearch Query Language ({esql}).
10+
11+
With AI Assistant's <<ai-assistant-knowledge-base, {esql} knowledge base>> enabled, AI Assistant benefits from specialized training data that enables it to answer questions related to {esql} at an expert level.
12+
13+
AI Assistant can help with {esql} in many ways, including:
14+
15+
* **Education and training**: AI Assistant can serve as a powerful {esql} learning tool. Ask it for examples, explanations of complex queries, and best practices.
16+
* **Writing new queries**: Prompt AI Assistant to provide a query that accomplishes a particular task, and it will generate a query matching your description. For example: "Write a query to identify documents with `curl.exe` usage and calculate the sum of `destination.bytes`" or "What query would return all user logins to [a host] in the last six hours?"
17+
* **Providing feedback to optimize existing queries**: Send AI Assistant a query you want to work on and ask it for improvements, refactoring, a general assessment, or to optimize the query's performance with large data sets.
18+
* **Customizing queries for your environment**: Since each environment is unique, you may need to customize queries that you used in other contexts. AI Assistant can suggest necessary modifications based on contextual information you provide.
19+
* **Troubleshooting**: Having trouble with a query or getting unexpected results? Ask AI Assistant to help you troubleshoot.
20+
21+
In these ways and others, AI Assistant can enable you to make use of {esql}'s advanced search capabilities to accomplish goals across {elastic-sec}.
22+
23+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
[[assistant-use-cases]]
2+
= AI Assistant use cases
3+
4+
Elastic AI Assistant's flexibility means you can use it for many different purposes. These topics describe some of the possible uses for AI Assistant within {elastic-sec}:
5+
6+
* <<attack-discovery-ai-assistant-incident-reporting>>
7+
* <<assistant-triage>>
8+
* <<esql-queries-assistant>>
9+
10+
For general information about AI Assistant, refer to <<security-assistant, AI Assistant>>.

docs/assistant/azure-openai-setup.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Now, set up the Azure OpenAI model:
7272
** If you select `gpt-4`, set the **Model version** to `0125-Preview`.
7373
** If you select `gpt-4-32k`, set the **Model version** to `default`.
7474
+
75-
IMPORTANT: The models available to you will depend on https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability[region availability]. For best results, use `GPT 4 Turbo version 0125-preview` or `GPT 4-32k` with the maximum Tokens-Per-Minute (TPM) capacity. In most regions, the GPT 4 Turbo model offers the largest supported context window.
75+
IMPORTANT: The models available to you depend on https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability[region availability]. For best results, use `GPT-4o 2024-05-13` with the maximum Tokens-Per-Minute (TPM) capacity. For more information on how different models perform for different tasks, refer to the <<llm-performance-matrix>>.
7676
+
7777
. Under **Deployment type**, select **Standard**.
7878
. Name your deployment.

docs/assistant/connect-to-openai.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This page provides step-by-step instructions for setting up an OpenAI connector
1212

1313
Before creating an API key, you must choose a model. Refer to the https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4[OpenAI docs] to select a model. Take note of the specific model name (for example `gpt-4-turbo`); you'll need it when configuring {kib}.
1414

15-
NOTE: `GPT-4 Turbo` offers increased performance. `GPT-4` and `GPT-3.5` are also supported.
15+
NOTE: `GPT-4o` offers increased performance over previous versions. For more information on how different models perform for different tasks, refer to the <<llm-performance-matrix>>.
1616

1717
[discrete]
1818
=== Create an API key
@@ -51,6 +51,7 @@ To integrate with {kib}:
5151
. Provide a name for your connector, such as `OpenAI (GPT-4 Turbo Preview)`, to help keep track of the model and version you are using.
5252
. Under **Select an OpenAI provider**, choose **OpenAI**.
5353
. The **URL** field can be left as default.
54+
. Under **Default model**, specify which https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4[model] you want to use.
5455
. Paste the API key that you created into the corresponding field.
5556
. Click **Save**.
5657

Loading
Loading
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[[llm-connector-guides]]
2+
= Set up connectors for large language models (LLM)
3+
4+
This section contains instructions for setting up connectors for LLMs so you can use <<security-assistant, Elastic AI Assistant>> and <<attack-discovery, Attack discovery>>.
5+
6+
Setup guides are available for the following LLM providers:
7+
8+
* <<assistant-connect-to-azure-openai, Azure OpenAI>>
9+
* <<assistant-connect-to-bedrock, Amazon Bedrock>>
10+
* <<assistant-connect-to-openai, OpenAI>>
11+

docs/assistant/security-assistant.asciidoc

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,11 @@
88

99
The Elastic AI Assistant utilizes generative AI to bolster your cybersecurity operations team. It allows users to interact with {elastic-sec} for tasks such as alert investigation, incident response, and query generation or conversion using natural language and much more.
1010

11-
AI Assistant can connect to multiple LLM providers so you can select the best model for your needs.
12-
1311
[role="screenshot"]
1412
image::images/assistant-basic-view.png[Image of AI Assistant chat window,90%]
1513

1614
WARNING: The Elastic AI Assistant is designed to enhance your analysis with smart dialogues. Its capabilities are still developing. Users should exercise caution as the quality of its responses might vary. Your insights and feedback will help us improve this feature. Always cross-verify AI-generated advice for accuracy.
1715

18-
.Recommended models
19-
[sidebar]
20-
--
21-
While AI Assistant is compatible with many different models, our testing found increased quality with Azure 32k, and faster and more cost-effective responses with Claude 3 Haiku and OpenAI GPT4 Turbo.
22-
--
23-
2416
.Requirements
2517
[sidebar]
2618
--
@@ -50,9 +42,13 @@ NOTE: Elastic can automatically anonymize event data that you provide to AI Assi
5042
[[set-up-ai-assistant]]
5143
== Set up AI Assistant
5244

53-
You must create a generative AI connector before you can use AI Assistant.
45+
You must create a generative AI connector before you can use AI Assistant. AI Assistant can connect to multiple large language model (LLM) providers so you can select the best model for your needs. To set up a connector, refer to <<llm-connector-guides,LLM connector setup guides>>.
5446

55-
For more information about setting up generative AI connectors, refer to <<assistant-connect-to-bedrock>>, <<assistant-connect-to-openai>>, or <<assistant-connect-to-azure-openai>>.
47+
.Recommended models
48+
[sidebar]
49+
--
50+
While AI Assistant is compatible with many different models, our testing found increased quality with Azure 32k, and faster, more cost-effective responses with Claude 3 Haiku and OpenAI GPT4 Turbo. For more information, refer to the <<llm-performance-matrix>>.
51+
--
5652

5753
[discrete]
5854
[[start-chatting]]
@@ -193,8 +189,14 @@ In addition to practical advice, AI Assistant can offer conceptual advice, tips,
193189
* “I need to monitor for unusual file creation patterns that could indicate ransomware activity. How would I construct this query using EQL?”
194190

195191

196-
include::ai-alert-triage.asciidoc[leveloffset=+1]
192+
include::assistant-use-cases.asciidoc[leveloffset=+1]
193+
include::ai-alert-triage.asciidoc[leveloffset=+2]
194+
include::use-attack-discovery-ai-assistant-incident-reporting.asciidoc[leveloffset=+2]
195+
include::ai-esql-queries.asciidoc[leveloffset=+2]
196+
197+
include::llm-connector-guides.asciidoc[leveloffset=+1]
198+
include::azure-openai-setup.asciidoc[leveloffset=+2]
199+
include::connect-to-openai.asciidoc[leveloffset=+2]
200+
include::connect-to-bedrock.asciidoc[leveloffset=+2]
201+
197202
include::llm-performance-matrix.asciidoc[leveloffset=+1]
198-
include::azure-openai-setup.asciidoc[leveloffset=+1]
199-
include::connect-to-openai.asciidoc[leveloffset=+1]
200-
include::connect-to-bedrock.asciidoc[leveloffset=+1]

0 commit comments

Comments
 (0)