Skip to content

Commit 4436ccb

Browse files
Merge pull request #236 from microsoft/PSL-US-14267
docs: replace Studio and Open AI
2 parents e061473 + 91e2c39 commit 4436ccb

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ User story
1515

1616
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.
1717

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.
1919

2020
**Scenario**
2121

@@ -44,13 +44,13 @@ One-click deploy
4444

4545
### Prerequisites
4646

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.
4848

4949
For additional training and support, please see:
5050

51-
1. [Azure Open AI](https://learn.microsoft.com/en-us/azure/ai-services/openai/)
51+
1. [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/)
5252
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/)
5454

5555
### Solution accelerator architecture
5656
![image](/docs/images/architecture.png)
@@ -62,7 +62,7 @@ For additional training and support, please see:
6262
### **How to install/deploy**
6363

6464
1. Please check the link [Azure Products by Region](
65-
https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all&regions=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&regions=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.
6666

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

docs/README_LOCAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ NOTE: You may find you need to set: MacOS: `export NODE_OPTIONS="--max-old-space
2727
[More information about Azure OpenAI on your data](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/concepts/use-your-data)
2828

2929
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.
3131

3232
These variables are required when adding your data with Azure AI Search:
3333
- `DATASOURCE_TYPE` (should be set to `AzureCognitiveSearch`)

docs/TRANSPARENCY_FAQ.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
## Build your own copilot - Generic Solution Accelerator: Responsible AI FAQ
22
- ### 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.
44

55
- ### 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.
77

88
- ### What is/are Build your own copilot - Generic 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

1111
- ### 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.
1313

1414
- ### 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?
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.
1616
- ### 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

Comments
 (0)