Skip to content

Commit

Permalink
[8.14] [DOCS] Obs AI Assistant connector (#183792) (#184609)
Browse files Browse the repository at this point in the history
# Backport

This will backport the following commits from `main` to `8.14`:
- [[DOCS] Obs AI Assistant connector
(#183792)](#183792)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"DeDe
Morton","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-05-31T18:26:12Z","message":"[DOCS]
Obs AI Assistant connector (#183792)\n\n## Summary\r\n\r\nAdds reference
documentation about the Obs AI Assistant connector\r\n(requested in
#181282)\r\n\r\nCo-authored-by: Kibana Machine
<[email protected]>","sha":"310f4ff79cbe5d2ec7e699d9ffb3aefdc51da9ec","branchLabelMapping":{"^v8.15.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","docs","Feature:Actions/ConnectorTypes","Team:obs-knowledge","v8.14.0","v8.15.0"],"title":"[DOCS]
Obs AI Assistant
connector","number":183792,"url":"https://github.com/elastic/kibana/pull/183792","mergeCommit":{"message":"[DOCS]
Obs AI Assistant connector (#183792)\n\n## Summary\r\n\r\nAdds reference
documentation about the Obs AI Assistant connector\r\n(requested in
#181282)\r\n\r\nCo-authored-by: Kibana Machine
<[email protected]>","sha":"310f4ff79cbe5d2ec7e699d9ffb3aefdc51da9ec"}},"sourceBranch":"main","suggestedTargetBranches":["8.14"],"targetPullRequestStates":[{"branch":"8.14","label":"v8.14.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.15.0","branchLabelMappingKey":"^v8.15.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/183792","number":183792,"mergeCommit":{"message":"[DOCS]
Obs AI Assistant connector (#183792)\n\n## Summary\r\n\r\nAdds reference
documentation about the Obs AI Assistant connector\r\n(requested in
#181282)\r\n\r\nCo-authored-by: Kibana Machine
<[email protected]>","sha":"310f4ff79cbe5d2ec7e699d9ffb3aefdc51da9ec"}}]}]
BACKPORT-->

Co-authored-by: DeDe Morton <[email protected]>
  • Loading branch information
kibanamachine and dedemorton authored May 31, 2024
1 parent 5eb8d60 commit 9a783d7
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 1 deletion.
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
67 changes: 67 additions & 0 deletions docs/management/connectors/action-types/obs-ai-assistant.asciidoc
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

0 comments on commit 9a783d7

Please sign in to comment.