How to upload documents or files for ChatGPT AI indexing
Reference .pdf, .pptx, .docx, etc. documents in AI chat
This feature allows you to easily add reference files, so when you ask a question, AI can search for answers directly within the uploaded documents. Here’s how to upload your files and start using them:
Step 1: Go to the Manager Dashboard
Step 2: Navigate to the Manage FAQ Files Section: Under the FAQs dropdown menu, select Manage FAQ Files.
Step 3: Click on New FAQ File Item to begin uploading your document.
Step 4: Enter Title and Upload:
Provide a clear title for your file so it’s easy to locate later.
Click the upload button to select and upload your file.
Step 5: Publish Your File: Once uploaded, click Publish to make it accessible for AI search.
Important Note
After publishing, it may take up to 30 minutes for the AI to index the file. Once indexed, your file will be available for AI-powered search responses.
For any questions, reach out to our support team at support@instant-tech.com.
Escalate AI Chats With Multi-Level Support
Escalate Agent Chat Service Tier
Connect To Agent With Escalation Features
Ensure the following feature is enabled:
ChimeV5.Pipeline.ConnectToAgentWithEscalation
Pipeline Configuration
Key: ID of the pipeline item
Next Stage: ID of the pipeline item to invoke if the chat was connected to an agent. Leave blank to end chat
Drop Stage: ID of the pipeline item to invoke if the chat was ended before connecting to an agent. Leave blank to end chat
Maximum Wait Time: Number of seconds that a chat can wait without being connected to an agent before timing out
On Waiting Timeout Next Stage: ID of the next pipeline item to invoke if the chat is not routed to an agent before the max waiting time
Still Searching for Agent Message Interval: Number of seconds between sending the still searching for agent message
Agent Accept Timeout: Number of seconds before a prompt to an agent to accept a chat expires
Routing Mode: Method that will be used to select agents to route to (Broadcast Routing or Round-Robin Hunt Routing)
Agent List: The list of agents that will be routed to and prompted
Escalation Options: Options for escalating the chat to another pipeline stage or agent list
Adaptive Card Messages:
Guest Initial Waiting Message: Message sent to the guest when starting to search for an agent
Still Searching for Agent Message: Message sent to the guest periodically when still searching for an agent
Guest Connected to Agent: Message sent to the guest when they are connected to an agent
Agent Connect to Guest: Message sent to the agent when they are connected to the guest
Agent Left Chat: Message sent to the guest when the agent levaes the chat
Guest Left Chat: Message sent to the agent when the guest leaves the chat
Guest Escalated Message: Message sent to the guest when they are escalated to another agent or agent list
Agent Experience
Incoming User Experience
Metadata & Flow
When the chat session has ended the metadata and flow tab are both populated. The flow tab shows when the agent escalated the chat and to which pipeline stage/agent list they transferred to. Metadata also shows this with some additional details:
Reports
We have associated reports that are added when the escalation feature is enabled allowing for easy tracking of escalated chat sessions.
Level 1 Escalated Chats
Level 1 Chats Handled vs Escalated Over Time
Level 1 Chats Handled vs Escalated by Agent
How to Update Branding Images for your Chime Deployment
Customize The Look Of Your Tenant
If you want to update the way Chime looks to your users when they are in a chat session, this guide will show how to update the images used for messages sent in chat sessions and on your Chime tenant’s web interface. If you are looking for how to update the Image for the Chime V5 Teams App we also have this guide on Steps to Customize (Apply Branding) Teams App in Teams Admin
Navigate to Media Library
First thing we will want to do is find where these images are stored.
Navigate to Admin, then Media Library (either from the dashboard page, or from the left-side menu Chime Advanced > Media Library)
Select the _branding folder from the Media Library menu. In this folder you should see images that are important for branding. In this guide we will cover the most important ones:
card-logo.png
favicon.ico
logo.png
tenant-logo.png
Favicon icon
The favicon icon will be what your Agents, Managers, and Admins see on the Chime web portal as the icon at the top of the page/tab. This can be updated to be more in line with your organizations icon
Tenant Logo
The tenant-logo will display in the top left of the header on each page while on the Chime web portal. Typically this is an org or helpdesk logo image to tie the branding of your Chime tenant over to your organization.
Card Logo
The card-logo.png image is used primarily on adaptive cards sent by Chime over to the end-user or the Agent during a chat session. Here are all the spots it can show up by default:
Tenant Settings > Chat Commands and Events
Install Welcome Message
Generic Help Message
Greeting Command Message Before a Chat
Greeting Command Message During Chat
Pipeline Adaptive Cards
Welcome Card Form when user stars a chat
FAQ Lookup Results
User Feedback Card
Pipeline Help Message
Pipeline Invalid Command Message
Chat Routing to Agent Cards
Guest Initial Waiting Message
Still Searching for Agent Message
Guest Connected to Agent
Agent Connected to Guest
Agent Left Chat
Guest Left Chat
How to Update the Install Welcome Message for the Teams App
Customize Or Disable Your Welcome Message
This guide will cover how a Teams Admin can configure what message an end user sees when Chime V5 is installed on their Teams Client. The default message is a general welcome message to Chime, but you will likely want to update it to fit the branding and feel of your Chime use case. Additionally, you also have the option to disable this message so users are not messaged by the app until they choose to use if for the first time.
Navigate to the Admin Dashboard, then Chime Settings and Tenant Settings.
Click on the Chat Commands and Events tab.
For the Install Welcome Message option, choose if you want this to be enabled or disabled using the setting Disable Welcome Message.
If you want to update the message, click on the Editor tab, then Pop out card Editor option.
In the editor, click on the text in the middle to select it.
On the right-side of the editor, there will be Element Properties that show up, under the Text option, you should be able to edit any of the existing text to suit your Chime use-case. If you would like to add any additional elements here are some Adaptive Card samples that can help with learning how to use them Adaptive Card Samples and Templates.
Once you are done updating the card, click Save Card.
When if prompts you to close the card designer, click OK.
Back on the Chime Admin area, click the Save button in the bottom left.
Here is an example of what this welcome message will look like by default in the Chime Teams app.
How to approve the Chime V5 Chat app
Authorize installation for users in your organization
Deploying our enterprise chat application across your organization will allow any, or maybe just a subset, of employees to use our chat application to search Chat FAQs, use Chat Q&A services, Chat with AI, and route chat requests to service desk agents. In other words, solve employee problems and issues using chat :)
Since Chime is a chat service available from the Microsoft Teams Store, the organization’s MS Teams Admin will need to make the application available organization wide and update MS Teams App Policies.
In this guide, we will cover how to make the Chime V5 Teams app available to install for users in your organization. This will require a Teams Admin to complete the following steps to ensure that your organization will be able to use the Chime V5 app propperly.
In the Microsoft Teams Admin Center navigate to Teams Apps, then Manage Apps >>
Click the button labeled Org-wide app settings in the top right.
In the settings panel that slides in, set the setting Third-party apps to On (if it is already set to on, you do not need to make any changes)
You can leave the settings New third-party apps published to the store and Auto install approved apps off if they are not already enabled.
Click Save and close the settings panel.
Next, navigate to Teams Apps, then Permission Policies >>
Select an existing permission policy to apply this to. For the rest of this guide we will be using Global (Org-wide default), but you can test it on a smaller group if you want to before pushing to the entire org.
Click the Allow apps button (or the + Add Apps button if there are already some within this option).
A panel will open where you can search for apps to allow. Search for Chime V5, and select it when it appears in the options.
Click Allow.
Verify that Chime V5 shows up under the Allowed Apps section and click the Save button to apply changes.
Set Up Adaptive Card Notifications Via Help Desk Workflows
Notify Users When A Chat Session Is Resolved
Our enterprise chat platform includes chat FAQ lookup, Chat Q&A, integration with ChatGPT, and routing to service desk agents.
In this guide, you'll learn how to set up a workflow that automatically sends an adaptive card to a guest user after an agent marks a session as resolved. This pattern can use the chat workflow engine to monitor any chat session values and send information to the employee based on any updates to the metadata - in this case, when a service desk agents marks that as resolved using the agent UI.
Follow the steps below to create and configure this workflow in your Chime environment.
Step 1: Create a Workflow
- Navigate to the Chime Advanced > Workflows page via the Admin menu.
- Click the Create Workflow button in the top right corner.
- Name the workflow and click Save.
Step 2: Add Session Metadata Updated Event
- On the Workflow editor page, click the Add Event button.
- In the pop-up window, scroll through or search for Session Metadata Updated.
- Select the Add button next to the event.
- Name the event
- Uncheck the 'Execute on every metadata change' toggle
- Under the 'Selected Metadata Keys' field insert: Session.Status.IsResolved
Step 3: Add If/Else Task
- On the Workflow editor page, click the Add Task button.
- In the pop-up window, scroll through or search for If/Else.
- Select the Add button next to the task.
- Name the task, input the condition expression, and click Save.
Condition Expression:
input("ChangedMetadata").find((element) => element.Key == "Session.Status.IsResolved").Value == "True"
Step 4: Add Send Adaptive Card Task
- On the Workflow editor page, click the Add Task button.
- In the pop-up window, scroll through or search for Send AdaptiveCard.
- Select the Add button next to the task.
- Name the task, input the Adaptive Card JSON, and click Save.
Adaptive Card JSON:
{
"type": "AdaptiveCard",
"version": "1.3",
"$schema": "https://adaptivecards.io/schemas/adaptive-card.json",
"body": [
{
"type": "TextBlock",
"text": "Your issue is resolved: ${Session.Status.IsResolved}",
"wrap": true
}
]
}
Step 5: Connect the Event and Task Modules
- In the Workflow editor, drag the blue dot from the event to the If/Else task to connect them.
- Next, drag the green dot labeled 'True' from the If/Else task to the Send Adaptive Card task. This ensures the workflow proceeds correctly when the condition is met.
Step 6: Enable and Start the Event and Task Modules
- Select each module and click the power icon to enable and start it.
- Once all modules are enabled and displayed in green, click the Save button at the bottom of the screen to save the workflow.
Testing the Workflow
- Start a chat session and connect with an agent.
- Mark the session as resolved within the Agent UI.
- Verify that the guest user receives the adaptive card indicating their issue is resolved.
By following these steps, you can set up a simple workflow that enhances the customer experience by providing automated updates through adaptive cards.
Related Content
How to: Create a workflow that sends a card to guest when the session is resolved - FAQ Article
How to: Send custom HTML emails using the send email pipeline item or send email workflow task - FAQ Article
How to: Use workflows to send emails when content is created, deleted, published, updated etc… - FAQ Article
How to Make a Chatbot for FAQ Articles and Make Sure They Open in Teams Correctly
Open FAQ Links In Microsoft Teams
Creating Links
Use our embedded content management system (CMS) to create an FAQ chatbot and have the FAQs display in Microsoft Teams. This article will show how to quickly do this using our FAQs and a simple chatbot (chat pipeline) You can get started in one of two ways:
1. Use the Create Link button to have a link created for you.
2. Type out the Link format inline.
[Link Text](URL) — Used if you want the user to navigate to the link in the same page.
[Link Text](URL){target="_blank"} — Used if you want the user to navigate to the link in a new tab.
Replace Link Text
with the text you want to display for the link, and replace URL
with the actual URL you want to link to.
The target="_blank"
attribute tells the browser to open the linked document in a new tab or window. So, for example, if you want to create a link to Google that opens in a new tab with the text "Google", you would write:
[Google](https://www.google.com){target="_blank"}
Formatting Notes for Links Displayed in Teams
If you want links within FAQs to work well in Teams, there are a few formatting properties to consider:
If you are linking to page hosted in Chime (FAQ article, page, chat history, etc…) you just need to use [Link Text](URL) format
If you are linking to a page outside of Chime (SharePoint page, Knowledgebase article, video, etc…) you will need to use the specific [Link Text](URL){target="_blank"} format as they will either not be whitelisted to display, or the content provider will not allow the page to be displayed in Iframes which is what Teams uses to show links.
Here is some additional documentation on markdown syntax to help if you have any additional questions: Markdown Guide: Links Syntax
Example
This is what it will look like in the Teams client if you have a link to an outside source (for example, if content is still stored in SharePoint and is located outside of the embedded CMS FAQ system:
To fix this issue, we will want to update the links to all include the {target="_blank"} attribute to them. This is how it will look for users once that is updated:
How to push the Teams application org-wide
Review prerequisites, step-by-step installation, and configuration tips
If you are in the process of onboarding, please make sure you have gone through and considered or completed these two steps:
Authorize Chime V5 Teams App in Microsoft Teams Admin Center >>
Steps to Customize (Apply Branding) Teams App in Teams Admin >>
Update the Install Welcome Message in Chime >>
Once you are ready to start deploying the Chime V5 app either for your small pilot testing or when pushing to it to your organization, this guide will help to lay out the steps to follow to get the app pushed as well as cover some of the customization options to consider before pushing to groups of users.
Teams Admin configures user group permissions
Navigate to Permission Policies in the Teams Admin Center. You will now need to configure policies to allow the Chime V5 Teams app to only to be accessible for your Org.
If you had previously set up the App permission policy to apply to a specific user group, you will need to update it to be org-wide. For a guide on how to do that, see this Guide on Approving Chime V5 app for your Org.
Additionally, you may want to automatically install and pin the Chime V5 app in the Teams client for users in the pilot. To do this you would want to update the app setup policies in the Setup Policies tab of Teams Admin Center.
Navigate to Setup Policies.
Click on the Global (Org-wide default) setting
Under the Installed apps section, click on + Add apps and search for Chime V5 and select it.
Click Add. Verify that the Chime V5 app appears in the list of installed apps.
Click Save.
If you want the Chime V5 app to appear on the left-side menu for users, we will also want to pin the app.
Under the Pinned apps section, click on + Add apps and search for Chime V5 and select it.
Click Add. Verify that the Chime V5 app appears in the list of pinned apps.
Rearrange the order of the pinned apps to suit where you want the app to show up.
Click Save.
Additional note on updating Teams apps:
If you have made any branding/styling changes to the Chime V5 Teams app during this process some users may see the old version of the app name or an old/broken app icon in their Teams client.
This can typically be fixed by having the user logging out of Teams and logging back in. If that doesn’t work, the user can go in and manually clear the cache in teams following this Microsoft guide: Clear the Teams client cache >>
Here is some additional documentation from Microsoft on managing permission policies and setup policies:
Use app permission policies to control user access to apps
Use app setup policies to pin and auto install apps for users
Enable Azure login for the web app with Graph API permissions
Approve the use of Graph API Permissions for Azure AD/Entra Login
When initially onboarding the service desk you will need an Azure AD/Entra Admin to approve the use of some Graph API permissions for the service desk web application to enable Azure AD/Entra login. In this article we will cover the list of API permissions you will need and details of what each of them do and are used for. Below are the specific Graph API permissions the app will request when you are prompted to approve Azure AD/Entra login:
email - Delegated
openid - Delegated
profile - Delegated
User.Read - Delegated
As the Azure administrator, we may request the Tenant Id of your org before this next step so that we are able to associate the Chime V5 instance stood up by Instant Tech team. Once the instance is ready to be linked to your AD/Entra login, the Instant Tech team will send across a link for you to approve the requested permissions.
Once you have accepted the permissions, the log in option for Chime V5 will associate users logging in with their Office 365 accounts and will require users to login with their org accounts.
Set Up Service Desk Chat With Chat Routing Notifications For Agents
Route Notifications Directly To Your Teams Channel
Our platform is designed to help resolve employee problems - typically using chat, chat based FAQs, and allow service desk agents to use chat to resolve employee questions. This web hook notification will use Microsoft Teams to send agents notifications of inbound chat sessions.
When employing Chime V5 pipeline workflows, agents can now receive notifications directly on their dashboard when new chat sessions arrive. By integrating Webhooks with Teams, these V5 workflows can be linked to a designated Teams channel, providing improved accessibility through broadcast notifications.
Add Incoming Webhook to Your Teams Channel
Navigate to Your Teams Channel
Begin by navigating to the Teams channel where you want to receive broadcast notifications.
Select More Options Menu
In the chosen channel, click on the more options menu (three dots) located at the top-right corner.
Navigate to Connectors
Depending on your Teams version there will be two different ways to get to the Connectors menu.
(Old Teams) From the dropdown menu, select Connectors.
(New Teams) From the dropdown menu, select Manage Channel, then under the Connectors section, click Edit.
Add Incoming Webhook
Configure Incoming Webhook
Navigate Back to Connectors
Return to the Connectors menu.
Configure Incoming Webhook
Click on the Configure button next to the Incoming Webhook option.
Fill Out Webhook Name
Provide a meaningful name for the Incoming Webhook to easily identify its purpose.
Optionally, you can also click the Upload Image button to additionally change the branding image used when it sends messages.
Create Webhook
Copy Webhook URL
Once the URL is generated, click on the Copy button or manually highlight and copy the link.
Configure In Chime V5 Tenant
Navigate to Chime V5 Tenant
Open your Chime V5 tenant and access the chat pipeline.
Edit Chat Pipeline
Select the Edit option in the chat pipeline.
Connect to Agent Pipeline Item
Open the details for the Connect to Agent pipeline item.
Enable Webhook
Toggle the Webhook Enabled option to activate the webhook functionality.
Paste Webhook URL
In the Webhook URL field, paste the previously copied URL from Teams.
Agent Experience
When a Guest/End User works through a chat session to start routing to agent, a broadcast notification is sent to the connected Teams channel and all Agents will have the ability to accept the chat session.
Setting Up Real-time Agent Notifications with Teams
Send Notifications Directly To Your Teams App
This feature allows agents to receive instant notifications in their Teams client when a chat is routed to them, directly from the bot. In this guide, we'll walk you through the setup process to ensure a seamless integration into your workflow.
Prerequisites
Before diving into the setup, ensure that you have the latest version of Chime V5 installed. If not, make sure to update your Chime application to access the latest features and improvements.
Integration with Teams
Chime V5's real-time agent notifications are tied into the same Orchard Feature as the Teams channel webhook notification feature. This ensures a consistent and streamlined experience for administrators and agents alike.
Agents can now receive notifications in their Teams client when a chat is routed to them, in addition to the existing webhook method for routing into a Teams Channel.
User Settings Management
To enable these notifications, user settings must be configured to store the Teams ID and conversation ID reference for each agent. This information is added to the Orchard User record, similar to the setup for the Agent Profile.
User Settings in the Admin Area
In the Admin section, navigate to the user record, where a new "Teams Notifications" tab has been added. Here, administrators can manage Teams addresses for each user.
User Settings in Manager Area
For the Manager dashboard, a new section in the user page displays Teams notification settings. Managers can easily view and update this information when managing agents.
User Settings for Agents
Agents can access their Teams notification settings on their Agent Dashboard Settings page. Additionally, buttons are available to Install Chime in Teams and Start Chat in Teams, facilitating the capture of Teams address information.
Tenant-level Configuration
At the tenant level, administrators can configure additional settings to customize the Teams integration experience.
Tenant-wide enable/disable toggle: Easily enable or disable the feature for the entire tenant.
Override for the Teams App Id: Specify the App Id based on the installation method, ensuring seamless integration.
Adaptive Card Template: Customize the notification's appearance using an Adaptive Card Template.
Sending Agent Notifications
With the setup complete, agents, having their Teams Addresses captured, will receive notifications in their Teams client when a chat is routed to them.
The implementation of this feature is seamlessly integrated into the Orchard Workflow events, requiring no changes to the chat pipeline. While it's not tied to Teams presence, agents need to have a Chime browser window open and be available to receive notifications.
Make Your Teams App Available to Everyone in Organization
Authorize Teams app using App Permissions and Policy Settings
Step 1: Go to the Teams Admin Center
URL: Teams Admin Center
Description: Start by navigating to the Microsoft Teams admin center using the provided link. This dashboard allows you to manage all settings related to Microsoft Teams.
Step 2: Navigate to App Setup Policies
Path: Teams apps > Setup policies
Description: Once in the Teams admin center, find the sidebar menu. Click on "Teams apps," then select "Setup policies." This section lets you manage app setup policies for your organization.
Step 3: Select the Global (Org-wide default) Policy
Action: Click on "Global (Org-wide default)"
Description: In the "Setup policies" section, locate and click on the "Global (Org-wide default)" policy. This will allow you to manage and edit the default settings that apply organization-wide.
Step 4: Add the Chime V5 App
Action:
Click "+ Add apps" (this will render a sidebar on the right side of the page)
Search “Chime V5“ and add “Chime V5”
Click Add (to save)
Step 5: Confirm Addition of Chime V5
Description: Ensure that Chime V5 appears in the list of apps under the policy after adding it. This confirms that it has been authorized for use within your organization.
Step 6: Save and Apply Changes
Action: Click "Save"
Description: After adding Chime V5 to your app policy, make sure to save the changes to update the policy settings across your organization’s Microsoft Teams setup.
6 Steps to Apply Branding To Your Teams App
Customize Your App From The Teams Admin Center
By default, the service desk application has a default icon, and name, that will be displayed in the Microsoft Teams client. Some customers may want to provide a different icon, or name. Follow these instructions as a Teams Admin to update the branding.
Step 1: Go to the Teams Admin Center
URL: Teams Admin Center
Description: Navigate to the Microsoft Teams admin center using the link provided.
Step 2: Navigate to Manage Apps
Path: Teams apps > Manage apps
Description: Once you are in the Teams admin center, locate the sidebar menu. Click on "Teams apps," and then select "Manage apps."
Step 3: Select the App to Customize
Action: Find the app you need to customize and click the app name.
Description: In the "Manage apps" list, search for the app you wish to customize. Click on the name of the app to open its specific settings and customization options. For example, search “Chime V5” and click on “Chime V5“.
Step 4: Enter Customization Mode
Action: Click the customize icon.
Description: After selecting the app, look for the customize icon. Click this icon to enter the customization mode for the selected app.
Step 5: Make Your Changes
Description: In the customization mode, you can modify settings of the app. You are able to change visuals, and other settings to better suit your team's branding.
Action: Update any of the settings for App details, or Icons. For Icon updates, you will want to take a look at the Microsoft documentation for updating App Icons to make sure any changes you make are applied correctly. Primarily, you will want to make sure the Color Icon is exactly 192 x 192 pixels and the Outline Icon is exactly 32x32 pixels and either white with a transparent background or transparent with a white background. No other colors are allowed.
Step 6: Apply Changes
Action: Click "Apply".
Description: After making the necessary changes, make sure to save and apply them by clicking the "Apply" button. This will update the app with your custom settings across your organization’s Teams platform.
Additional note on updating Teams apps:
After you have made any branding/styling changes to the Chime V5 Teams app during this process some users may see the old version of the app name or an old/broken app icon in their Teams client.
This can typically be fixed by having the user logging out of Teams and logging back in. If that doesn’t work, the user can go in and manually clear the cache in teams following this Microsoft guide: Clear the Teams client cache >>
Please contact us at support@instant-tech.com if you have any questions.
How to Create a Markdown Link on an FAQ
Set Links to Open In a New Tab
To create a Markdown link in an FAQ that opens in a new tab, you can use the following format:
[Link Text](URL){target="_blank"}
Replace Link Text
with the text you want to display for the link, and replace URL
with the actual URL you want to link to.
Here's a breakdown of the attributes used:
target="_blank"
: This attribute tells the browser to open the linked document in a new tab or window.
So, for example, if you want to create a link to Google that opens in a new tab with the text "Google", you would write:
[Google](https://www.google.com){target="_blank"}
Optimize Service Desk Agents With AI Assist
Streamline Customer Support With AI Agent Tools
This article outlines the configuration setup and usage of the Agent AI Assist feature. This feature allows for the creation of generated responses utililizing a custom Chat GPT bot. This allows agents to generate responses based on guest input mid-chat and referencing of knowledge base content (FAQs) for streamlined responses.
Configuration
To configure this feature configuration page navigate from the Admin menu to Chime Settings > Agent AI Chat Assist. This is were custom Chat GPT bot parameters can be set as well as cognitive search (the searching of indexed FAQ content).
Parameters
- System Message Prompt - This will instruct the AI about how it should respond to the user.
- Number of Previous Messages to Include - Number of previous messages to send as context for the AI to use in its response.
Advanced Settings
- Choice Count - Number of alternates responses to return for a prompt
- Max Tokens - Maximum number of tokens to generate in the response
- Temperature - Sampling temperature to use that controls the apparent creativity of generated completions. Higher values will make output more random while lower values will make results more focused and deterministic
- Top P - Controls randomness of response. Lower values are more deterministic.
- Frequency Penalty - Controls repetition in response. Positive values will make tokens less likely to appear as their frequency increases and decrease the model's likelihood of repeating the same statements verbatim.
- Precense Penalty - Controls repetition in response. Positive values will make tokens less likely to appear when they already exist and increase the model's likelihood to output new topics.
Knowledge Base Search Extension Settings - Options for Knowledge Base Integration
- Use Cognitive Search - Allow chatbot to access indexed knowledge base resources (FAQs, etc) to enrich responses
- Restrict Bot Responses to Knowledge Base - When enabled, the chatbot will only suggest responses based on information recovered from knowledge base resources (FAQs, etc). If it cannot find any relevant resources, it will inform the user. When disabled, the chatbot will suggest responses based on information recovered from knowledge base resources (FAQs, etc) but can also respond using data from its base model if no relevant information is found. NOTE: Information generated may not always be correct.
- Strictness - Strictness controls how closely the chatbot will match searched documents to the user's query. Raising the value means a higher threshold for relevance and filters out less-relevant documents for responses. Setting this value too high might cause the model to fail to generate responses due to limited available documents.
- Maximum Retrieved Documents - The maximum number of top-scoring documents to provide the chatbot as background to generate a response. Increasing this value may improve the quality of responses if there are many short documents in the knowledge base.
- Search Query Type - Users can choose between 'Simple' and 'Semantic' search query types.
- FAQ Citation Link Options - Users can opt to display cited documents as footnotes, where URLs are included at the end of the message, inline within the response, or choose not to link the source documents at all.
Agent Experience
- As an Agent, upon connecting to a chat navigate to the 'AI Assist' tab of the agent context window
- Select the 'Suggest Response' button to prompt the Chat GPT bot to create a response or multiple responses
- After the responses are generated, the agent has the ability to edit them before sending. If multiple responses are generated the agent can pick which one answers the query best or has the most accurate reference content
Guest Experience
On the Guest side the AI Assist response will match the settings that were configured on the Admin menu (maximum retrieved documents, FAQ citation link options, etc.) which will change how it is displayed.
Related Content
Connect Azure OpenAI ChatGPT with Azure Cognitive Search: A Step-by-Step Guide - FAQ
AI Help Desk Features - Chime V5 Site Page
Using AI and Chat in your service desk - additional tools to help agents resolve issues - Youtube Video
Simplifying Login Domain Restrictions - Chime V5 Blog
Enhancing Content Security: A Closer Look at Role-Based Security in your Service Desk - Chime V5 Blog
Import SharePoint Site Content
Use as ChatBot or Chat FAQs
This article outlines how to setup and use the SharePoint site importer feature. This feature allows you to register your azure ad app registration and select SharePoint sites/document libraries to import into Chime V5 FAQs.
Configure Your Azure AD App Registration
Note: If you have not already setup your Azure AD App Registration refer here for the steps: Setup Azure Graph API
Navigate to Chime Settings > SharePoint Importer > Settings in the Admin menu
Fill out the fields for the Azure AD App Registration Settings (Display Name, Tenant ID, Client ID, Client Secret, Client Secret Expiration Date)
Select the 'Save' button
Fill in the Client Secret once again and select the 'Test Credentials' button to confirm that they are valid
Select Your SharePoint Sites
On the SharePoint Importer Settings page select the 'Pick Sites' button under 'Selected SharePoint Sites'
Enter the URL of your sharepoint site in the search bar of the pop up window
Select the 'Add' button for any sites listed that you would like to add
Select Your Document Libraries
On the SharePoint Import Settings page select the 'Pick Libraries' button under 'Selected Document Libraries' Note: Make sure that you have selected a site first
Enter the URL of your sharepoint site in the search bar of the pop up window
Select the 'Add' button for any document libraries that you would like to add
Select & Import Sites As FAQs
Navigate to the Chime Settings > SharePoint Importer > Import FAQs page
The content that is listed will be from the selected sharepoint sites/document libraries. Pick a site page from the list and select the 'Import FAQ' button
After the edit FAQ window displays with the imported content make any edits needed and select the 'Publish' button
Update Imported Content To Latest SharePoint Version
Navigate to the SharePoint imported FAQ you would like to update
Select the 'Edit' button and navigate to the SharePoint tab
At the bottom of the page select the 'Check for Updates' button
If there is a new version of the document available on SharePoint an 'Update' button will display. Select the button to update the FAQ to the latest version
SharePoint FAQ Listings
When the SharePoint Content has been imported into Chime V5, there are unique tags for the FAQs that identify them as well as if their up-to-date status.
SharePoint Content In A Live Chat
After the SharePoint content has been indexed it can be surfaced in a live chat using the FAQlookup, ChatGPT AI Bot, and Agent AI Assist features.
Additional Resources
Configure Azure Graph API for Chime V5
First Steps Setting Up SharePoint Import Integration
This article is intended to assist with the setup of Azure Graph API for Chime v5 SharePoint Importer feature.
As part of this setup, we will need to do the following steps to have this feature fully configured:
Add the SharePoint (Site) Application Permission onto your Chime App Registration and have it approved by an Azure Admin.
Setup the SharePoint Importer Setting in Chime Admin area.
Have an Azure Admin consent to the application changes that were made.
Important Roles
As part of this setup and configuration process, a tenant administrator for the Microsoft Office 365 tenant will need to perform several actions in order to provide the necessary authorization for the SharePoint connector.
Azure Admin with permissions to grant consent on App Registration Permission updates
Chime Admin
App Registration
From the app registration, save the following values:
The application ID (referred to as Object ID on the Microsoft Entra admin center) assigned by the app registration portal
A client secret (application password)
Azure Graph API SharePoint (Site) Permission
Steps for Azure Admin for setting up permissions:
- Navigate to https://portal.azure.com/ and then Microsoft Entra ID (previously Azure Active Directory)
- Click on the App Registrations option on the left-side menu.
- Select the application that is used for your Chime deployment.
- In this new view, click the API Permissions button.
- Select Microsoft Graph from the list of Microsoft API’s listed.
- Select Application permissions.
- Use the search bar to find and add the following required permissions:
- Sites.Read.All
Click the Add Permissions button.
It is necessary to grant administrator consent for this permission. Click the Grant admin consent button.
- For creating Client Secret click the Certificates & secrets button.
- Click the New client secret button.
- Enter a description for your client secret.
- Click **Add **to create a new API key.
- Copy the newly created API secret key somewhere you can retrieve it. You will need this API secret key when configuring the SharePoint Importer feature.
Additional Resources
February 2024 Updates
I’d like to share a few updates from our team as well as some of the news that we are following from Microsoft.
First, we have continued to update Chime V4 and we have recently made some improvements to the way that the application tracks the agent’s presence. We are now using some recently released updates to the Microsoft Teams presence API and this may only be important if you sometimes encounter sporadic presence changes across your list of agents in Chime.
Here is the Chime V4 landing page with release notes: https://www.addchime.com/teams-release-notes.html
With Chime V5, we are continuing to add additional features around our chat pipelines, the FAQ area, AI features, and agent tools.
With our chat pipelines, we have created a modular (Orchard) approach to the pipeline service. This allows us to easily add additional pipeline actions (such as ChatPGT) and add support for additional ticketing providers (we currently support SolarWinds, ServiceNow, Cherwell, and Invgate). Our ticketing integration is designed to help deflect inbound chats by displaying active tickets, provide the agent with a list of the tickets when the agent accepts the chat, or create a ticket after the chat is completed.
Fikri provides a nice demo of some of this integration – as well as some integration with ChatGPT.
https://www.youtube.com/watch?v=wmDWstfAmsU
As some background, Chime V5 is built ‘on top of’ an enterprise CMS (Orchard) platform. We built on a CMS in order to create and manage content (FAQs, KB articles, Reports) that would be helpful as part of employee self-service. Currently, these FAQs can be used during inbound chat sessions, as well as to help create a searchable index that could be integrated with AI based services (models). The opportunity here is that a custom conversational experience can be ‘seeded’ with FAQs and the conversational experience can be improved by creating, or updating, FAQs and other content. These FAQs and KB articles can also help agents resolve questions.
Our FAQs now include the following features that we know will be beneficial:
1 FAQs can be created and stored at part of a department (your tenant). These FAQs can be searched as part of an inbound chat session and provided to agents.
2 We have created a new synchronization service to automatically index Chime based FAQs against an AI Cognitive Service. Once indexed, the content from these FAQs can be combined with a ChatGPT base model to create an excellent custom conversational chat experience. We’ve also created a ChatGPT pipeline service to integrate this functionality into chat.
3 We are also developing a SharePoint integration layer to import content from a SharePoint library into our FAQ system. Once imported, this content can also be indexed and used as part of a conversational chat experience.
Please contact us if you’d like to provide feedback, or test, this SharePoint integration feature.
Here is some information on our FAQ system: https://www.chimev5.com/ai-help-desk-faq-articles
Here is a link to our Chime V5 release notes: https://www.chimev5.com/teams-integrated-azure-ai-powered-help-desk-release-notes
Today, Microsoft announced the general available of ‘On Your Data’ which is now available in the Azure Open AI Service: https://techcommunity.microsoft.com/t5/ai-azure-ai-services-blog/on-your-data-is-now-generally-available-in-azure-openai-service/ba-p/4059514
We are using these same techniques, as well as the Azure AI service to index and overlay Chime content against common models GPT 35 and GPT-4. With Chime, we also add routing to agents, live dashboards, reporting on every chat session and interaction, and configurable chat routing. Service desk agents will also have access to these tools after they accept a chat conversation – in addition to real time language translation.
Chime V5 is available from the Microsoft Teams Store: https://appsource.microsoft.com/en-us/product/office/WA200005569
As well as the Microsoft AppSource: https://appsource.microsoft.com/en-us/product/web-apps/invitrixllcdbainstanttechnologies1588961047387.instant_chime_v5_july_2023
Please reach out with any questions or contact me with questions or feedback.
We are very interested in learning about your ideas (and strategies) around employee self-service and leveraging chat, AI, and content to help employees quickly resolve issues.
Peyton
Integrating Microsoft Teams Chat into Your Webpage
Add Customizable Web & Teams Client To Your Site
Are you looking to enhance your help desk landing page or support webpage by integrating your Microsoft Teams Bot Framework application? Look no further – this guide will walk you through the process of creating an HTML button that opens your Teams bot, allowing your end users to access it without leaving your webpage.
Step 1: Get your Chime Dispatcher Bot ID (Bot Framework ID)
- Navigate to Chime > Admin > Dispatcher.
- Locate the queue dispatcher that you want to expose to your webpage.
- Copy the Bot ID associated with the chosen dispatcher.
Step 2: Create the Button HTML Element
Replace the BOT_ID
string in the template below with the Bot ID obtained in Step 1.
<button onclick="window.open('msteams:/l/chat/0/0?users=28:'+'BOT_ID', '_parent')">IT Service Desk</button>
Step 3: Add the HTML Button to Your Webpage and Test
- After updating the HTML button template, copy and paste the button element into your webpage.
- Click on the button.
- If you are using Chrome, click on Open Microsoft Teams.
- The Microsoft Teams desktop client should now direct you to your bot conversation.
Now, your users can access your Microsoft Teams Bot Framework application through your webpage, enhancing the overall user experience.
AI Agent Translation: Bridging Communication Across Languages
Enable AI Translation For Real-Time Translation For Guests & Agents
Overview
In the ever-evolving landscape of communication tools, ChimeV5.AI takes a leap forward with its latest update. This update introduces a groundbreaking feature – ChimeV5.AI.AgentTranslation, designed to facilitate seamless communication between agents and guests, breaking down language barriers in real-time.
Feature: ChimeV5.AI.AgentTranslation
This new feature is a game-changer for Premium and Enterprise tier Chime tenants, offering translation services when agents and guests are connected. However, please note that this feature is not available for Standard tier tenants. To utilize ChimeV5.AI.AgentTranslation, the ChimeV5.AI.Translation feature must be enabled and configured.
Changes to Azure Translation Service Settings
The ChimeV5.AI.Translation feature has undergone a refinement to enhance user experience. The "Test Connection" button now seamlessly tests Azure service settings without reloading the entire settings page. This improvement prevents the loss of recently tested values and resolves issues with the Azure SignalR service.
New Features for ChimeV5.AI.AgentTranslation
Tenant-level Language Selection
ChimeV5.AI.AgentTranslation introduces tenant-level language selection, allowing administrators to control language options available to agents. The toggle for "Select Available Languages" empowers administrators to either permit agents to choose from all Azure Translation-supported languages or restrict them to a predefined list.
Agent Language Selection
Agents now have a "Translation Settings" tab in their user profile, enabling them to set their preferred language. Administrators can also manage this preference from the Manager Dashboard or the Agent Dashboard.
Guest Webclient Changes
The guest's preferred language is automatically detected based on their browser language settings shown in Guest.Locale metadata. For testing purposes, this can be overridden through Chrome Dev Tools.
Agent Web Client Changes
Translation Tab
The agent web client now boasts a "Translation" tab when connected to a guest. Agents can set their preferred language, and this locale is tagged to their connection for the duration of the chat session.
Real-time Translation
Messages between the guest and the agent are translated in real-time. Whether the language is the same or different, ChimeV5.AI.AgentTranslation ensures clear communication.
Chat Transcript
The chat transcript provides a comprehensive record, showcasing the guest's experience with translated messages received and the original text sent by agents.
Architectural Details
ChimeV5.AI.AgentTranslation takes a server-side approach for translation, enhancing simplicity and security. By handling translations on the server engine side, the system avoids exposing API keys to the client, ensuring a more secure environment.
The decision to implement server-side translation simplifies the process of translating plain-text messages exchanged between agents and guests. This approach also maintains a secure environment for API keys, eliminating potential risks associated with client-side exposure.