Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Obs AI Assistant connector #183792

Merged
merged 10 commits into from
May 31, 2024
6 changes: 5 additions & 1 deletion docs/management/action-types.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@ a| <<teams-action-type,Microsoft Teams>>

| Send a message to a Microsoft Teams channel.

a| <<obs-ai-assistant-action-type,Observability AI Assistant>>

| Add AI-driven insights and custom actions to your workflow.

a| <<openai-action-type,OpenAI>>

| Send a request to OpenAI.
Expand Down Expand Up @@ -144,7 +148,7 @@ image::images/connector-filter-by-type.png[Filtering the connector list by types
// NOTE: This is an autogenerated screenshot. Do not edit it directly.

You can delete individual connectors using the trash icon. Alternatively, select
multiple connectors and delete them in bulk using the *Delete* button.
multiple connectors and delete them in bulk using the *Delete* button.

[role="screenshot"]
image::images/connector-delete.png[Deleting connectors individually or in bulk]
Expand Down
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.
1 change: 1 addition & 0 deletions docs/management/connectors/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ include::action-types/resilient.asciidoc[leveloffset=+1]
include::action-types/index.asciidoc[leveloffset=+1]
include::action-types/jira.asciidoc[leveloffset=+1]
include::action-types/teams.asciidoc[leveloffset=+1]
include::action-types/obs-ai-assistant.asciidoc[leveloffset=+1]
include::action-types/openai.asciidoc[leveloffset=+1]
include::action-types/opsgenie.asciidoc[leveloffset=+1]
include::action-types/pagerduty.asciidoc[leveloffset=+1]
Expand Down