From aea8159ae1fd380d705bb745fa69d2c086cec489 Mon Sep 17 00:00:00 2001 From: Bhavana Hindupur Date: Thu, 18 Apr 2024 11:27:24 +0100 Subject: [PATCH] Add documentation about getting support. (#705) * Add documentation about getting support. * Update the support documentation to include link to azure workbooks reference. --- README.md | 4 ++++ SUPPORT.md | 13 +++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 SUPPORT.md diff --git a/README.md b/README.md index ddc4d627c..3327460ed 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,10 @@ This repository provides a template for setting up the solution accelerator, alo * Easy prompt configuration * Multiple chunking strategies +### Getting Support + +If you're facing issues with setting up or using Chat With Your Data, follow the instructions [here](SUPPORT.md) to get support. + ### When should you use this repo? If you need to customize your scenario beyond what [Azure OpenAI on your data](https://learn.microsoft.com/azure/ai-services/openai/concepts/use-your-data) offers out-of-the-box, use this repository. diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 000000000..d65f4a564 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,13 @@ +# Getting support + +This document explains how to get support if you're facing any issues with the Chat with your Data Solution Accelerator. Please read through the following guidelines. + + +## Raise an issue +If you've found a bug in Chat with your data, please [raise an issue](CONTRIBUTING.md#submit-issue) with us to get support. + +## Troubleshoot a problem +You could also troubleshoot the issue yourself by accessing the Azure Workbook that gets deployed when you deploy Chat With Your Data to your Azure subscription. The Workbook contains logs and metrics from various components of the application (e.g. latency, request failure count, tokens processed by OpenAI service etc). + +To access the workbook, go to your resource group on the Azure portal and click on the Azure Workbook resource. +For more details on how to access your Azure Workbook, please refer to this [guide](https://learn.microsoft.com/en-us/azure/azure-monitor/visualize/workbooks-overview#accessing-azure-workbooks).