forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Obs AI Assistant connector (elastic#183792)
## Summary Adds reference documentation about the Obs AI Assistant connector (requested in elastic#181282) Co-authored-by: Kibana Machine <[email protected]> (cherry picked from commit 310f4ff)
- Loading branch information
1 parent
5eb8d60
commit b0af268
Showing
4 changed files
with
73 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
docs/management/connectors/action-types/obs-ai-assistant.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
[[obs-ai-assistant-action-type]] | ||
== Observability AI Assistant connector and action | ||
++++ | ||
<titleabbrev>Observability AI Assistant</titleabbrev> | ||
++++ | ||
:frontmatter-description: Add a rule action that adds AI-driven insights and custom actions to your workflow. | ||
:frontmatter-tags-products: [kibana] | ||
:frontmatter-tags-content-type: [how-to] | ||
:frontmatter-tags-user-goals: [configure] | ||
|
||
preview::[] | ||
|
||
The Observability AI Assistant connector adds AI-driven insights and custom actions to your workflow. | ||
|
||
To learn how to interact with the assistant through this connector, refer to the {observability-guide}/obs-ai-assistant.html[Observability AI Assistant] documentation. | ||
|
||
[float] | ||
[[define-obs-ai-assistant-ui]] | ||
=== Create connectors in {kib} | ||
|
||
To use this connector, you must have been granted access to use the Observability AI Assistant feature. | ||
You cannot manage this connector in *{stack-manage-app} > {connectors-ui}* or by using APIs. | ||
You also cannot create an Observability AI Assistant <<pre-configured-connectors,preconfigured connector>>. | ||
It is available only when you're creating a rule in {kib}. | ||
For example: | ||
|
||
[role="screenshot"] | ||
image::management/connectors/images/obs-ai-assistant-action.png[Add an Observability AI Assistant action while creating a rule in the Observability UI] | ||
|
||
NOTE: You can have only one Observability AI Assistant action in each rule. | ||
|
||
[float] | ||
[[obs-ai-assistant-connector-configuration]] | ||
==== Connector configuration | ||
|
||
Observability AI Assistant connectors have the following configuration properties: | ||
|
||
Connector:: | ||
The name of the connector to use to send requests to your AI provider. | ||
For more information, refer to <<openai-action-type>> or <<bedrock-action-type>>. | ||
|
||
Message:: | ||
A message containing the prompt to send to the Observability AI Assistant. | ||
The message can specify a set of tasks for the assistant to perform, such as creating a graph or report, | ||
and it can call an available connector to send messages to an external system, such as Slack. | ||
|
||
NOTE: Currently you can only send messages to a Slack webhook. | ||
Support for additional connectors will be added in the future. | ||
|
||
For example, you can create a rule that sends the following prompt to the AI Assistant when an error count threshold is breached: | ||
|
||
[source,text] | ||
----- | ||
High error count alert has triggered. Execute the following steps: | ||
- create a graph of the error count for the service impacted by the alert | ||
for the last 24h | ||
- to help troubleshoot, recall past occurrences of this alert, plus any | ||
other active alerts. Generate a report with all the found information | ||
and send it to the Slack connector as a single message. Also include | ||
the link to this conversation in the report. | ||
----- | ||
|
||
[float] | ||
[[obs-ai-assistant-action-configuration]] | ||
=== Test connectors | ||
|
||
You cannot test or edit these connectors in {kib} or by using APIs. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters