Skip to content

Commit ab1e603

Browse files
authored
Rebranding from Cognitive Search to AI Search (#959)
* Update README.md Rebranding from Cognitive Search to AI Search * Update README.md Re-adding the existing tag
1 parent 82522fb commit ab1e603

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: ChatGPT + Enterprise data
3-
description: Chat with your data using OpenAI and Cognitive Search.
3+
description: Chat with your data using OpenAI and AI Search.
44
languages:
55
- python
66
- typescript
@@ -15,7 +15,10 @@ page_type: sample
1515
urlFragment: azure-search-openai-demo
1616
---
1717

18-
# ChatGPT + Enterprise data with Azure OpenAI and Cognitive Search
18+
# ChatGPT + Enterprise data with Azure OpenAI and AI Search
19+
20+
> [!IMPORTANT]
21+
> As of November 15, 2023, Azure Cognitive Search has been renamed to Azure AI Search.
1922
2023
## Table of Contents
2124

@@ -47,7 +50,7 @@ urlFragment: azure-search-openai-demo
4750
[![Open in GitHub Codespaces](https://img.shields.io/static/v1?style=for-the-badge&label=GitHub+Codespaces&message=Open&color=brightgreen&logo=github)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=599293758&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2)
4851
[![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/azure-search-openai-demo)
4952

50-
This sample demonstrates a few approaches for creating ChatGPT-like experiences over your own data using the Retrieval Augmented Generation pattern. It uses Azure OpenAI Service to access the ChatGPT model (gpt-35-turbo), and Azure Cognitive Search for data indexing and retrieval.
53+
This sample demonstrates a few approaches for creating ChatGPT-like experiences over your own data using the Retrieval Augmented Generation pattern. It uses Azure OpenAI Service to access the ChatGPT model (gpt-35-turbo), and Azure AI Search for data indexing and retrieval.
5154

5255
The repo includes sample data so it's ready to try end to end. In this sample application we use a fictitious company called Contoso Electronics, and the experience allows its employees to ask questions about the benefits, internal policies, as well as job descriptions and roles.
5356

@@ -57,7 +60,7 @@ The repo includes sample data so it's ready to try end to end. In this sample ap
5760

5861
* Chat and Q&A interfaces
5962
* Explores various options to help users evaluate the trustworthiness of responses with citations, tracking of source content, etc.
60-
* Shows possible approaches for data preparation, prompt construction, and orchestration of interaction between model (ChatGPT) and retriever (Cognitive Search)
63+
* Shows possible approaches for data preparation, prompt construction, and orchestration of interaction between model (ChatGPT) and retriever (AI Search)
6164
* Settings directly in the UX to tweak the behavior and experiment with options
6265
* Optional performance tracing and monitoring with Application Insights
6366

@@ -83,7 +86,7 @@ However, you can try the [Azure pricing calculator](https://azure.com/e/8ffbe5b1
8386
- Azure App Service: Basic Tier with 1 CPU core, 1.75 GB RAM. Pricing per hour. [Pricing](https://azure.microsoft.com/pricing/details/app-service/linux/)
8487
- Azure OpenAI: Standard tier, ChatGPT and Ada models. Pricing per 1K tokens used, and at least 1K tokens are used per question. [Pricing](https://azure.microsoft.com/en-us/pricing/details/cognitive-services/openai-service/)
8588
- Form Recognizer: SO (Standard) tier using pre-built layout. Pricing per document page, sample documents have 261 pages total. [Pricing](https://azure.microsoft.com/pricing/details/form-recognizer/)
86-
- Azure Cognitive Search: Standard tier, 1 replica, free level of semantic search. Pricing per hour.[Pricing](https://azure.microsoft.com/pricing/details/search/)
89+
- Azure AI Search: Standard tier, 1 replica, free level of semantic search. Pricing per hour.[Pricing](https://azure.microsoft.com/pricing/details/search/)
8790
- Azure Blob Storage: Standard tier with ZRS (Zone-redundant storage). Pricing per storage and read operations. [Pricing](https://azure.microsoft.com/pricing/details/storage/blobs/)
8891
- Azure Monitor: Pay-as-you-go tier. Costs based on data ingested. [Pricing](https://azure.microsoft.com/pricing/details/monitor/)
8992

@@ -140,7 +143,7 @@ Then bring down the project code:
140143
Execute the following command, if you don't have any pre-existing Azure services and want to start from a fresh deployment.
141144

142145
1. Run `azd up` - This will provision Azure resources and deploy this sample to those resources, including building the search index based on the files found in the `./data` folder.
143-
* **Important**: Beware that the resources created by this command will incur immediate costs, primarily from the Cognitive Search resource. These resources may accrue costs even if you interrupt the command before it is fully executed. You can run `azd down` or delete the resources manually to avoid unnecessary spending.
146+
* **Important**: Beware that the resources created by this command will incur immediate costs, primarily from the AI Search resource. These resources may accrue costs even if you interrupt the command before it is fully executed. You can run `azd down` or delete the resources manually to avoid unnecessary spending.
144147
* You will be prompted to select two locations, one for the majority of resources and one for the OpenAI resource, which is currently a short list. That location list is based on the [OpenAI model availability table](https://learn.microsoft.com/azure/cognitive-services/openai/concepts/models#model-summary-table-and-region-availability) and may become outdated as availability changes.
145148
1. After the application has been successfully deployed you will see a URL printed to the console. Click that URL to interact with the application in your browser.
146149
It will look like the following:
@@ -183,9 +186,9 @@ Do *not* check your key into source control.
183186
When you run `azd up` after and are prompted to select a value for `openAiResourceGroupLocation`, you can select any location as it will not be used.
184187

185188

186-
#### Existing Azure Cognitive Search resource
189+
#### Existing Azure AI Search resource
187190

188-
1. Run `azd env set AZURE_SEARCH_SERVICE {Name of existing Azure Cognitive Search service}`
191+
1. Run `azd env set AZURE_SEARCH_SERVICE {Name of existing Azure AI Search service}`
189192
1. Run `azd env set AZURE_SEARCH_SERVICE_RESOURCE_GROUP {Name of existing resource group with ACS service}`
190193
1. If that resource group is in a different location than the one you'll pick for the `azd up` step,
191194
then run `azd env set AZURE_SEARCH_SERVICE_LOCATION {Location of existing service}`
@@ -301,8 +304,8 @@ to production. Read through our [productionizing guide](docs/productionizing.md)
301304

302305
## Resources
303306

304-
* [Revolutionize your Enterprise Data with ChatGPT: Next-gen Apps w/ Azure OpenAI and Cognitive Search](https://aka.ms/entgptsearchblog)
305-
* [Azure Cognitive Search](https://learn.microsoft.com/azure/search/search-what-is-azure-search)
307+
* [Revolutionize your Enterprise Data with ChatGPT: Next-gen Apps w/ Azure OpenAI and AI Search](https://aka.ms/entgptsearchblog)
308+
* [Azure AI Search](https://learn.microsoft.com/azure/search/search-what-is-azure-search)
306309
* [Azure OpenAI Service](https://learn.microsoft.com/azure/cognitive-services/openai/overview)
307310
* [Comparing Azure OpenAI and OpenAI](https://learn.microsoft.com/azure/cognitive-services/openai/overview#comparing-azure-openai-and-openai/)
308311

@@ -350,7 +353,7 @@ Technology comparison:
350353
| --- | --- | --- |
351354
| Frontend | React | React |
352355
| Backend | Python (Quart) | Python (Flask) |
353-
| Vector DB | Azure Cognitive Search | Azure Cognitive Search |
356+
| Vector DB | Azure AI Search | Azure AI Search |
354357
| Deployment | Azure Developer CLI (azd) | Azure Portal, az, azd |
355358

356359
</details>
@@ -368,7 +371,7 @@ The `azd up` command comes from the [Azure Developer CLI](https://learn.microsof
368371

369372
The `azd up` command uses the `azure.yaml` file combined with the infrastructure-as-code `.bicep` files in the `infra/` folder. The `azure.yaml` file for this project declares several "hooks" for the prepackage step and postprovision steps. The `up` command first runs the `prepackage` hook which installs Node dependencies and builds the React.JS-based JavaScript files. It then packages all the code (both frontend and backend) into a zip file which it will deploy later.
370373

371-
Next, it provisions the resources based on `main.bicep` and `main.parameters.json`. At that point, since there is no default value for the OpenAI resource location, it asks you to pick a location from a short list of available regions. Then it will send requests to Azure to provision all the required resources. With everything provisioned, it runs the `postprovision` hook to process the local data and add it to an Azure Cognitive Search index.
374+
Next, it provisions the resources based on `main.bicep` and `main.parameters.json`. At that point, since there is no default value for the OpenAI resource location, it asks you to pick a location from a short list of available regions. Then it will send requests to Azure to provision all the required resources. With everything provisioned, it runs the `postprovision` hook to process the local data and add it to an Azure AI Search index.
372375

373376
Finally, it looks at `azure.yaml` to determine the Azure host (appservice, in this case) and uploads the zip to Azure App Service. The `azd up` command is now complete, but it may take another 5-10 minutes for the App Service app to be fully available and working, especially for the initial deploy.
374377

0 commit comments

Comments
 (0)