Skip to content

Commit 4e81ea2

Browse files
Merge pull request #291 from microsoft/toherman-msft-patch-1
docs-readme-update
2 parents 3360f4f + ff49b17 commit 4e81ea2

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
>Legal Notice: This is a pre-release and preview solution and therefore may not work correctly. Certain features may be missing or disabled. Microsoft may change or update this pre-release and preview solution at any time.
2-
3-
# Generic Build your own copilot Solution Accelerator
1+
# Document Generation Solution Accelerator
42

53
MENU: [**USER STORY**](#user-story) \| [**ONE-CLICK DEPLOY**](#one-click-deploy) \| [**SUPPORTING DOCUMENTS**](#supporting-documents) \|
64
[**CUSTOMER TRUTH**](#customer-truth)
@@ -13,9 +11,9 @@ User story
1311

1412
**Solution accelerator overview**
1513

16-
This solution accelerator is a powerful tool that helps you create your own AI assistant(s). The accelerator can be used by any customer looking for reusable architecture and code snippets to build an AI assistant(s) with their own enterprise data.
14+
This solution accelerator is a powerful tool that helps you create your own AI assistant for document generation. The accelerator can be used by any customer looking for reusable architecture and code snippets to build an AI assistant to generate a sample template and content grounded on their own enterprise data.
1715

18-
It leverages Azure OpenAI Service and Azure AI Search, to identify relevant documents, summarize unstructured information, and generate Word document templates using your own data.
16+
It leverages Azure OpenAI Service and Azure AI Search, to identify relevant documents, summarize unstructured information, and generate document templates.
1917

2018
**Scenario**
2119

@@ -66,7 +64,7 @@ https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-regi
6664

6765
2. Click the following deployment button to create the required resources for this accelerator in your Azure Subscription.
6866

69-
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2FGeneric-Build-your-own-copilot-Solution-Accelerator%2Fmain%2Finfrastructure%2Fdeployment.json)
67+
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2Fdocument-generation-solution-accelerator%2Fmain%2Finfrastructure%2Fdeployment.json)
7068

7169
3. You will need to select an Azure Subscription, create/select a Resource group, and Region. If your intention is to deploy this solution accelerator and the corresponding sample data set, the default settings will suffice.
7270

docs/TRANSPARENCY_FAQ.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
## Build your own copilot - Generic Solution Accelerator: Responsible AI FAQ
1+
## Document Generation Solution Accelerator: Responsible AI FAQ
22
- ### What is Build your own copilot - Generic Solution Accelerator?
33
This solution accelerator is an open-source GitHub Repository to help create AI assistants using Azure OpenAI Service and Azure AI Search. This can be used by anyone looking for reusable architecture and code snippets to build AI assistants with their own enterprise data. The repository showcases a generic scenario of a user who wants to generate a document template based on a sample set of data.
44

5-
- ### What can Build your own copilot - Generic Solution Accelerator do?
5+
- ### What can Document Generation Solution Accelerator do?
66
The sample solution included focuses on a generic use case - chat with your own data, generate a document template using your own data, and exporting the document in a docx format. The sample data is sourced from generic AI-generated promissory notes. The documents are intended for use as sample data only. The sample solution takes user input in text format and returns LLM responses in text format up to 800 tokens. It uses prompt flow to search data from AI search vector store, summarize the retrieved documents with Azure OpenAI.
77

8-
- ### What is/are Build your own copilot - Generic Solution Accelerator’s intended use(s)?
8+
- ### What is/are Document Generation Solution Accelerator’s intended use(s)?
99
This repository is to be used only as a solution accelerator following the open-source license terms listed in the GitHub repository. The example scenario’s intended purpose is to help users generate a document template to perform their work more efficiently.
1010

11-
- ### How was Build your own copilot - Generic Solution Accelerator evaluated? What metrics are used to measure performance?
11+
- ### How was Document Generation Solution Accelerator evaluated? What metrics are used to measure performance?
1212
We have used AI Foundry Prompt flow evaluation SDK to test for harmful content, groundedness, and potential security risks.
1313

14-
- ### What are the limitations of Build your own copilot - Generic Solution Accelerator? How can users minimize the impact of Build your own copilot - Generic Solution Accelerator’s limitations when using the system?
14+
- ### What are the limitations of Document Generation Solution Accelerator? How can users minimize the impact of Document Generation Solution Accelerator’s limitations when using the system?
1515
This solution accelerator can only be used as a sample to accelerate the creation of AI assistants. The repository showcases a sample scenario of a user generating a document template. Users should review the system prompts provided and update as per their organizational guidance. Users should run their own evaluation flow either using the guidance provided in the GitHub repository or their choice of evaluation methods. AI-generated content may be inaccurate and should be manually reviewed. Currently, the sample repo is available in English only.
16-
- ### What operational factors and settings allow for effective and responsible use of Build your own copilot - Generic Solution Accelerator?
16+
- ### What operational factors and settings allow for effective and responsible use of Document Generation Solution Accelerator?
1717
Users can try different values for some parameters like system prompt, temperature, max tokens etc. shared as configurable environment variables while running run evaluations for AI assistants. Please note that these parameters are only provided as guidance to start the configuration but not as a complete available list to adjust the system behavior. Please always refer to the latest product documentation for these details or reach out to your Microsoft account team if you need assistance.

0 commit comments

Comments
 (0)