-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add Slack, Discord, and Microsoft Teams integrations #20
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
Merged
Merged
Changes from 9 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
3a6dc27
docs: document Slack integration
Oloxx e50c021
docs: document Discord integration
Oloxx b946024
fix: add code blocks language identifiers
Oloxx c6239a4
docs: update discord integration channel usage instructions
Oloxx 23e8f56
docs: document Microsoft Teams integration
Oloxx 8036037
Merge branch 'discord-integration' into integrations
Oloxx a448a1f
Merge branch 'slack-integration' into integrations
Oloxx 9c69ce1
chore: merge discord-integration, slack-integration, ms-teams-integra…
Oloxx 48cfc65
docs: update integrations sidebar order and integration docs
Oloxx cc1de71
docs: update Microsoft Teams integration setup flow
Oloxx 7989c48
docs: update Discord bot removal instructions and remove citation ref…
Oloxx e0b17ce
docs: remove mentions of cited sources and per-project routing from S…
Oloxx d4fefcd
docs: add documentation for the /clear slash command across Discord, …
Oloxx 736647b
docs: standardize spelling to American English
Oloxx 139b746
docs: add integration screenshots
Oloxx File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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,69 @@ | ||
| --- | ||
| sidebar_label: Discord | ||
| title: Discord Integration for Biel.ai | ||
| description: Add an AI chatbot to your Discord server that answers questions from your documentation using Biel.ai. | ||
| keywords: [discord bot, discord integration, biel.ai discord, documentation chatbot discord, slash command discord, ask bot discord] | ||
| sidebar_position: 6 | ||
| --- | ||
|
|
||
| # Discord integration | ||
|
|
||
| The Biel.ai Discord bot lets members of your server ask questions about your documentation directly in any channel using the `/ask` slash command. | ||
|
|
||
| ## What you can do | ||
|
|
||
| - **Slash command** — members use `/ask` to get instant answers from your documentation. | ||
| - **Cited sources** — every answer includes links to the relevant documentation pages. | ||
| - **Works in any channel** — the bot responds wherever it has permission, no setup per channel required. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A [Biel.ai account](https://app.biel.ai) with a project that has indexed content. | ||
| - A Discord server where you have **Manage Server** permission (required to authorize bots). | ||
|
|
||
| ## Setup | ||
|
|
||
| ### 1. Connect the bot to your server | ||
|
|
||
| 1. Go to your project settings in the [Biel.ai dashboard](https://app.biel.ai). | ||
| 2. Under the **Integrations** section, find the Discord card and click **Add to Discord**. | ||
| 3. Discord opens an authorization page. Select the server where you want to install the bot and click **Authorize**. | ||
| 4. After authorizing, you are redirected back to Biel.ai and the bot is connected. | ||
|
|
||
| The `/ask` command is registered immediately and available to all members of the server. | ||
|
|
||
| ### 2. Disconnect the bot | ||
|
|
||
| To remove the bot from a server, kick it directly from your Discord server settings under **Integrations** > **Bots and Apps**. Biel.ai detects the removal and unlinks the server automatically. | ||
|
|
||
| ## Usage | ||
|
|
||
| In any channel in your server, type: | ||
|
|
||
| ```text | ||
| /ask question: How do I reset my password? | ||
| ``` | ||
|
|
||
| The bot responds with an answer sourced from your documentation, including links to the relevant pages. | ||
|
|
||
| :::tip[Not getting answers?] | ||
| Make sure your Biel.ai project has indexed content. You can check this from the **Sources** tab in your project settings. | ||
| ::: | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| **The `/ask` command doesn't appear** | ||
|
|
||
| Discord can take a few seconds to register new slash commands. Wait a moment and try again. If it still doesn't appear, try restarting your Discord client. | ||
|
|
||
| **The bot doesn't respond** | ||
|
|
||
| Check that the bot has **Send Messages** and **Use Application Commands** permissions in the channel. These can be configured in the channel's permission settings. | ||
|
|
||
| **The bot gives incorrect or outdated answers** | ||
|
|
||
| Re-index your documentation in the [Biel.ai dashboard](https://app.biel.ai) to make sure the bot is querying the latest content. | ||
|
|
||
| --- | ||
|
|
||
| Need help? [Contact us](https://biel.ai/contact) or visit the [support page](/support). |
This file contains hidden or 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,81 @@ | ||
| --- | ||
| sidebar_label: Microsoft Teams | ||
| title: Microsoft Teams Integration for Biel.ai | ||
| description: Deploy the Biel.ai bot in Microsoft Teams so your team can ask questions to your documentation directly from any channel or chat. | ||
| keywords: [microsoft teams bot, teams integration, biel.ai teams, documentation chatbot teams, teams channel bot] | ||
| sidebar_position: 6 | ||
| --- | ||
|
|
||
| # Microsoft Teams integration | ||
|
|
||
| Deploy the Biel.ai bot in Microsoft Teams so your team can ask questions to your documentation directly from any channel, group chat, or direct message — without leaving Teams. | ||
|
|
||
| ## What you can do | ||
|
|
||
| - **Personal chats** — direct message the bot for quick answers. | ||
| - **Group chats** — add the bot to any group conversation. | ||
| - **Channels** — add the bot to a team channel so everyone can ask questions. | ||
| - **Conversation context** — the bot maintains context within the same conversation thread. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A [Biel.ai account](https://app.biel.ai) with documentation indexed. | ||
| - A **Business** or **Enterprise** plan. | ||
| - **Teams Administrator** access to your Microsoft 365 organisation. | ||
|
Oloxx marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## Setup | ||
|
|
||
| ### 1. Get the app package from Biel | ||
|
|
||
| Contact the Biel team to receive the `biel-teams-app.zip` package configured for your organisation. | ||
|
|
||
| ### 2. Upload the app to your Teams Admin Center | ||
|
|
||
| A Teams administrator in your organisation must upload the package: | ||
|
|
||
| 1. Open [Teams Admin Center](https://admin.teams.microsoft.com). | ||
| 2. Go to **Teams apps** → **Manage apps** → **Upload new app**. | ||
| 3. Upload the `biel-teams-app.zip` file. | ||
| 4. Under **Permission policies**, configure which users or groups can install the app. | ||
|
|
||
| :::tip | ||
| If your organisation has strict app permission policies, you may need to explicitly allow the Biel app for the relevant users or groups before it becomes discoverable in the Teams app store. | ||
| ::: | ||
|
|
||
| ### 3. Install the bot | ||
|
|
||
| Once the app is available in your organisation's catalog, users can find it by searching for **Biel** in the Teams app store and clicking **Add**. | ||
|
|
||
| ## Usage | ||
|
|
||
| Send any message to the bot and it will respond with an answer sourced from your documentation. | ||
|
|
||
| ```text | ||
| You: How do I reset my password? | ||
| Biel: To reset your password, go to Settings → Security → Reset Password and follow the steps shown. | ||
| ``` | ||
|
|
||
| You can ask follow-up questions and the bot will maintain context within the same conversation thread: | ||
|
|
||
| ```text | ||
| You: What permissions do I need for that? | ||
| Biel: You need the Account Owner or Admin role to access the Security settings. | ||
| ``` | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| **The bot doesn't appear in the app store** | ||
|
|
||
| Check that the app has been approved and that the user is covered by the configured permission policy in Teams Admin Center. | ||
|
|
||
| **The bot doesn't respond** | ||
|
|
||
| Ensure your Biel.ai project has documentation indexed and that the `biel-teams-app.zip` package was provided for your specific project. Contact [Biel support](https://biel.ai) if the issue persists. | ||
|
|
||
| **Responses are incorrect or outdated** | ||
|
|
||
| Re-index your documentation in the [Biel.ai dashboard](https://app.biel.ai) to make sure the bot is querying the latest content. | ||
|
|
||
| --- | ||
|
|
||
| Need help? [Contact us](https://biel.ai/contact) or visit the [support page](/support). | ||
This file contains hidden or 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,74 @@ | ||
| --- | ||
| sidebar_label: Slack | ||
| title: Slack Integration for Biel.ai | ||
| description: Connect your Biel.ai project to Slack so users can ask questions and get AI-powered answers directly from any Slack channel or DM. | ||
| keywords: [slack bot, slack integration, biel.ai slack, documentation chatbot slack, slack channel bot] | ||
| sidebar_position: 4 | ||
| --- | ||
|
|
||
| # Slack integration | ||
|
|
||
| Connect your Biel.ai project to Slack and let users interact with your documentation bot directly from any channel or direct message. The bot answers questions using your indexed documentation, with full source citations. | ||
|
|
||
| ## What you can do | ||
|
|
||
| - **Answer questions in channels** — users mention `@Biel.ai` and get an instant answer. | ||
| - **Direct message support** — users chat with the bot privately without leaving Slack. | ||
| - **Cited sources** — every answer includes links to the relevant documentation pages. | ||
| - **Per-project routing** — each Slack workspace connects to a specific Biel.ai project. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - A [Biel.ai account](https://app.biel.ai) with at least one project and indexed documentation. | ||
| - A **Slack workspace** where you have permission to install apps. | ||
| - Admin access to your Biel.ai dashboard. | ||
|
|
||
| ## Setup | ||
|
|
||
| ### 1. Connect your Slack workspace | ||
|
|
||
| 1. In the Biel.ai dashboard, open the project you want to connect. | ||
| 2. Go to **Settings** → scroll down to the **Integrations** section. | ||
| 3. Click **Add to Slack**. | ||
| 4. You will be redirected to Slack's authorization screen — review the permissions and click **Allow**. | ||
| 5. Once authorized, Slack redirects back to Biel.ai and the workspace is connected. | ||
|
|
||
| ### 2. Invite the bot to a channel | ||
|
|
||
| After connecting, invite the bot to any channel where you want it to respond: | ||
|
|
||
| ```text | ||
| /invite @Biel.ai | ||
| ``` | ||
|
|
||
| For direct messages, users can find the bot by searching its name in the Slack search bar. | ||
|
|
||
| ## Usage | ||
|
|
||
| **In a channel** — mention the bot followed by your question: | ||
|
|
||
| ```text | ||
| @Biel.ai how do I authenticate with the API? | ||
| ``` | ||
|
|
||
| **In a direct message** — just send your message directly, no mention needed: | ||
|
|
||
| ```text | ||
| What are the system requirements? | ||
| ``` | ||
|
|
||
| The bot will respond with an AI-generated answer and a list of source links from your documentation. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| **The bot does not respond to mentions** | ||
|
|
||
| Make sure the bot has been invited to the channel with `/invite @Biel.ai`. The bot can only see messages in channels it has been added to. | ||
|
|
||
| **The bot gives incorrect or outdated answers** | ||
|
|
||
| Re-index your documentation in the [Biel.ai dashboard](https://app.biel.ai) to make sure the bot is querying the latest content. | ||
|
|
||
| --- | ||
|
|
||
| Need help? [Contact us](https://biel.ai/contact) or visit the [support page](/support). |
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.