Replace os.getenv with os.environ so that we can get an Environment Variable not found error when an environment variable isn't set

singhnitant · singhnitant · commit e09e00ac2940 · 2024-06-20T15:46:24.000-07:00
diff --git a/src/copilot_flow/copilot.py b/src/copilot_flow/copilot.py
@@ -21,9 +21,9 @@ class ChatResponse(TypedDict):
 @trace
 def get_chat_response(chat_input: str, chat_history: list = []) -> ChatResponse:
     model_config = AzureOpenAIModelConfiguration(
-        azure_deployment=os.getenv("AZURE_OPENAI_CHAT_DEPLOYMENT"),
-        api_version=os.getenv("AZURE_OPENAI_API_VERSION"),
-        azure_endpoint=os.getenv("AZURE_OPENAI_ENDPOINT")
+        azure_deployment=os.environ["AZURE_OPENAI_CHAT_DEPLOYMENT"],
+        api_version=os.environ["AZURE_OPENAI_API_VERSION"],
+        azure_endpoint=os.environ["AZURE_OPENAI_ENDPOINT"]
     )
 
     searchQuery = chat_input
@@ -64,23 +64,26 @@ def get_chat_response(chat_input: str, chat_history: list = []) -> ChatResponse:
 @trace
 def get_documents(search_query: str, num_docs=3):
 
-    index_name = os.getenv("AZUREAI_SEARCH_INDEX_NAME")
+    index_name = os.environ["AZUREAI_SEARCH_INDEX_NAME"]
 
     #  retrieve documents relevant to the user's question from Cognitive Search
     search_client = SearchClient(
-        endpoint=os.getenv("AZURE_SEARCH_ENDPOINT"),
+        endpoint=os.environ["AZURE_SEARCH_ENDPOINT"],
         credential=DefaultAzureCredential(),
-        index_name=index_name)
+        index_name=index_name
+        )
 
     aoai_client = AzureOpenAI(
-        azure_endpoint=os.getenv("AZURE_OPENAI_ENDPOINT"),
+        azure_endpoint=os.environ["AZURE_OPENAI_ENDPOINT"],
         azure_ad_token_provider=get_bearer_token_provider(DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"),
-        api_version=os.getenv("AZURE_OPENAI_API_VERSION")
+        api_version=os.environ["AZURE_OPENAI_API_VERSION"]
     )
 
     # generate a vector embedding of the user's question
-    embedding = aoai_client.embeddings.create(input=search_query,
-                                            model=os.getenv("AZURE_OPENAI_EMBEDDING_DEPLOYMENT"))
+    embedding = aoai_client.embeddings.create(
+        input=search_query,
+        model=os.environ["AZURE_OPENAI_EMBEDDING_DEPLOYMENT"]
+        )
     embedding_to_query = embedding.data[0].embedding
 
     context = ""
diff --git a/src/deployment/deploy.py b/src/deployment/deploy.py
@@ -68,13 +68,13 @@ def deploy_flow(endpoint_name, deployment_name):
             "PRT_CONFIG_OVERRIDE": f"deployment.subscription_id={client.subscription_id},deployment.resource_group={client.resource_group_name},deployment.workspace_name={client.workspace_name},deployment.endpoint_name={endpoint_name},deployment.deployment_name={deployment_name}",
             # the following is enabled by secret injection
             # make sure your environment variables here match the environment variables your code depends on
-            'AZURE_OPENAI_ENDPOINT': os.getenv('AZURE_OPENAI_ENDPOINT'),
-            'AZURE_SEARCH_ENDPOINT':  os.getenv('AZURE_SEARCH_ENDPOINT'),
-            'AZURE_OPENAI_API_VERSION': os.getenv('AZURE_OPENAI_API_VERSION'),
-            'AZURE_OPENAI_CHAT_DEPLOYMENT': os.getenv('AZURE_OPENAI_CHAT_DEPLOYMENT'),
-            'AZURE_OPENAI_EVALUATION_DEPLOYMENT': os.getenv('AZURE_OPENAI_EVALUATION_DEPLOYMENT'),
-            'AZURE_OPENAI_EMBEDDING_DEPLOYMENT': os.getenv('AZURE_OPENAI_EMBEDDING_DEPLOYMENT'),
-            'AZUREAI_SEARCH_INDEX_NAME': os.getenv('AZUREAI_SEARCH_INDEX_NAME')
+            'AZURE_OPENAI_ENDPOINT': os.environ['AZURE_OPENAI_ENDPOINT'],
+            'AZURE_SEARCH_ENDPOINT':  os.environ['AZURE_SEARCH_ENDPOINT'],
+            'AZURE_OPENAI_API_VERSION': os.environ['AZURE_OPENAI_API_VERSION'],
+            'AZURE_OPENAI_CHAT_DEPLOYMENT': os.environ['AZURE_OPENAI_CHAT_DEPLOYMENT'],
+            'AZURE_OPENAI_EVALUATION_DEPLOYMENT': os.environ['AZURE_OPENAI_EVALUATION_DEPLOYMENT'],
+            'AZURE_OPENAI_EMBEDDING_DEPLOYMENT': os.environ['AZURE_OPENAI_EMBEDDING_DEPLOYMENT'],
+            'AZUREAI_SEARCH_INDEX_NAME': os.environ['AZUREAI_SEARCH_INDEX_NAME']
         }
     )
 
