Merge pull request #72 from Azure-Samples/howie/env-var

Instruction for env var for local development

Author: howieleung

README.md

@@ -203,15 +203,19 @@ You can optionally use a local development server to test app changes locally. M
     python -m pip install -r requirements.txt
     ```
 
-4. Run the local server:
+4. Duplicate `src/.env.sample` and name to `.env`.
+
+5. Fill in the environamnet in `.env`.
+
+6. Run the local server:
 
     ```shell
     python -m uvicorn "api.main:create_app" --factory --reload
     ```
 
-5. Click 'http://127.0.0.1:8000' in the terminal, which should open a new tab in the browser.
+7. Click 'http://127.0.0.1:8000' in the terminal, which should open a new tab in the browser.
 
-6. Enter your message in the box.
+8. Enter your message in the box.
 </details>
 
 ### Deploying Steps

src/.env.sample

@@ -0,0 +1,15 @@
+
+# After running `azd up`, the following can be found in `.azure/<env name>/.env`
+# Azure AI Search endpoint and index name can be found in Azure Portal.  See https://learn.microsoft.com/en-us/azure/ai-services/agents/how-to/tools/azure-ai-search?tabs=azurecli%2Cpython&pivots=overview-azure-ai-search
+AZURE_AIPROJECT_CONNECTION_STRING="" # required. Example: "eastus2.api.azureml.ms;********-****-****-****-************;my_resource_group;ai-project-**********"
+AZURE_AI_AGENT_DEPLOYMENT_NAME="" # required.  Example: "gpt-4o-mini"
+AZURE_AI_AGENT_NAME="" # required if AZURE_AI_AGENT_ID not specified.  Example: "agent-template-assistant"
+AZURE_AI_EMBED_DEPLOYMENT_NAME="" # required for index search.  Example: "text-embedding-3-small"
+AZURE_AI_EMBED_DIMENSIONS=100 # required for index search.  Example: 100
+AZURE_AI_SEARCH_CONNECTION_NAME="" # required for index search. Example: "my_search_connection"
+AZURE_AI_SEARCH_ENDPOINT="" # required for index search.  Example: "https://my-search-service.search.windows.net"
+AZURE_AI_SEARCH_INDEX_NAME="" # required for index search.  Example: "index_sample"
+
+# Highly recommended.  Example: "asst_AbCdEfGhIjKlMnOpQrStUvWxYz".  If not specified, the agent name will be used to find the agent ID.  Agent ID can be found by following https://learn.microsoft.com/en-us/azure/ai-services/agents/quickstart?pivots=ai-foundry-portal
+AZURE_AI_AGENT_ID="" 
+