Merge branch 'main' into develop

Azure-Samples · Dec 4, 2023 · 33b49e8 · 33b49e8
2 parents e6b27f6 + c788464
commit 33b49e8
Show file tree

Hide file tree

Showing 13 changed files with 18 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -91,7 +91,7 @@ You may try the [Azure pricing calculator](https://azure.com/e/8ffbe5b1919c4c72a
 - Azure Static Web Apps: Free Tier. [Pricing](https://azure.microsoft.com/pricing/details/app-service/static/)
 - 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/pricing/details/search/)
 <!-- - 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/) -->
-- Azure AI Search: Standard tier, 1 replica, free level of semantic search*. Pricing per hour.[Pricing](https://azure.microsoft.com/pricing/details/search/) (_The pricing may vary or reflect an outdated tier model. Please visit the linked page for more accurate information_)
+- Azure AI Search: Standard tier, 1 replica, free level of semantic search\*. Pricing per hour.[Pricing](https://azure.microsoft.com/pricing/details/search/) (_The pricing may vary or reflect an outdated tier model. Please visit the linked page for more accurate information_)
 - 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/)
 - Azure Monitor: Pay-as-you-go tier. Costs based on data ingested. [Pricing](https://azure.microsoft.com/pricing/details/monitor/)
 
@@ -319,7 +319,7 @@ For more details, read [Azure OpenAI Landing Zone reference architecture](https:
 ## Resources
 
 - [Revolutionize your Enterprise Data with ChatGPT: Next-gen Apps w/ Azure OpenAI and AI Search](https://aka.ms/entgptsearchblog)
-- [Azure Cognitive Search](https://learn.microsoft.com/azure/search/search-what-is-azure-search)
+- [Azure AI Search](https://learn.microsoft.com/azure/search/search-what-is-azure-search)
 - [Azure OpenAI Service](https://learn.microsoft.com/azure/cognitive-services/openai/overview)
 - [Building ChatGPT-Like Experiences with Azure: A Guide to Retrieval Augmented Generation for JavaScript applications](https://devblogs.microsoft.com/azure-sdk/building-chatgpt-like-experiences-with-azure-a-guide-to-retrieval-augmented-generation-for-javascript-applications/)
 

diff --git a/docs/app-architecture.drawio.png b/docs/app-architecture.drawio.png
diff --git a/infra/main.bicep b/infra/main.bicep
@@ -78,6 +78,9 @@ param useApplicationInsights bool = false
 
 param allowedOrigin string
 
+// Allow to override the default backend
+param backendUri string = ''
+
 // Only needed for CD due to internal policies restrictions
 param aliasTag string = ''
 // Differentiates between automated and manual deployments
@@ -536,3 +539,4 @@ output SEARCH_API_URI string = searchApi.outputs.uri
 output INDEXER_API_URI string = indexerApi.outputs.uri
 
 output ALLOWED_ORIGINS string = join(allowedOrigins, ',')
+output BACKEND_URI string = !empty(backendUri) ? backendUri : searchApi.outputs.uri
diff --git a/infra/main.parameters.json b/infra/main.parameters.json
@@ -77,6 +77,9 @@
     "allowedOrigin": {
       "value": "${ALLOWED_ORIGIN=''}"
     },
+    "backendUri": {
+      "value": "${BACKEND_URI}"
+    },
     "aliasTag": {
       "value": "${AZURE_ALIAS}"
     },

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "azure-search-openai-javascript",
   "version": "1.0.0",
-  "description": "ChatGPT + Enterprise data with Azure OpenAI and Cognitive Search",
+  "description": "ChatGPT + Enterprise data with Azure OpenAI and AI Search",
   "private": true,
   "directories": {
     "doc": "docs"

diff --git a/packages/indexer/.env.example b/packages/indexer/.env.example
@@ -5,7 +5,7 @@ AZURE_OPENAI_EMBEDDING_DEPLOYMENT=
 AZURE_OPENAI_EMBEDDING_MODEL=
 AZURE_OPENAI_SERVICE=
 
-# Azure Cognitive Search
+# Azure AI Search
 AZURE_SEARCH_INDEX=
 AZURE_SEARCH_SERVICE=
 

diff --git a/packages/indexer/src/plugins/azure.ts b/packages/indexer/src/plugins/azure.ts
@@ -13,7 +13,7 @@ export default fp(
   async (fastify, _options) => {
     const config = fastify.config;
 
-    // Use the current user identity to authenticate with Azure OpenAI, Cognitive Search and Blob Storage
+    // Use the current user identity to authenticate with Azure OpenAI, AI Search and Blob Storage
     // (no secrets needed, just use 'az login' locally, and managed identity when deployed on Azure).
     // If you need to use keys, use separate AzureKeyCredential instances with the keys for each service
     const credential = new DefaultAzureCredential();

diff --git a/packages/search/.env.example b/packages/search/.env.example
@@ -5,7 +5,7 @@ AZURE_OPENAI_EMBEDDING_DEPLOYMENT=
 AZURE_OPENAI_EMBEDDING_MODEL=
 AZURE_OPENAI_SERVICE=
 
-# Azure Cognitive Search
+# Azure AI Search
 AZURE_SEARCH_INDEX=
 AZURE_SEARCH_SERVICE=
 

diff --git a/packages/search/src/lib/approaches/ask-retrieve-then-read.ts b/packages/search/src/lib/approaches/ask-retrieve-then-read.ts
@@ -30,7 +30,7 @@ info3.pdf: Once you've provided the necessary information, submit the report. Ou
 const ANSWER = `If a guest breaks something, report the damage immediately through the platform [info1.txt]. Once you've provided the necessary information, submit the report. Our financial support team will investigate the matter and work to resolve it promptly [info3.pdf].`;
 
 /**
- * Simple retrieve-then-read implementation, using the Cognitive Search and OpenAI APIs directly.
+ * Simple retrieve-then-read implementation, using the AI Search and OpenAI APIs directly.
  * It first retrieves top documents from search, then constructs a prompt with them, and then uses
  * OpenAI to generate an completion (answer) with that prompt.
  */

diff --git a/packages/search/src/lib/approaches/chat-read-retrieve-read.ts b/packages/search/src/lib/approaches/chat-read-retrieve-read.ts
@@ -45,7 +45,7 @@ const QUERY_PROMPT_FEW_SHOTS: Message[] = [
 ];
 
 /**
- * Simple retrieve-then-read implementation, using the Cognitive Search and OpenAI APIs directly.
+ * Simple retrieve-then-read implementation, using the AI Search and OpenAI APIs directly.
  * It first retrieves top documents from search, then constructs a prompt with them, and then uses
  * OpenAI to generate an completion (answer) with that prompt.
  */

diff --git a/packages/search/src/plugins/azure.ts b/packages/search/src/plugins/azure.ts
@@ -13,7 +13,7 @@ export default fp(
   async (fastify, _options) => {
     const config = fastify.config;
 
-    // Use the current user identity to authenticate with Azure OpenAI, Cognitive Search and Blob Storage
+    // Use the current user identity to authenticate with Azure OpenAI, AI Search and Blob Storage
     // (no secrets needed, just use 'az login' locally, and managed identity when deployed on Azure).
     // If you need to use keys, use separate AzureKeyCredential instances with the keys for each service
     const credential = new DefaultAzureCredential();

diff --git a/packages/webapp/src/pages/layout/Layout.tsx b/packages/webapp/src/pages/layout/Layout.tsx
@@ -49,7 +49,7 @@ const Layout = () => {
               </li>
             </ul>
           </nav>
-          <h4 className={styles.headerRightText}>Azure OpenAI + Cognitive Search</h4>
+          <h4 className={styles.headerRightText}>Azure OpenAI + AI Search</h4>
         </div>
       </header>
 

diff --git a/packages/webapp/vite.config.ts b/packages/webapp/vite.config.ts
@@ -3,7 +3,7 @@ import { defineConfig } from 'vite';
 import react from '@vitejs/plugin-react';
 
 // Expose environment variables to the client
-process.env.VITE_SEARCH_API_URI = process.env.SEARCH_API_URI ?? '';
+process.env.VITE_SEARCH_API_URI = process.env.BACKEND_URI ?? '';
 console.log(`Using search API base URL: "${process.env.VITE_SEARCH_API_URI}"`);
 
 // https://vitejs.dev/config/