@@ -90,20 +90,23 @@ def deploy_flow(endpoint_name, deployment_name):
 
     # 4. provide endpoint access to Azure Open AI resource
     create_role_assignment(
-        scope=f"/subscriptions/{os.getenv("AZURE_SUBSCRIPTION_ID")}/resourceGroups/{os.getenv("AZURE_RESOURCE_GROUP")}/providers/Microsoft.CognitiveServices/accounts/{os.getenv("AZURE_OPENAI_CONNECTION_NAME")}",
+        scope=f"/subscriptions/{os.environ["AZURE_SUBSCRIPTION_ID"]}/resourceGroups/{os.environ["AZURE_RESOURCE_GROUP"]}/providers/Microsoft.CognitiveServices/accounts/{os.environ["AZURE_OPENAI_CONNECTION_NAME"]}",
         role_name="Cognitive Services OpenAI User",
-        principal_id=endpoint.identity.principal_id)
+        principal_id=endpoint.identity.principal_id
+        )
 
     # 5. provide endpoint access to Azure AI Search resource
     create_role_assignment(
-        scope=f"/subscriptions/{os.getenv("AZURE_SUBSCRIPTION_ID")}/resourceGroups/{os.getenv("AZURE_RESOURCE_GROUP")}/providers/Microsoft.Search/searchServices/{os.getenv("AZURE_SEARCH_CONNECTION_NAME")}",
+        scope=f"/subscriptions/{os.environ["AZURE_SUBSCRIPTION_ID"]}/resourceGroups/{os.environ["AZURE_RESOURCE_GROUP"]}/providers/Microsoft.Search/searchServices/{os.environ["AZURE_SEARCH_CONNECTION_NAME"]}",
         role_name="Search Index Data Contributor",
-        principal_id=endpoint.identity.principal_id)
+        principal_id=endpoint.identity.principal_id
+        )
     
     output_deployment_details(
         client=client,
         endpoint_name=endpoint_name,
-        deployment_name=deployment_name)
+        deployment_name=deployment_name
+        )
 
 def create_role_assignment(scope, role_name, principal_id):
     
@@ -113,7 +116,8 @@ def create_role_assignment(scope, role_name, principal_id):
     # Instantiate the authorization management client
     auth_client = AuthorizationManagementClient(
         credential=credential,
-        subscription_id=os.getenv("AZURE_SUBSCRIPTION_ID"))
+        subscription_id=os.environ["AZURE_SUBSCRIPTION_ID"]
+        )
     
     roles = list(auth_client.role_definitions.list(
         scope,
@@ -126,13 +130,15 @@ def create_role_assignment(scope, role_name, principal_id):
     parameters = RoleAssignmentCreateParameters(
         role_definition_id=role.id,
         principal_id=principal_id,
-        principal_type="ServicePrincipal")
+        principal_type="ServicePrincipal"
+        )
     
     # Create role assignment
     role_assignment = auth_client.role_assignments.create(
         scope=scope,
         role_assignment_name=uuid.uuid4(),
-        parameters=parameters)
+        parameters=parameters
+        )
     
     return role_assignment
 
