update chat over doc

imartinez2 · Aug 9, 2023 · d10c095 · d10c095
1 parent 0edf174
commit d10c095
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/docs/6-chat-over-file.md b/docs/6-chat-over-file.md
@@ -2,10 +2,23 @@
 
 Users can utilise this functionality to upload their PDF files through the portal and engage in chat discussions related to the content of those files.
 
-Chat with your data utilises the following two Azure Services:
+Chat with your data utilises the following Azure Services:
 
 1. [Azure Document Intelligence](https://learn.microsoft.com/en-GB/azure/ai-services/document-intelligence/) for extracting information from documents.
 1. [Azure Cognitive Search](https://learn.microsoft.com/en-GB/azure/search/) for indexing and retrieving information.
+1. [Azure OpenAI Embeddings](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/embeddings?tabs=console) for embed content extracted from files
+
+### Azure OpenAI Embeddings
+
+We use Azure OpenAI Embeddings to convert text to vectors and index it in Azure Cognitive Search.
+
+update the OpenAI environment variables with the following:
+
+```
+AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME=
+```
+
+When deploying to Azure, ensure to update the Azure App service app settings with AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME
 
 ### Setup Azure Cognitive Search index and Document Intelligence
 

diff --git a/src/.env.example b/src/.env.example
@@ -6,6 +6,7 @@ AZURE_OPENAI_API_KEY=
 AZURE_OPENAI_API_INSTANCE_NAME=
 AZURE_OPENAI_API_DEPLOYMENT_NAME=
 AZURE_OPENAI_API_VERSION=2023-03-15-preview
+AZURE_OPENAI_API_EMBEDDINGS_DEPLOYMENT_NAME=
 
 # You must have atleast one of the following auth providers configured
 AUTH_GITHUB_ID=