Skip to content

Python: Azure OpenAI setting fix: Don't fetch AD token if API is present in environment variable. - #8985

Merged
Evan Mattson (moonbox3) merged 4 commits into
microsoft:mainfrom
lossyrob:fix/python-azure-openai-api-key-setting
Sep 25, 2024
Merged

Python: Azure OpenAI setting fix: Don't fetch AD token if API is present in environment variable.#8985
Evan Mattson (moonbox3) merged 4 commits into
microsoft:mainfrom
lossyrob:fix/python-azure-openai-api-key-setting

Conversation

@lossyrob

@lossyrob Rob Emanuele (lossyrob) commented Sep 25, 2024

Copy link
Copy Markdown
Contributor

Motivation and Context

While working on #8951 I found that interacting with an Azure OpenAI instance I had an API key for, but my identity didn't have IAM access to the API for, that I was getting a permission error:

semantic_kernel.exceptions.service_exceptions.ServiceResponseException: ("<class 'semantic_kernel.connectors.ai.open_ai.services.azure_text_embedding.AzureTextEmbedding'> service failed to generate embeddings", AuthenticationError("Error code: 401 - {'error': {'code': 'PermissionDenied', 'message': 'Principal does not have access to API/Operation.'}}"))

I found that this was because, though my API key was set in the environment, the codepath only recognized an explicitly passed in API key when deciding whether to issue an AD token while initializing an AzureTextEmbedding instance.

This PR fixes that by looking at the setting object explicitly, which may pull the API key from the environment.

Contribution Checklist

@lossyrob
Rob Emanuele (lossyrob) requested a review from a team as a code owner September 25, 2024 14:24
@markwallace-microsoft Mark Wallace (markwallace-microsoft) added the python Pull requests for the Python Semantic Kernel label Sep 25, 2024
@markwallace-microsoft

Mark Wallace (markwallace-microsoft) commented Sep 25, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Python Test Coverage

Python Test Coverage Report
FileStmtsMissCoverMissing
semantic_kernel
   kernel.py1994776%148, 159, 163, 313–316, 423, 437–480
semantic_kernel/agents/channels
   open_ai_assistant_channel.py49198%42
semantic_kernel/agents/group_chat
   agent_chat.py116199%91
   agent_group_chat.py67297%113, 135
   broadcast_queue.py72199%35
semantic_kernel/agents/open_ai
   assistant_content_generation.py68297%81–82
   open_ai_assistant_base.py358399%243, 321–322
semantic_kernel/connectors/ai
   chat_completion_client_base.py116298%382, 392
   completion_usage.py8188%17
semantic_kernel/connectors/ai/anthropic/services
   anthropic_chat_completion.py124398%120, 137, 173
semantic_kernel/connectors/ai/azure_ai_inference/services
   azure_ai_inference_chat_completion.py119794%120, 146–149, 159, 180, 202
   azure_ai_inference_text_embedding.py41198%87
semantic_kernel/connectors/ai/embeddings
   embedding_generator_base.py8188%50
semantic_kernel/connectors/ai/google
   shared_utils.py26196%56
semantic_kernel/connectors/ai/google/google_ai/services
   google_ai_chat_completion.py119497%127, 153, 176, 178
   google_ai_text_completion.py63297%98, 121
   utils.py65395%140, 160–165
semantic_kernel/connectors/ai/google/vertex_ai/services
   utils.py66395%141, 161–166
   vertex_ai_chat_completion.py119497%121, 147, 170, 172
   vertex_ai_text_completion.py62297%95, 116
semantic_kernel/connectors/ai/hugging_face/services
   hf_text_completion.py60395%103, 112, 127
   hf_text_embedding.py32584%79–83
semantic_kernel/connectors/ai/mistral_ai/services
   mistral_ai_chat_completion.py118794%118–121, 307–310
semantic_kernel/connectors/ai/ollama/services
   ollama_chat_completion.py60592%95–98, 108, 143
   ollama_text_completion.py55591%87–90, 100, 128
semantic_kernel/connectors/ai/open_ai/services
   azure_chat_completion.py84298%106, 111
   azure_text_completion.py28293%82, 87
   azure_text_embedding.py30293%84, 89
   open_ai_chat_completion_base.py122398%71, 123, 266
   open_ai_text_completion_base.py80298%56, 161
