Skip to content
This repository was archived by the owner on Jul 28, 2025. It is now read-only.

Commit 3ac6db2

Browse files
authored
Merge pull request #122 from gmndrg/main
Rebranding to Azure AI Search
2 parents fb7e2e4 + aaa4ee0 commit 3ac6db2

13 files changed

Lines changed: 64 additions & 60 deletions

File tree

00 - Resource Deployment/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ There are two options for deploying the resources to Azure for this solution acc
1515

1616
- You must run PowerShell script with Administrator rights.
1717

18-
- You must read, understand and agree to *Responsible AI (RAI)* and *Face Legal Terms*. One of the Azure resources that is created when deploying this script is a [Cognitive Services multi-service account](https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account). You must acknowledge that you have read, understood and agree to the Responsible AI (RAI) and Face Legal Terms so the script can run successfully. Otherwise, the script execution will be cancelled.
18+
- You must read, understand and agree to *Responsible AI (RAI)* and *Face Legal Terms*. One of the Azure resources that is created when deploying this script is a [AI Services multi-service account](https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account). You must acknowledge that you have read, understood and agree to the Responsible AI (RAI) and Face Legal Terms so the script can run successfully. Otherwise, the script execution will be cancelled.
1919

20-
- Your Azure account must have a Cognitive Services Contributor role assigned in order for you to agree to the responsible AI terms and create a resource. To get this role assigned to your account, follow the steps in the Assign roles documentation, or contact your administrator.
20+
- Your Azure account must have a AI Services Contributor role assigned in order for you to agree to the responsible AI terms and create a resource. To get this role assigned to your account, follow the steps in the Assign roles documentation, or contact your administrator.
2121

22-
Below are the RAI and Face Legal Terms. For more recent Terms that may be added after this sample is published, review Cognitive Services Terms of Use documentation.
22+
Below are the RAI and Face Legal Terms. For more recent Terms that may be added after this sample is published, review AI Services Terms of Use documentation.
2323

2424
**Responsible AI Notice**
2525

26-
Microsoft provides technical documentation regarding the appropriate operation applicable to this Cognitive Service that is made available by Microsoft. Customer acknowledges and agrees that they have reviewed this documentation and will use this service in accordance with it. This Cognitive Services is intended to process Customer Data that includes Biometric Data (as may be further described in product documentation) that Customer may incorporate into its own systems used for personal identification or other purposes. Customer acknowledges and agrees that it is responsible for complying with the Biometric Data obligations contained in the Online Services DPA.
26+
Microsoft provides technical documentation regarding the appropriate operation applicable to this AI Service that is made available by Microsoft. Customer acknowledges and agrees that they have reviewed this documentation and will use this service in accordance with it. This AI Services is intended to process Customer Data that includes Biometric Data (as may be further described in product documentation) that Customer may incorporate into its own systems used for personal identification or other purposes. Customer acknowledges and agrees that it is responsible for complying with the Biometric Data obligations contained in the Online Services DPA.
2727

