Documentation

Azure Bot Configuration

Some of our customers demand a direct channel to the organizational knowledge without the uncertainty that an AI decides to use your secure and precise organizational search for knowledge questions or just the web. Therefore, you can integrate the Retrieval Suite’s query pipelines directly as Azure Bot. This bot can then easily be integrated into Teams as an app. In turn, when chatting with this bot, your users receive answers based on the defined query pipeline.

Entra App Registration

Good to know: You can set up multiple bot integrations against different query pipelines, if you need to.

However, as of now, we avoid any decision making in the Retrieval Suite on which pipeline to use so that the generated search results stay highly deterministic. Therefore, you need to set up 1:1 relationships between bot services and query pipelines. You can however, reuse the Entra Id App Registriation below.

Open https://portal.azure.com

Create an Entra Id App:

  1. Open Entra Id

  2. Click on App registrations

    image-20250901-075945.png

  3. Click on “New registration”

  4. Give it a name

  5. Make a note of Application (client) Id and Directory (tenant) Id

  6. Click on Certificates and secrets

  7. Create a new client secret and make a note of it.

    image-20250901-080210.png

  8. Click on API permissions

  9. Click on Add a permissions and add the following delegated permissions:

    1. Graph Permissions

    2. openid

    3. profile

    4. User.Read

    5. User.ReadBasic.All

      image-20250901-080433.png

  10. Consent these permissions as an administrator by clicking “Grant admin consent for <org>”

Azure Bot Configuration

  1. If you do not have an Azure Bot Service then create a new service in your Azure Portal

    Azure Bot 1

  2. Open the Bot Service

  3. Open Settings > Configuration

    image-20250901-080819.png

  4. Make a note of the Microsoft App ID (the Bot ID)

  5. Click on Add OAuth Connection Settings

    1. Give it a reasonable name

    2. As Service Provider Choose Azure Active Directory v2

    3. Add the client Id from your Entra Id app above (Step 5)

    4. Add the client secret from your Entra Id app (Step 7)

    5. Add the tenant Id from your Entra Id app above (Step 5)

    6. Click on Test connection (top right) and correct any errors

      image-20250901-081455.png

Retrieval Suite Configuration

With this information, we can now configure the RheinInsights Bot.

image-20250901-081711.png

  1. Open the Retrieval Suite’s admin interface

  2. Go to Search UX > Bot Integrations

  3. Click add to add a new bot

    1. Bot type. Choose Azure Bot

    2. Query pipeline: choose the query pipeline which should serve this bot

    3. Entra Id tenant id: add the tenant id as given above (Entra Id Step 5)

    4. Bot app id: add the bot app id as given above (Bot Configuration Step 3 / Microsoft App Id as part of the bot configuration)

    5. Add the Entra Id’s client secret as from the Entra Id configuration Step 7.

    6. Add the Oauth connection name, as given in Bot configuration Step 5 (Add Oauth Connection Settings)

  4. Click on validate and save

  5. Now you can see Azure Bot <bot id> as the bot title of the configuration. Make a note of the number.

Finalizing the Bot Configuration

  1. Add the messaging endpoint. This should be
    https://<URL to RheinInsights Suite>/api/v1/bot/messages?botId=<botId>
    The <botId> is the one given from the RheinInsights Retrieval Suite’s configuration dialog above.

Test in Web Chat

  1. Now you can click on Test in Web Chat

image-20250901-082424.png

  1. Here you can test the OAuth flow and see if the connection between Suite and the Bot works well.

    1. If you run into any issues, you should make sure that the RheinInsights Retrieval Suite was connected at all and if so, if you see any Exceptions in the Diagnostics log (cf. Diagnostics )

    2. If you are successfully able to chat with your data, then you can proceed to setting up a Teams app (see Teams App (Bot) Registration )