semantic_kernel/connectors/ai/open_ai/settings
   azure_open_ai_settings.py22482%97–100
semantic_kernel/connectors/memory/azure_ai_search
   azure_ai_search_collection.py87298%150, 152
semantic_kernel/connectors/memory/redis
   redis_collection.py160299%146, 316
   utils.py451176%145–146, 164, 166, 173–188
semantic_kernel/connectors/openapi_plugin
   openapi_manager.py58297%110–111
   openapi_parser.py88298%71, 128
   openapi_runner.py105298%181–182
semantic_kernel/connectors/openapi_plugin/models
   rest_api_operation.py129199%242
semantic_kernel/contents
   function_call_content.py97199%201
semantic_kernel/core_plugins/sessions_python_tool
   sessions_python_plugin.py134894%69, 82–91, 99
   sessions_python_settings.py39490%84–87
semantic_kernel/data
   vector_store_record_collection.py2491992%410, 470–474, 482–486, 526–529, 536–539
   vector_store_record_utils.py26292%50, 52
semantic_kernel/functions
   kernel_function_decorator.py98199%102
   kernel_function_from_method.py96199%153
   kernel_function_from_prompt.py154795%165–166, 180, 201, 219, 239, 322
   kernel_function_log_messages.py36683%37–43
   kernel_plugin.py187299%472, 475
semantic_kernel/planners
   plan.py2344581%54, 163–165, 197, 214–227, 264, 269, 277–278, 288–291, 308, 313, 329, 332–337, 355, 360, 363, 365, 372, 386–388, 393–397
semantic_kernel/planners/function_calling_stepwise_planner
   function_calling_stepwise_planner.py116497%145, 189–190, 198
semantic_kernel/planners/sequential_planner
   sequential_planner.py64691%71, 75, 109, 125, 134–135
   sequential_planner_extensions.py50982%31–32, 56, 110–124
   sequential_planner_parser.py771284%66–74, 93, 117–120
semantic_kernel/schema
   kernel_json_schema_builder.py119596%50, 84, 206, 210–211
semantic_kernel/services
   ai_service_client_base.py22195%64
semantic_kernel/template_engine/blocks
   code_block.py77199%119
   named_arg_block.py43198%98
semantic_kernel/utils/authentication
   entra_id_authentication.py15940%25–38
semantic_kernel/utils/telemetry
   user_agent.py16288%18–19
semantic_kernel/utils/telemetry/model_diagnostics
   decorators.py169498%370–373
TOTAL1097130397% 

Python Unit Test Overview

Tests Skipped Failures Errors Time
2444 4 💤 0 ❌ 0 🔥 54.887s ⏱️

@lossyrob
Rob Emanuele (lossyrob) force-pushed the fix/python-azure-openai-api-key-setting branch 2 times, most recently from ae334d4 to 002ab11 Compare September 25, 2024 14:57
moonbox3
Evan Mattson (moonbox3) approved these changes Sep 25, 2024
View reviewed changes

@moonbox3 Evan Mattson (moonbox3) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. We could add one unit test for azure_text_completion, but it isn't a blocker. Thanks for the fixes!

@moonbox3
Evan Mattson (moonbox3) added this pull request to the merge queue Sep 25, 2024
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Sep 25, 2024
@lossyrob
Rob Emanuele (lossyrob) force-pushed the fix/python-azure-openai-api-key-setting branch from 0347673 to 1ee8f3a Compare September 25, 2024 15:52
@moonbox3
Evan Mattson (moonbox3) added this pull request to the merge queue Sep 25, 2024
Merged via the queue into microsoft:main with commit 771ac2c Sep 25, 2024
@lossyrob
Rob Emanuele (lossyrob) deleted the fix/python-azure-openai-api-key-setting branch September 25, 2024 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TaoChenOSU Tao Chen (TaoChenOSU) TaoChenOSU approved these changes
@alliscode Ben Thomas (alliscode) alliscode approved these changes
@moonbox3 Evan Mattson (moonbox3) moonbox3 approved these changes

Assignees

No one assigned

Labels

python Pull requests for the Python Semantic Kernel

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@lossyrob @markwallace-microsoft @TaoChenOSU @alliscode @moonbox3