2828
[Online Services DPA](https://aka.ms/DPA)
2929

@@ -83,7 +83,7 @@ The PowerShell script will provision the following resources to your Azure subsc
8383
| Resource | Usage |
8484
|-----------------------|-------------------------------------------------------------------------------------------|
8585
| [Azure Search Service](https://azure.microsoft.com/en-us/services/search/) | The hosting service for the Search Index, Cognitive Skillset, and Search Indexer |
86-
| [Azure Cognitive Services](https://docs.microsoft.com/en-us/azure/search/cognitive-search-attach-cognitive-services) | Used by the Cognitive Skills pipeline to process unstructured data |
86+
| [Azure AI Services](https://docs.microsoft.com/en-us/azure/search/cognitive-search-attach-cognitive-services) | Used by the Cognitive Skills pipeline to process unstructured data |
8787
|[Azure Storage Account](https://azure.microsoft.com/en-us/services/storage/?v=18.24) | Data source where raw files are stored |
8888
| [Web App](https://azure.microsoft.com/en-us/services/app-service/web/) | The hosting service for the Search UI |
8989
| [Application Insights](https://azure.microsoft.com/en-us/services/monitor/) | Telemetry monitoring service for the Search UI (*Optional*) |

01 - Search Index Creation/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Search Index Creation
22

3-
There are several different ways to create a search index for Azure Cognitive Search. You can choose how to deploy an index based on your skillset, your preferred tools, or your desired level of automation.
3+
There are several different ways to create a search index for Azure AI Search. You can choose how to deploy an index based on your skillset, your preferred tools, or your desired level of automation.
44

55
>**Note:** If you ran the `deploy.ps1` script in the previous step, you've already created your search index so you can skip to the next step.
66
@@ -23,4 +23,4 @@ This folder includes three options for creating an index. Each of these approach
2323
2. [Create a search index using PowerShell](./Create-Index-PowerShell.md)
2424
3. [Create a search index using Postman](./Create-Index-Postman.md)
2525

26-
4. Optionally - go thru Sentiment Analysis setup example in [01.1 - BuiltIn Skills](./01.1%20-%20BuiltIn%20Skills/)
26+
4. Optionally - go thru Sentiment Analysis setup example in [01.1 - BuiltIn Skills](./01.1%20-%20BuiltIn%20Skills/)

02 - Web UI Template/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cognitive Search UI Template
1+
# AI Search UI Template
22
This folder contains a basic web front end that can be used to quickly create a view of your search results. With just a few simple steps, you can configure this template UI to query your newly created search index. **CognitiveSearch.UI** is a .NET Core MVC Web app used as a Template UI for querying a search index. This is the focus of this README.
33

44
In just a few steps, you can configure this template UI to query your search index. This template will render a web page similar to the following:
@@ -43,10 +43,10 @@ KeyField=metadata_storage_path
4343
IsPathBase64Encoded=true
4444
```
4545

46-
- **SearchServiceName** - The name of your Azure Cognitive Search service
47-
- **SearchApiKey** - The API Key for your Azure Cognitive Search service
48-
- **SearchIndexName** - The name of your Azure Cognitive Search index
49-
- **SearchIndexerName** - The name of your Azure Cognitive Search indexer
46+
- **SearchServiceName** - The name of your Azure AI Search service
47+
- **SearchApiKey** - The API Key for your Azure AI Search service
48+
- **SearchIndexName** - The name of your Azure AI Search index
49+
- **SearchIndexerName** - The name of your Azure AI Search indexer
5050
- **StorageAccountName** - The name of your Azure Blob Storage Account
5151
- **StorageAccountKey** - The key for your Azure Blob Storage Account
5252
- **StorageContainerAddress** - The URL to the storage container where your - documents are stored. This should be in the following format: *https://- *storageaccountname*.blob.core.windows.net/*containername**
@@ -110,10 +110,10 @@ This file contains a mix of required and optional fields described below.
110110
"IsPathBase64Encoded": true,
111111
```
112112

113-
1. **SearchServiceName** - The name of your Azure Cognitive Search service
114-
2. **SearchApiKey** - The API Key for your Azure Cognitive Search service
115-
3. **SearchIndexName** - The name of your Azure Cognitive Search index
116-
4. **SearchIndexerName** - The name of your Azure Cognitive Search indexer
113+
1. **SearchServiceName** - The name of your Azure AI Search service
114+
2. **SearchApiKey** - The API Key for your Azure AI Search service
115+
3. **SearchIndexName** - The name of your Azure AI Search index
116+
4. **SearchIndexerName** - The name of your Azure AI Search indexer
117117
5. **StorageAccountName** - The name of your Azure Blob Storage Account
118118
6. **StorageAccountKey** - The key for your Azure Blob Storage Account
119119
7. **StorageContainerAddress** - The URL to the storage container where your documents are stored. This should be in the following format: *https://*storageaccountname*.blob.core.windows.net/*containername**
@@ -174,7 +174,7 @@ If you would like to further customize the UI, you can update the following fiel
174174

175175
## 3. Add additional customization
176176

177-
This template serves as a great baseline for a Cognitive Search solution, however, you may want to make additional updates depending on your use case.
177+
This template serves as a great baseline for a AI Search solution, however, you may want to make additional updates depending on your use case.
178178

179179
We have a special behavior if you have a field called *translated_text*. The UI will automatically show the original text and the translated text in the UI. This can be handy. If you would like to change this behavior (disable it, or change the name of the field), you can do that at details.js (GetTranscriptHTML method).
180180

@@ -188,4 +188,4 @@ Much of the UI is rendered dynamically by javascript. Some important files to kn
188188

189189
2. **wwroot/js/details.js** - contains the code for rending the detail view once a result is selected
190190

191-
3. **Search/DocumentSearchClient.cs** - contains the code for talking with Azure Cognitive Search's APIs. Setting breakpoints in this file is a great way to debug.
191+
3. **Search/DocumentSearchClient.cs** - contains the code for talking with Azure AI Search's APIs. Setting breakpoints in this file is a great way to debug.

03 - Data Science and Custom Skills/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Data Science & Custom Skills
2-
Cognitive Search allows you to extend the out of the box functionality with custom skills. This extensibility enables a broad range of features such as creating custom filters, classifying documents, extracting custom entities, and more.
2+
AI Search allows you to extend the out of the box functionality with custom skills. This extensibility enables a broad range of features such as creating custom filters, classifying documents, extracting custom entities, and more.
33

44
This folder contains some example templates you can leverage to build your own custom skills and some useful Python notebooks you can use if you are building ML models.
55

6-
Cognitive Search is agnostic to the tool(s) you use to build your custom skills, which are deployed as restful APIs. The only requirements for building your custom skill(s) are:
6+
AI Search is agnostic to the tool(s) you use to build your custom skills, which are deployed as restful APIs. The only requirements for building your custom skill(s) are:
77

88
1. Have a secure, HTTPS, end-point.
99
2. Follow the defined input/output schema shown [here](https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-interface).
@@ -20,7 +20,7 @@ In general, there are two types of custom skills that are most commonly used:
2020
Deploying an Azure Function is the quickest and easiest way to create a custom skill. This repo used to have it's own Azure Function templates but now links out to the [PowerSkills repo](https://github.com/Azure-Samples/azure-search-power-skills) that includes an array of custom skill options and fully automates the deployment process. Azure Functions are the recommended approach for deploying skills that do not require an ML model.
2121

2222
### 2.0 Azure Machine Learning Custom Skills
23-
ML models can be used to enhance the Cognitive Search pipeline. In this template, Azure Machine Learning is used to build and deploy the model. The AML Custom Skill Template provides the files needed to quickly deploy a model to be used as a custom skill.
23+
ML models can be used to enhance the AI Search pipeline. In this template, Azure Machine Learning is used to build and deploy the model. The AML Custom Skill Template provides the files needed to quickly deploy a model to be used as a custom skill.
2424

2525
> This template does not currently use the [AML Custom skill format](https://docs.microsoft.com/azure/search/cognitive-search-aml-skill) that's available in public preview but rather is designed to be deployed as a conventional [Web API skill](https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-web-api). There's a separate tutorial that walks through the process of [creating an AML skill](https://docs.microsoft.com/azure/search/cognitive-search-tutorial-aml-custom-skill) based off of that functionality.
2626

04 - Reporting/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Reporting
22

3-
A PowerBI Template file has been created so you can quickly spin up reports based on the Cognitive Search Template UI. To create the reports, simply open **Cognitive Search.pbit** using PowerBI Desktop.
3+
A PowerBI Template file has been created so you can quickly spin up reports based on the AI Search Template UI. To create the reports, simply open **Cognitive Search.pbit** using PowerBI Desktop.
44

55
## Prerequisites
66

@@ -38,9 +38,9 @@ If you do not see any details in Power BI (even after hitting the Refresh button
3838
## Additional Materials
3939
For more information on PowerBI and developing reports on PowerBI see [What is Power BI](https://docs.microsoft.com/en-us/power-bi/power-bi-overview).
4040

41-
Alternatively, you can use the new Power BI report that is automatically included with Azure Cognitive Search. In order to access it, goto the Search instance in your subscription, navigate to `Search traffic analytics`, and select `Download Power BI report`.
41+
Alternatively, you can use the new Power BI report that is automatically included with Azure AI Search. In order to access it, goto the Search instance in your subscription, navigate to `Search traffic analytics`, and select `Download Power BI report`.
4242

4343
Both reports have comparable capabilties and can be used to develop more sophisticated dashboards.
4444

4545
## Special Thanks
46-
Special thanks to Emilio D'Angelo for creating this PBI template.
46+
Special thanks to Emilio D'Angelo for creating this PBI template.

0 commit comments

Comments
 (0)