diff --git a/src/evaluation/evaluate.py b/src/evaluation/evaluate.py
@@ -34,9 +34,9 @@ def copilot_qna(*, chat_input, **kwargs):
 def run_evaluation(eval_name, dataset_path):
 
     model_config = AzureOpenAIModelConfiguration(
-        azure_deployment=os.getenv("AZURE_OPENAI_EVALUATION_DEPLOYMENT"),
-        api_version=os.getenv("AZURE_OPENAI_API_VERSION"),
-        azure_endpoint=os.getenv("AZURE_OPENAI_ENDPOINT")
+        azure_deployment=os.environ["AZURE_OPENAI_EVALUATION_DEPLOYMENT"],
+        api_version=os.environ["AZURE_OPENAI_API_VERSION"],
+        azure_endpoint=os.environ["AZURE_OPENAI_ENDPOINT"]
     )
 
     # Initializing Evaluators
diff --git a/src/evaluation/evaluate_completeness.py b/src/evaluation/evaluate_completeness.py
@@ -38,10 +38,10 @@ def copilot_qna(*, chat_input, **kwargs):
 def run_evaluation(name, dataset_path, prompty_filename: str):
 
     model_config = AzureOpenAIModelConfiguration(
-        azure_endpoint=os.getenv("AZURE_OPENAI_ENDPOINT"),
-        api_version=os.getenv("AZURE_OPENAI_API_VERSION"),
-        azure_deployment=os.getenv("AZURE_OPENAI_EVALUATION_DEPLOYMENT"),
-    )
+        azure_endpoint=os.environ["AZURE_OPENAI_ENDPOINT"],
+        api_version=os.environ["AZURE_OPENAI_API_VERSION"],
+        azure_deployment=os.environ["AZURE_OPENAI_EVALUATION_DEPLOYMENT"]
+        )
 
     # Initializing Evaluators
     # relevance_eval = RelevanceEvaluator(model_config)
diff --git a/src/helper_functions.py b/src/helper_functions.py
@@ -8,7 +8,7 @@
 
 def get_client() -> MLClient:
   # check if env variables are set and initialize client from those
-  client = MLClient(DefaultAzureCredential(), os.getenv("AZURE_SUBSCRIPTION_ID"), os.getenv("AZURE_RESOURCE_GROUP"), os.getenv("AZUREAI_PROJECT_NAME"))
+  client = MLClient(DefaultAzureCredential(), os.environ["AZURE_SUBSCRIPTION_ID"], os.environ["AZURE_RESOURCE_GROUP"], os.environ["AZUREAI_PROJECT_NAME"])
   if client:
     return client
   
diff --git a/src/indexing/build_index.py b/src/indexing/build_index.py
@@ -20,13 +20,13 @@ def build_aisearch_index(index_name, path_to_data):
       name=index_name,  # name of your index
     vector_store="azure_ai_search",  # the type of vector store - in this case it is Azure AI Search. Users can also use "azure_cognitive search"
     embeddings_model_config=EmbeddingsModelConfig(
-      model_name=os.getenv('AZURE_OPENAI_EMBEDDING_DEPLOYMENT'),
-      deployment_name=os.getenv('AZURE_OPENAI_EMBEDDING_DEPLOYMENT'),
+      model_name=os.environ['AZURE_OPENAI_EMBEDDING_DEPLOYMENT'],
+      deployment_name=os.environ['AZURE_OPENAI_EMBEDDING_DEPLOYMENT'],
       connection_config=ConnectionConfig(
         subscription_id=client.subscription_id,
         resource_group_name=client.resource_group_name,
         workspace_name=client.workspace_name,
-        connection_name=os.getenv('AZURE_OPENAI_CONNECTION_NAME')
+        connection_name=os.environ['AZURE_OPENAI_CONNECTION_NAME']
       )
     ),
     input_source=LocalSource(input_data=path_to_data),  # the location of your files/folders
diff --git a/src/provisioning/check_quota.py b/src/provisioning/check_quota.py
@@ -124,7 +124,7 @@ def main():
         "--subscription-id",
         help="Azure subscription id",
         type=str,
-        default=os.getenv("AZURE_SUBSCRIPTION_ID"),
+        default=os.environ["AZURE_SUBSCRIPTION_ID"]
     )
     args = parser.parse_args()
 

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ def main():`
`124`	`124`	`"--subscription-id",`
`125`	`125`	`help="Azure subscription id",`
`126`	`126`	`type=str,`
`127`		`- default=os.getenv("AZURE_SUBSCRIPTION_ID"),`
	`127`	`+ default=os.environ["AZURE_SUBSCRIPTION_ID"]`
`128`	`128`	`)`
`129`	`129`	`args = parser.parse_args()`
`130`	`130`