Skip to content

Commit d1646f4

Browse files
Merge pull request #450 from microsoft/psl-Readme-and-Doc-update
docs: Updated Document generation readme and docs files
2 parents 9b95985 + bc2a85d commit d1646f4

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This example focuses on a generic use case - chat with your own data, generate a
88

99
<div align="center">
1010

11-
[**SOLUTION OVERVIEW**](#solution-overview) \| [**QUICK DEPLOY**](#quick-deploy) \| [**BUSINESS USE CASE**](#business-use-case) \| [**SUPPORTING DOCUMENTATION**](#supporting-documentation)
11+
[**SOLUTION OVERVIEW**](#solution-overview) \| [**QUICK DEPLOY**](#quick-deploy) \| [**BUSINESS SCENARIO**](#business-scenario) \| [**SUPPORTING DOCUMENTATION**](#supporting-documentation)
1212

1313
</div>
1414
<br/>
@@ -19,7 +19,7 @@ Solution overview
1919

2020
It leverages Azure OpenAI Service and Azure AI Search, to identify relevant documents, summarize unstructured information, and generate document templates.
2121

22-
The sample data is sourced from generic AI-generated promissory notes.The documents are intended for use as sample data only.
22+
The sample data is sourced from generic AI-generated promissory notes. The documents are intended for use as sample data only.
2323

2424
### Solution architecture
2525
|![image](./docs/images/DocGen_Azure_AI_Foundry_Architecture.png)|
@@ -114,7 +114,7 @@ either by deleting the resource group in the Portal or running `azd down`.
114114

115115
<br /><br />
116116
<h2><img src="./docs/images/readme/business-scenario.png" width="48" />
117-
Business use case
117+
Business Scenario
118118
</h2>
119119

120120

@@ -136,7 +136,7 @@ Put your data to work by reducing blank page anxiety, speeding up document draft
136136
Put your data to work to create any kind of document that is supported by a large data library.
137137

138138
- **Share** <br/>
139-
Share with coauthors, contributors and approvers quickly.
139+
Share with co-authors, contributors and approvers quickly.
140140

141141
- **Contextualize information** <br/>
142142
Provide context using natural language. Primary and secondary queries allow for access to supplemental detail – reducing cognitive load, increasing efficiency, and enabling focus on higher value work.
@@ -166,7 +166,7 @@ To ensure continued best practices in your own repository, we recommend that any
166166

167167
You may want to consider additional security measures, such as:
168168

169-
* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/azure/security-center/defender-for-cloud).
169+
* Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/azure/defender-for-cloud).
170170
* Protecting the Azure Container Apps instance with a [firewall](https://learn.microsoft.com/azure/container-apps/waf-app-gateway) and/or [Virtual Network](https://learn.microsoft.com/azure/container-apps/networking?tabs=workload-profiles-env%2Cazure-cli).
171171

172172
<br/>
@@ -191,7 +191,7 @@ Have questions, find a bug, or want to request a feature? [Submit a new issue](h
191191
<br/>
192192

193193
## Responsible AI Transparency FAQ
194-
Please refer to [Transparency FAQ](./TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
194+
Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
195195

196196
<br/>
197197

@@ -215,6 +215,6 @@ You must also comply with all domestic and international export laws and regulat
215215

216216
You acknowledge that the Software and Microsoft Products and Services (1) are not designed, intended or made available as a medical device(s), and (2) are not designed or intended to be a substitute for professional medical advice, diagnosis, treatment, or judgment and should not be used to replace or as a substitute for professional medical advice, diagnosis, treatment, or judgment. Customer is solely responsible for displaying and/or obtaining appropriate consents, warnings, disclaimers, and acknowledgements to end users of Customer’s implementation of the Online Services.
217217

218-
You acknowledge the Software is not subject to SOC 1 and SOC 2 compliance audits. No Microsoft technology, nor any of its component technologies, including the Software, is intended or made available as a substitute for the professional advice, opinion, or judgement of a certified financial services professional. Do not use the Software to replace, substitute, or provide professional financial advice or judgment.
218+
You acknowledge the Software is not subject to SOC 1 and SOC 2 compliance audits. No Microsoft technology, nor any of its component technologies, including the Software, is intended or made available as a substitute for the professional advice, opinion, or judgment of a certified financial services professional. Do not use the Software to replace, substitute, or provide professional financial advice or judgment.
219219

220-
BY ACCESSING OR USING THE SOFTWARE, YOU ACKNOWLEDGE THAT THE SOFTWARE IS NOT DESIGNED OR INTENDED TO SUPPORT ANY USE IN WHICH A SERVICE INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE COULD RESULT IN THE DEATH OR SERIOUS BODILY INJURY OF ANY PERSON OR IN PHYSICAL OR ENVIRONMENTAL DAMAGE (COLLECTIVELY, “HIGH-RISK USE”), AND THAT YOU WILL ENSURE THAT, IN THE EVENT OF ANY INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE, THE SAFETY OF PEOPLE, PROPERTY, AND THE ENVIRONMENT ARE NOT REDUCED BELOW A LEVEL THAT IS REASONABLY, APPROPRIATE, AND LEGAL, WHETHER IN GENERAL OR IN A SPECIFIC INDUSTRY. BY ACCESSING THE SOFTWARE, YOU FURTHER ACKNOWLEDGE THAT YOUR HIGH-RISK USE OF THE SOFTWARE IS AT YOUR OWN RISK.
220+
BY ACCESSING OR USING THE SOFTWARE, YOU ACKNOWLEDGE THAT THE SOFTWARE IS NOT DESIGNED OR INTENDED TO SUPPORT ANY USE IN WHICH A SERVICE INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE COULD RESULT IN THE DEATH OR SERIOUS BODILY INJURY OF ANY PERSON OR IN PHYSICAL OR ENVIRONMENTAL DAMAGE (COLLECTIVELY, “HIGH-RISK USE”), AND THAT YOU WILL ENSURE THAT, IN THE EVENT OF ANY INTERRUPTION, DEFECT, ERROR, OR OTHER FAILURE OF THE SOFTWARE, THE SAFETY OF PEOPLE, PROPERTY, AND THE ENVIRONMENT ARE NOT REDUCED BELOW A LEVEL THAT IS REASONABLY, APPROPRIATE, AND LEGAL, WHETHER IN GENERAL OR IN A SPECIFIC INDUSTRY. BY ACCESSING THE SOFTWARE, YOU FURTHER ACKNOWLEDGE THAT YOUR HIGH-RISK USE OF THE SOFTWARE IS AT YOUR OWN RISK.

docs/AzureSemanticSearchRegion.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
Steps to Check Semantic Search Availability
44
1. Open the [Semantic Search Availability](https://learn.microsoft.com/en-us/azure/search/search-region-support) page.
5-
2. Scroll down to the **"Availability by Region"** section.
6-
3. Use the table to find supported regions for **Azure AI Search** and its **Semantic Search** feature.
7-
4. If your target region is not listed, choose a supported region for deployment.
5+
2. Scroll down to the **"Azure Public regions"** section.
6+
3. Use the table to find supported regions for **Azure AI Search** and its **Semantic ranker** feature.
7+
4. If your target region is not listed, choose a supported region for deployment.

docs/DeploymentGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
159159
```
160160
If you don't have azd env then you need to pass parameters along with the command. Then the command will look like the following:
161161
```shell
162-
bash ./infra/scripts/process_sample_data.sh <Storage-Account-name> <Storgae-Account-container-name> <Key-Vault-name> <CosmosDB-Account-name> <Resource-Group-name>
162+
bash ./infra/scripts/process_sample_data.sh <Storage-Account-name> <Storage-Account-container-name> <Key-Vault-name> <CosmosDB-Account-name> <Resource-Group-name>
163163
```
164164

165165
6. Open the [Azure Portal](https://portal.azure.com/), go to the deployed resource group, find the App Service and get the app URL from `Default domain`.

0 commit comments

Comments
 (0)