Skip to content
This repository was archived by the owner on Jun 30, 2022. It is now read-only.

Commit 745cca4

Browse files
ryanisgrigdarrenj
authored andcommitted
Refactor documentation to be more discoverable and easier to get started (#881)
* Refactored all docs under single docs directory, split into: analytics, media, transcripts, skills, virtual-assistant. Resolved all URL refs * Removed the "skills" or "virtualassistant-skills" prepend to current documents and updated related docs with new URLs. * Cleaned up skills docs except for automotive * Cleaned up READMEs so only root has the Contributing/License info and added a link to Analytics on root. * Clean up the VA README * Refactored detailedoverview to overview and consolidated with VA/READM Refactored createvirtualassistant to gettingstarted * Moved language support and updating virtual assistant content to main README. Standardize skill to Skill usage. Added table of contents formatting to linked accounts, personalization, responses docs. * Updated formatting for remaining VA pages. * Using writing style for readme * Updating -> Deployment section and moved Personalization under Dive In * Added blurb for unit testing to be developed as the toolkit grows. * Updated skills readme with writing style * Updated text on analytics and main readme * Updated known issues and applied writing style guide to getting started overview * Bold preview to italics per style guide * Added links to bot services on main readme * Update getting started link * add proactivemodel deserialization issue into the known issues list * Refactored all docs under single docs directory, split into: analytics, media, transcripts, skills, virtual-assistant. Resolved all URL refs * Removed the "skills" or "virtualassistant-skills" prepend to current documents and updated related docs with new URLs. * Cleaned up skills docs except for automotive * Cleaned up READMEs so only root has the Contributing/License info and added a link to Analytics on root. * Clean up the VA README * Refactored detailedoverview to overview and consolidated with VA/READM Refactored createvirtualassistant to gettingstarted * Moved language support and updating virtual assistant content to main README. Standardize skill to Skill usage. Added table of contents formatting to linked accounts, personalization, responses docs. * Updated formatting for remaining VA pages. * Using writing style for readme * Updating -> Deployment section and moved Personalization under Dive In * Added blurb for unit testing to be developed as the toolkit grows. * Updated skills readme with writing style * Updated text on analytics and main readme * Updated known issues and applied writing style guide to getting started overview * Bold preview to italics per style guide * Added links to bot services on main readme * Update getting started link * add proactivemodel deserialization issue into the known issues list * Added powershell 6 prereq and csharp/typescript deployment * Updated Skills README and added luis model generation doc to it * Refactored skill enablement doc to Create a New Skill * Added README for transcripts and renamed existing transcripts to use same filename formatting Updated events doc and added links in productivity/poi skills where parameters are mentioned. * Address Darren's PR comments * Added email and todo sample transcripts to docs * Added developing a new skill page * Added code samples of development guide and refs on related READMEs * Fix typo * Remove OBI links Add calendar transcript and remove skillsdemo transcript Update linked accounts * Removed transcript from old docs location * Fixed capitalization * added local mode deployment instructions * highlight local mode deployment * update to PoI skill invocation test
1 parent a49315b commit 745cca4

File tree

88 files changed

+1608
-6862
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+1608
-6862
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
1-
# Overview
1+
# Conversational AI Solutions
22

3-
This repository is the home for a set of templates and solutions to help build Conversational Experiences using Azure Bot Service and Bot Framework.
3+
This repository is the home for a set of templates and solutions to help build conversational experiences using [Azure Bot Service](https://aka.ms/azurebotservice) and [Bot Framework](https://botframework).
44

5-
# Templates
5+
## Templates
66

77
Name | Description | Link
88
------------ | ------------- | :-----------:
9-
Enterprise Template | The creation of a high quality conversational experience requires a foundational set of capabilities. To help you succeed with building great conversational experiences, we have created an Enterprise Bot Template. <br /> <br />This template brings together all of the best practices and supporting components we've identified through building conversational experiences and greatly simplifies the creation of a new bot project including: basic conversational intents, Dispatcher integration, QnA Maker, Application Insights, Power BI insights and an automated deployment. | [Get Started](./templates/Enterprise-Template/README.md)
9+
Enterprise Template | A high quality conversational experience requires a foundational set of capabilities to maintain consistent quality. Install the Enterprise Bot Template for help in building a great experience with your users. <br /> <br />This template brings together all of the best practices and supporting components identified through building conversational experiences and greatly simplifies the creation of a new bot project including: basic conversational intents, Dispatch integration, QnA Maker, Application Insights and an automated deployment.| [Get Started](./templates/Enterprise-Template/README.md)
1010

11-
# Solutions
11+
## Solutions
1212

1313
Name | Description | Link
1414
------------ | ------------- | :-----------:
15-
Virtual Assistant | We have seen significant need from our customers and partners to deliver a conversational assistant tailored to their brand, personalized to their customers and made available across a broad range of conversational canvases and devices. <br /> <br /> Continuing Microsoft's open-source approach towards the Bot Framework SDK, the open source Virtual Assistant provides full control over the end user experience built on a set of foundational capabilities. Additionally, the experience can be infused with intelligence about the end-user and any device/ecosystem information for a truly integrated and intelligent experience. | [Get Started](./solutions/Virtual-Assistant/docs/README.md)
15+
Virtual Assistant | Customers and partners have a significant need to deliver a conversational assistant tailored to their brand, personalized to their users, and made available across a broad range of canvases and devices. <br/><br/> Continuing Microsoft's open-sourced approach towards the Bot Framework SDK, the open-source Virtual Assistant solution provides you with a set of core foundational capabilities and full control over the end user experience.| [Get Started](./docs/virtual-assistant/README.md)
16+
Analytics | Gain key insights into your bot’s health and behavior with the Conversational AI Analytics solutions. Review available telemetry, sample Application Insights queries, and Power BI dashboards to understand the full breadth of your bot’s conversations with users. | [Get Started](./docs/analytics/README.md)
1617

17-
# Contributing
18+
## Contributing
1819

1920
This project welcomes contributions and suggestions. Most contributions require you to agree to a
2021
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
@@ -27,3 +28,6 @@ provided by the bot. You will only need to do this once across all repos using o
2728
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
2829
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
2930
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
31+
32+
## License
33+
Copyright (c) Microsoft Corporation. All rights reserved.

solutions/analytics/README.md renamed to docs/analytics/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ insights across your organization. You can ingest data from Application Insights
1414
- [Power BI Analytics Sample](#power-bi-analytics-sample)
1515

1616
## Prerequisites
17-
The [Conversational Analytics Power BI sample](ConversationalAnalyticsSample_02132019.pbit) is generated
17+
The [Conversational Analytics Power BI sample](https://aka.ms/botPowerBiTemplate) is generated
1818
under the assumption you are using the latest Bot Framework SDK and telemetry middleware. You can find these (and generate the required Application Insights resource) with the following samples:
1919

2020
- [Enterprise Template](https://github.com/Microsoft/AI/blob/master/templates/Enterprise-Template/README.md)
@@ -24,28 +24,27 @@ under the assumption you are using the latest Bot Framework SDK and telemetry mi
2424

2525
### Configuring Sentiment
2626
LUIS enables you to run a sentiment analysis on a user's utterance. This can be enabled through the [LUIS portal](https://www.luis.ai).
27-
Sentiment must be enabled for each application. To enable sentiment:
27+
Sentiment must be enabled for each application. To enable sentiment:
2828
1. Log in to the portal.
2929
2. Select **My Apps**.
3030
3. Click on the specific application you want to enable sentiment.
3131
4. Select **Manage** on the upper menu.
3232
5. Select **Publish Settings** on the side menu. It should resemble the below.
3333

34-
![Enabling Sentiment](media/enable_sentiment.png)
34+
![Enabling Sentiment](../media/enable_sentiment.png)
3535

3636
6. **Enable** the *Use sentiment analysis to determine if a user's utterance is positive, negative, or neutral* checkbox.
3737
7. Select **Publish** and repeat for each LUIS application.
3838

3939
### Power BI Installation
4040
The [PowerBI Desktop client](https://aka.ms/pbidesktopstore) is available for Windows clients.
41-
Alternatively, you can use the Power BI service. If you don't have a PowerBI service account, sign up for a [free 60 day trial account](https://app.powerbi.com/signupredirect?pbi_source=web) and upload the Power BI template to view the reports.
41+
Alternatively, you can use the Power BI service. If you don't have a PowerBI service account, sign up for a [free 60 day trial account](https://app.powerbi.com/signupredirect?pbi_source=web) and upload the Power BI template to view the reports.
4242

4343
## Telemetry Logging
44-
[Telemetry Overview](docs/analytics-telemetrylogging.md) highlights the provided telemetry for bot and user activities, including [LUIS](https://www.luis.ai/) and [QnA Maker](https://www.qnamaker.ai/) results. how to configure your bot's telemetry, either through bot configuring or overriding the telemetry client.
44+
[Telemetry Overview](./telemetrylogging.md) highlights the provided telemetry for bot and user activities, including [LUIS](https://www.luis.ai/) and [QnA Maker](https://www.qnamaker.ai/) results. how to configure your bot's telemetry, either through bot configuring or overriding the telemetry client.
4545

4646
## Application Insights Analytics
47-
[Applications Insights Analytics](docs/analytics-applicationinsights.md) demonstrates how to execute common queries for for bot analytics and debugging in Visual Studio.
47+
Common queries for bot analytics are available in [Applications Insights Analytics](./applicationinsights.md).
4848

4949
## Power BI Analytics Sample
50-
51-
The [Power BI Analytics sample](docs/analytics-powerbi.md) shows example Power BI dashboards to gain insights on your bot's performance and quality.
50+
Examples of Power BI dashboards are provided in the [Power BI Analytics sample](./powerbi.md), highlighting how to gain insights on your bot's performance and quality.

solutions/analytics/docs/analytics-applicationinsights.md renamed to docs/analytics/applicationinsights.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ The following provide some examples of retrieving data about your bot, to better
33

44
## LUIS Intents Piechart
55

6-
The following demonstrates querying data that was generated by LUIS telemetry. The telemetry logs the top intent from the recognizer (in addition to some other properties), and logs an [Application Insights Custom Event](https://docs.microsoft.com/en-us/azure/application-insights/app-insights-api-custom-events-metrics).
6+
The following demonstrates querying data that was generated by LUIS telemetry. The telemetry logs the top intent from the recognizer (in addition to some other properties), and logs an [Application Insights Custom Event](https://docs.microsoft.com/en-us/azure/application-insights/app-insights-api-custom-events-metrics).
77

88
![Luis Piechart](../media/luis_pie.png)
99
```
@@ -49,7 +49,7 @@ dependencies
4949
```
5050

5151
## Using Application Insights in Visual Studio
52-
Within Visual Studio, Application Insights events can be queried in the "Application Insights Search" window. [For more details, see the Application Insights documentation](https://docs.microsoft.com/en-us/azure/application-insights/app-insights-diagnostic-search).
52+
Within Visual Studio, Application Insights events can be queried in the "Application Insights Search" window. [For more details, see the Application Insights documentation](https://docs.microsoft.com/en-us/azure/application-insights/app-insights-diagnostic-search).
5353

5454
![Example Visual Studio Session](../media/visualstudio_appinsights.png)
5555

solutions/analytics/docs/analytics-powerbi.md renamed to docs/analytics/powerbi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Power BI
2-
The [Conversational Analytics Power BI sample](../ConversationalAnalyticsSample_02132019.pbit) provides a PowerBI template that can be used to understand how your bot is performing.
2+
The [Conversational Analytics Power BI sample](https://aka.ms/botPowerBiTemplate) provides a PowerBI template that can be used to understand how your bot is performing.
33

44
## Sample Overview
55
|Dashboard Name|Description|

0 commit comments

Comments
 (0)