Skip to content

Commit

Permalink
Describe user-supplied documentation feature for AI Assistant (#338)
Browse files Browse the repository at this point in the history
  • Loading branch information
pkosiec authored Jun 17, 2024
1 parent d3bd4e4 commit 12c973f
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 4 deletions.
23 changes: 21 additions & 2 deletions docs/plugins/ai-assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,18 @@ The AI Assistant plugin makes it easier than ever for teams to identify, diagnos
The plugin provides the following features:

- "AI Help" button for Kubernetes event analysis.
- Answering arbitrary questions or instructions.
- Kubernetes cluster troubleshooting based on:
- `kubectl` commands,
- container logs,
- Kubernetes events,
- resource usage (CPU/memory).
- Kubernetes cluster scan.
- Answering arbitrary questions or instructions.
- Answering questions based on user-supplied documentation.
- Answering Botkube questions or instructions based on:
- Agent status and configuration,
- the latest Botkube documentation and other Botkube content.
- Keeping conversation context in the message threads.
- Kubernetes cluster scan.

## Get started

Expand Down Expand Up @@ -75,6 +76,24 @@ Here are a few examples to get you started:
The assistant can help you troubleshoot the Kubernetes cluster by performing a cluster-wide scan for any potential issues,
such as failing pods, high resource usage, or any other anomalies. To start the scan, use the `@Botkube ai scan` command.

### User-supplied documentation

:::info
This feature is only available for Botkube Cloud paid plans.
:::

Botkube Assistant can use supplied documentation to give better answers, specific to your architecture and processes. For example: architectural documents, onboarding material, runbooks, post-mortems, etc.

The user-supplied documentation is scoped to a given Botkube Cloud organization.

#### Manage uploaded files

To manage uploaded files, navigate to the ["AI Assistant"](https://app.botkube.io/ai-assistant) tab in Botkube Cloud. From the tab, you can upload files with the **Upload File(s)** button. Supported file formats include: `.doc`, `.docx`, `.md`, `.pdf`, `.txt`. See the [full list](https://platform.openai.com/docs/assistants/tools/file-search/supported-files).

To delete file(s), select the file(s) you want to delete and click **Delete selected file(s)**.

Once the files are uploaded, you can ask Botkube AI Assistant questions related to the uploaded content. To learn more, see the [AI questions and instructions](#ai-questions-and-instructions) section.

## Configuration

Currently, the AI plugin doesn't have any configuration options.
Expand Down
23 changes: 21 additions & 2 deletions versioned_docs/version-1.12/plugins/ai-assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,18 @@ The AI Assistant plugin makes it easier than ever for teams to identify, diagnos
The plugin provides the following features:

- "AI Help" button for Kubernetes event analysis.
- Answering arbitrary questions or instructions.
- Kubernetes cluster troubleshooting based on:
- `kubectl` commands,
- container logs,
- Kubernetes events,
- resource usage (CPU/memory).
- Kubernetes cluster scan.
- Answering arbitrary questions or instructions.
- Answering questions based on user-supplied documentation.
- Answering Botkube questions or instructions based on:
- Agent status and configuration,
- the latest Botkube documentation and other Botkube content.
- Keeping conversation context in the message threads.
- Kubernetes cluster scan.

## Get started

Expand Down Expand Up @@ -75,6 +76,24 @@ Here are a few examples to get you started:
The assistant can help you troubleshoot the Kubernetes cluster by performing a cluster-wide scan for any potential issues,
such as failing pods, high resource usage, or any other anomalies. To start the scan, use the `@Botkube ai scan` command.

### User-supplied documentation

:::info
This feature is only available for Botkube Cloud paid plans.
:::

Botkube Assistant can use supplied documentation to give better answers, specific to your architecture and processes. For example: architectural documents, onboarding material, runbooks, post-mortems, etc.

The user-supplied documentation is scoped to a given Botkube Cloud organization.

#### Manage uploaded files

To manage uploaded files, navigate to the ["AI Assistant"](https://app.botkube.io/ai-assistant) tab in Botkube Cloud. From the tab, you can upload files with the **Upload File(s)** button. Supported file formats include: `.doc`, `.docx`, `.md`, `.pdf`, `.txt`. See the [full list](https://platform.openai.com/docs/assistants/tools/file-search/supported-files).

To delete file(s), select the file(s) you want to delete and click **Delete selected file(s)**.

Once the files are uploaded, you can ask Botkube AI Assistant questions related to the uploaded content. To learn more, see the [AI questions and instructions](#ai-questions-and-instructions) section.

## Configuration

Currently, the AI plugin doesn't have any configuration options.
Expand Down

0 comments on commit 12c973f

Please sign in to comment.