MicroStrategy ONE
Create and Edit a Bot
Bots are supported in MicroStrategy Cloud environments and starting in MicroStrategy ONE (March 2024), Bots are supported on the MicroStrategy Cloud for Government platform. You can only use Bots in MicroStrategy Library.
Starting in MicroStrategy ONE (June 2024), you can use the Usage panel to view a variety of information including the amount of users, feedback information, interpretation requests, etc. You can also right-click attributes to select which forms can be used by the Bot.
Starting in MicroStrategy ONE (March 2024), you can enable interpretation of your Bot responses and enrich your Bot capabilities and accuracy by uploading a knowledge asset that provides context that is specific to your organization. You can also right-click an object in a dataset to rename it or configure a number format. MicroStrategy ONE (March 2024) also includes new general settings to enable topic suggestions and enable the Ask About panel.
Starting in MicroStrategy ONE Update 12, you can create a highly customized Bot tailored to your organization's needs. This advanced customization encompasses many options that empower you to extract valuable insights from a selected dataset.
When you create a new Bot, you will be prompted to select an existing dataset or create one with new data. The interface will allow you to ask questions immediately or configure different options that will personalize the experience. Five main tabs will allow you to do this:
- General: Define settings to guide the Bot user experience.
- Appearance: Define the look and feel of the Bot.
- Custom Instructions: Specify the Bot's business background and format responses.
- Data: Modify dataset settings used to build the Bot.
- Usage: View user usage statistics for your Bot.
Check out the following topics to get started:
Create a Bot with New Data
You can use this option when adding new data into MicroStrategy or if you don't have any datasets already created that have the data you need.
- Choose Create New > Bot.
If Bot is not available, see Troubleshoot Bots for more information.
-
Click Create with New Data.
If you can't see the Create with New Data option, ensure you have one of the following privileges:
-
Access data (files) from Local, URL, DropBox, Google Drive, Sample FIles, Clipboard, Push API
-
Access data from Databases, Google BigQuery, BigData, OLAP, BI tools
-
Access data from Cloud App (Google Analytics, Salesforce Reports, Facebook, Twitter)
-
- The New Dataset dialog appears, which allows you to select from the different data sources that are available, which include two main sections:
- General: Upload new data from locations such as Clipboard, Data from URL, File from Disk, Import existing dataset, Public Data, or Sample Files
- Services: Upload data from data sources enabled by your platform Administrator. These data sources are from other services such as Dropbox, Google Drive, Financial Force, Salesforce, and others.
- Once you import your data, drag and drop tables from the left Data Catalog panel to the main screen.
- Click Create.
- If needed, click Prepare Data.
- The Preview Dialog appears.
- If needed, click Wrangle:
- Confirm Refresh.
- Wrangle your data.
- Click Apply.
See Data Wrangling Dialog for more information.
- If needed, click Add/Edit Tables:
- Add or remove existing tables.
- Click Update.
- Click Update Dataset.
- Click Finish.
- See Bot Settings to customize your Bot.
Create a Bot with Existing Data
- Choose Create New > Bot.
If Bot is not available, see Troubleshoot Bots for more information.
- Select an existing dataset.
- Click Create.
- See Bot Settings to customize your Bot.
If you encounter a server error when you pick a dataset, ensure the dataset has been published before importing. If a database is grayed out, refer to it's associated documentation to configure sources correctly.
There are no options to edit a dataset if you create a Bot with existing data. These options are only available when you create a Bot with new data.
Bot Settings
You can use the settings panels to customize your Bot. Check out the following topics to get started:
General Settings
You can use General Settings to customize how your Bot behaves for different industries.
When you edit the Bot, updates are reflected immediately. You can test and adjust settings, as required.
To access the General Settings dialog:
- Create a new Bot or open an existing Bot and click the Edit icon in the upper right.
- Click the General Settings panel.
- Define your preferred settings.
Bot Cover Image: Click the Cover image in the General panel and select an image or paste a URL. The image appears as the cover image in Library.
Bot Name: Type a name for the Bot.
You can manually set i18n strings in this field. The Bot Name should not exceed 50 characters.
Active: Click the toggle to enable or disable the Bot. When you disable a Bot, it is unaffected in authoring mode. Once you click Save, the client indicates the inactive status.
Display logo next to bot's name: Starting in MicroStrategy ONE (June 2024), select the check box to display the cover image as a logo next to the Bot's name in the Bot panel.
Bot Greeting: Type a greeting for the Bot.
You can manually set i18n strings in this field. The Bot Greeting should not exceed 500 characters.
Enable Topic Suggestions: Starting in MicroStrategy ONE (March 2024), click the toggle to enable or disable topic suggestions. The Bot automatically generates three topic suggestions. You can add, edit, delete, rearrange, or regenerate any topic.
The last topic can not be deleted when the setting is enabled.
For more information, see Topics Known Limitations.
Allow saving answers to "My Snapshots": Click the toggle to enable or disable saving answers to My Snapshots.
Enable "Ask About": Starting in MicroStrategy ONE (March 2024), click the toggle to enable or disable the Ask About panel which displays information about the attributes and metrics in the dataset used by your Bot.
Enable Interpretation: Starting in MicroStrategy ONE (March 2024), click the toggle to enable interpretation of your Bot answers. For more information, see AI Interpretation and Execution.
Hint: Type a hint for a user to display in the input field.
You can manually set i18n strings in this field. The hint should not exceed 50 characters.
Enable question suggestions: Click the toggle to enable or disable question suggestions.
Automatically generated suggestions: Click the drop-down and choose the number of question suggestions to display. The default is 3.
Add Custom Suggestion: Click the plus icon to add custom suggestions. To add more suggestions, click the icon, again. Click the delete icon to remove suggestions.
Max questions / user / month: Type the maximum number of questions a user can ask the Bot each month. A month is defined as a 30-day rolling period. The count starts when a user opens the Bot and expires 30 days later.
Add Links: Click the plus icon and type a name and link. You can add up to three links. Click the delete icon to remove a link.
Display Format: Click the drop-down and choose a display format for the link.
- Click Save or continue to the other settings.
Troubleshoot General Settings
Why won't the string label in the Bot toolbar update after I change the Bot name?
Note that the Bot Name and object name are different. When you update the Bot Name, the greeting message, chat panel title, and greeting message within the chat panel update.
Why is the Bot still active when I used the toggle to deactivate it?
Ensure you saved your settings. Deactivated Bots display an inactive banner after you save your settings.
Why does my image display "image not found"?
If this error appears, check the image URL for accessibility. Update the URL using the Change Cover Image setting.
Why can't I add a custom suggestion?
You can only add custom suggestions if the total number of suggested questions (auto-generated and custom) does not exceed five.
Why can I still ask questions in editing mode when the Max question / user / month is set to zero?
The maximum question limit only applies in consumption mode.
Why are some customized string not translated into different languages?
Customized string sin languages other than the default can't be auto-translated. They will appear in the language that they were initially entered unless you manually configure them in the current language.
Topics Known Limitations
-
All topics are generated during Bot configuration so during Bot consumption, the same topics will be retrieved.
-
The client cache is turned on to store topic summaries so if you click the same topic more than once, you will retrieve the cached answers.
-
Topic summary is not added to the history list.
-
Topic summaries can not be copied, downloaded, or used to generate a snapshot.
-
Depending on whether the AI can generate three relevant questions or answers according to a topic, you may see less than three feedback options are retrieved for a topic.
-
Topics are automatically generated when you create the Bot. If you change the dataset or rename dataset objects after you create the Bot and generate topics, you should manually trigger the topic regeneration steps so topics are relevant to the latest dataset.
Appearance Settings
- Create a new Bot or open an existing Bot and click the Edit icon in the upper right.
- Click the Appearance panel.
- Define your preferred settings.
Panel Theme: Click the drop-down and choose a predefined theme or click Custom.
Custom: Further customize the color for the background, text, accent color, and canvas color by using the color picker or enter a hex code.
Visualization Palette: Choose a predefined theme for visualizations.
- Click Save or continue to the other settings.
Troubleshoot Appearance Settings
- The Panel Theme drop-down is disabled when the Bot is processing a response. Once the Bot generates a response, the Panel Theme drop-down is enabled.
- If a different theme appears when viewing the Bot vs. editing the Bot, your Administrator might have overwritten any changes to the appearance theme. In the Application Editor in Workstation, an Administrator can select Apply app theme to all bots. In this case, when viewing the Bot, the application theme appears and when editing the Bot, your chosen theme in the Appearance tab appears.
Custom Instructions
The Custom Instructions panel allows you to enable custom instructions regarding business-specific data information and tailor the response format.
- Create a new Bot or open an existing Bot and click the Edit icon in the upper right.
- Click the Custom Instructions panel.
- Toggle on Enable the custom instructions.
- Type your custom instructions.
- Upload an Excel file in Knowledge. For more information, see Upload Knowledge Assets to Bots.
- Click Save or continue to the other settings.
Troubleshoot Custom Instructions
Why won't custom instructions work?
- To add more responses and communication to the Bot, you can add 'Always add insights to response' to the custom instructions.
- When adding a visualization type to the custom instructions, MicroStrategy recommends using support visualizations such as line chart, grid chart, or bar chart. The support for other visualization types depends on the question.
- When adding attribute or metrics to the custom instructions, it must exactly match the attribute or metric in the dataset, otherwise the Bot may not be able to find the specified attribute or metric.
- Instructions should not be vague. MicroStrategy suggests adding examples.
See Custom Instructions Examples for more information.
Custom Instructions Examples
Business Background
Classifier
- Specify your own classification definition:
Example 1:
Our company's performance is divided into three grades.
Class A: [metric] > 90 and has the ability of [list]
Class B: [metric] <=90 and has the characteristics of [list]
Class C: Failed in some tests []
Example 2:
Our company is taking inventory of assets, expired products, non-tight products, hot products, value products.
Expired products:
Non-tight products:
Hot products:
Value products:
- Ignore some categories that already exist in the dataset:
Some attributes(a, b, c) in the dataset are expired. Please ignore them.
Sentiment
- Specify your own emotions:
Example 1:
[Attribute_a] is my competitor, I am super exicited to see the cost significant increase or the sales decrease.
Example 2:
I am 3 years old. I not familar with the data anyalysis.
- Specify counterintuitive emotions and semantics:
Example 1:
The increase of fail ratio is better for me.
Example 2:
As a car buyer, I am exciting to see the decrease of car sales.
Conference Resolution
- Formulate mapping relationships that do no exist in the current dataset:
Example 1:
My company is A group, contains (A-1, A-2, A3)
Use this instruction for a group that does not exist in the attribute's element.
Example 2:
The release 23.09(2309,2310,2311)
- Specify the special meaning of an element in an attribute, such as a competitor company:
Company B is our competitor.
Locale Priority
As a Chinese company, we would prefer the Chinese language.
Additional Knowledge of the Dataset
- Define formulas that match the metrics in the current dataset:
Quick Ratio = (Total current Assets -
Inventory) / Total liabilities
- Restrict the scope of a Metric as much as possible:
I am focused on the team fail ration each time that great than 15%.
- Details to explain the dataset:
Example 1:
The data in our dataset is about ....
Example 2:
The attribute a in our dataset is about ...
The metric b is about ...
Response Style
Translation
ALWAYS Respond in Chinese
The Bot response language is determined by the language used in the question. Therefore, you should add ALWAYS to highlight the request.
Sentiment
Provide some positive or negative feedback in the response.
Tone
Example 1:
Talk like a poet
Example 2:
Talk like a 3-year-old
Entailment
What data do you expect the output to be more focused on:
Example 1:
Focus on the results which [metric-A] is greater than 10%
Example 2:
Exclude the specify element [element-A] in the results.
Conference Resolution
Replace the output with special characters:
Example 1:
Use the MK to represent the Michael Kors in the response.
Do not use the following phrasing to replace output: "Use the XX to replace the [metric_name]". This phrasing confuses the Bot as "XX" does not exist in the dataset.
Example 2:
Using some ** to replace some sensitive text.
Format
- Format the response text. For example, one of the following cases:
- Add an emoji before or after the response.
- Use bullets to format the response.
- Format the response using an example.
- Divide the response into multi-paragraph:
CopyDivide the response into multi-paragraph.
For example:
## Title a
- content of pragraph
## Title b
- content of paragraph - Summarize text:
Example 1:
Respond in less than 50 words.
Example 2:
Please reply with concise sentences.
Example 3:
Respond casually and in plain terms, make answers understandable for a 7-year-old, avoiding the use of adult topics.
- Preferred visualization type:
show bar chart rather than line chart
MicroStrategy recommends only choosing a line, grid, or bar chart. Other visualization types depend on the question.
Considerations
Restrict with some diversity for the Bot. If the result is not stable, explore a different set of instructions.
Bot Data Settings
Bots are designed to work with a single dataset only. Bots support in-memory OLAT and MTDI cube dataset types. Other cube types are currently unsupported and Bots are unable to answer questions in those cases. Similarly, if no items are selected, Bots are also unable to answer questions.
Select a Dataset
- Create a new Bot or open an existing Bot and click the Edit icon in the upper right.
- Click the Data panel.
- Select or unselect the checkbox next to an item.
- Click Save or continue to the other settings.
Dataset Options
- In the Data tab, click More .
- Click one of the following options and make your required changes:
Edit Dataset. This option is only available if you created the dataset in the Bot.
- Replace Dataset
- Refresh Dataset
Rename. This option is only available if you created the dataset in the Bot.
- Starting in MicroStrategy ONE (March 2024), right-click an attribute or metric and click one of the following options:
- Rename
- Type your desired name and press Enter.
- Number Format
- Use the drop-down to choose a predefined number format and click OK.
- Rename
- Starting in MicroStrategy ONE (June 2024), right-click an attribute and use the checkboxes next to the attribute forms to select which forms can be used by the Bot.
- Click Save.
Edit Dataset
This option is only available if you created the dataset in the Bot.
- In the Data tab, click More .
- Choose Edit Dataset.
- The Preview Dialog appears.
- If needed, click Wrangle:
- Confirm Refresh.
- Wrangle your data.
- Click Apply.
See Data Wrangling Dialog for more information.
- If needed, click Add/Edit Tables:
- Add or remove existing tables.
- Click Update.
- Click Update dataset.
Replace Dataset
You can replace the current dataset in the Bot with an existing dataset or a new dataset.
- In the Data tab, click More .
- Choose Replace Dataset.
- To replace the dataset with an existing dataset, select a published dataset.
- To replace the dataset with a new dataset:
- Click Replace with New Data.
- Select a table from the left panel.
- If needed, click Prepare Data and edit your dataset.
- Click Create.
- Click Replace.
Refresh Dataset
- In the Data tab, click More .
- Choose Refresh Dataset.
- Select the checkbox next to the dataset that you want to refresh.
- Choose a Refresh Policy from the drop-down.
- Click Refresh.
Bot Data Limitations
- If all items are deselected, an error will display.
- If a standalone in-memory cube is changed to direct data access (DDA) outside of the Bot, the Bot will no longer support the data.
Usage Panel
The Usage panel allows you to view user usage information including the amount of users using the Bot, feedback information, interpretation requests, and more.
Before you can gather usage information, you must Enable Adaptive Learning and Configure Usage Telemetry.
- Create a new Bot or open an existing Bot and click the Edit icon in the upper right.
- Click the Usage panel.
-
Choose the time frame of usage information from the drop-down.
- Click Download to download a .csv file with all the questions that received a thumbs-down.
-
View the usage information.
This data refreshes every 5 minutes. If a user thumbs down a question, the data won't update until the refresh is complete and you refresh the page.
- Click Save or continue to other settings.
Troubleshoot Bots
If you click Create New and Bot is not available, check the following information:
- Check the AI Services configuration:
- Open aiConfig.json (this is the path you added in mstr_collaboration_services/lib/config.json) and ensure the following parameters are correct. If they are incorrect, edit them and restart collaboration services.
Copy{ ...
"mstrAiApiKey":"xxx",
"mstrAiBaseUrl":"xxx",
"mstrCustomerDsi":"xxx",
} - Check that you have the correct privileges. See Enable and Disable Auto for more information.