You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ User story
15
15
16
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.
17
17
18
-
It leverages Azure Open AI Service and Azure AI Search, to identify relevant documents, summarize unstructured information, and generate Word document templates using your own data.
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.
19
19
20
20
**Scenario**
21
21
@@ -44,13 +44,13 @@ One-click deploy
44
44
45
45
### Prerequisites
46
46
47
-
To use this solution accelerator, you will need access to an [Azure subscription](https://azure.microsoft.com/free/) with permission to create resource groups and resources. While not required, a prior understanding of Azure Open AI and Azure AI Search will be helpful.
47
+
To use this solution accelerator, you will need access to an [Azure subscription](https://azure.microsoft.com/free/) with permission to create resource groups and resources. While not required, a prior understanding of Azure OpenAI and Azure AI Search will be helpful.
48
48
49
49
For additional training and support, please see:
50
50
51
-
1.[Azure Open AI](https://learn.microsoft.com/en-us/azure/ai-services/openai/)
2.[Azure AI Search](https://learn.microsoft.com/en-us/azure/search/)
53
-
3.[Azure AI Studio](https://learn.microsoft.com/en-us/azure/ai-studio/)
53
+
3.[Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-studio/)
54
54
55
55
### Solution accelerator architecture
56
56

@@ -62,7 +62,7 @@ For additional training and support, please see:
62
62
### **How to install/deploy**
63
63
64
64
1. Please check the link [Azure Products by Region](
65
-
https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all®ions=all) and choose a region where Azure AI Search, Azure OpenAI Service, and Azure AI Studio are available. If you are using the included sample data set, verify Document Intelligence (Form Recognizer) is available.
65
+
https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all®ions=all) and choose a region where Azure AI Search, Azure OpenAI Service, and Azure AI Foundry are available. If you are using the included sample data set, verify Document Intelligence (Form Recognizer) is available.
66
66
67
67
2. Click the following deployment button to create the required resources for this accelerator in your Azure Subscription.
Copy file name to clipboardExpand all lines: docs/README_LOCAL.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ NOTE: You may find you need to set: MacOS: `export NODE_OPTIONS="--max-old-space
27
27
[More information about Azure OpenAI on your data](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/concepts/use-your-data)
28
28
29
29
1. Update the `AZURE_OPENAI_*` environment variables as described above.
30
-
2. To connect to your data, you need to specify an Azure Cognitive Search index to use. You can [create this index yourself](https://learn.microsoft.com/en-us/azure/search/search-get-started-portal) or use the [Azure AI Studio](https://oai.azure.com/portal/chat) to create the index for you.
30
+
2. To connect to your data, you need to specify an Azure Cognitive Search index to use. You can [create this index yourself](https://learn.microsoft.com/en-us/azure/search/search-get-started-portal) or use the [Azure AI Foundry](https://oai.azure.com/portal/chat) to create the index for you.
31
31
32
32
These variables are required when adding your data with Azure AI Search:
33
33
-`DATASOURCE_TYPE` (should be set to `AzureCognitiveSearch`)
## Build your own copilot - Generic Solution Accelerator: Responsible AI FAQ
2
2
-### What is Build your own copilot - Generic Solution Accelerator?
3
-
This solution accelerator is an open-source GitHub Repository to help create AI assistants using Azure Open AI 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.
3
+
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.
4
4
5
5
-### What can Build your own copilot - Generic Solution Accelerator do?
6
-
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 Open AI.
6
+
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.
7
7
8
8
-### What is/are Build your own copilot - Generic Solution Accelerator’s intended use(s)?
9
9
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.
10
10
11
11
-### How was Build your own copilot - Generic Solution Accelerator evaluated? What metrics are used to measure performance?
12
-
We have used AI Studio Prompt flow evaluation SDK to test for harmful content, groundedness, and potential security risks.
12
+
We have used AI Foundry Prompt flow evaluation SDK to test for harmful content, groundedness, and potential security risks.
13
13
14
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?
15
15
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
16
-### What operational factors and settings allow for effective and responsible use of Build your own copilot - Generic Solution Accelerator?
17
-
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.
17
+
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