Skip to content

Conversation

NirajC-Microsoft
Copy link
Contributor

@NirajC-Microsoft NirajC-Microsoft commented Sep 4, 2025

Purpose

This pull request introduces improvements to deployment documentation, troubleshooting guidance, and SQL prompt instructions. The most significant changes are the addition of a comprehensive troubleshooting guide for Azure deployment errors, updates to deployment documentation to reference this guide, and refinements to SQL query generation logic for asset value questions. Additionally, resource group tagging now includes the deployer's username for better traceability.

Documentation and Troubleshooting Enhancements:

  • Added a new docs/TroubleShootingSteps.md file detailing common Azure deployment errors, their causes, and step-by-step solutions, including links to further resources and support channels.
  • Updated docs/DeploymentGuide.md to reference the troubleshooting guide, making it easier for users to find help during deployment issues.

SQL Prompt Logic Updates:

  • Refined SQL prompt instructions in both infra/main.bicep and src/App/backend/agents/agent_factory.py to clarify how asset value queries should be handled: sum latest investments for total value questions, and return latest investments without summing for current value questions. [1] [2]

Resource Tagging Improvement:

  • Updated resource group tagging in infra/main.bicep to include a CreatedBy tag with the deployer's username, improving auditability and resource ownership tracking.
  • ...

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid

  • ...

Other Information

Priyanka-Microsoft and others added 30 commits July 25, 2025 13:41
…tingpr

fix: model deployment when reusing existing foundry
* fixed opent telemetry issue CustomDomainInUse, FlagMustBeSetForRestore (#618) (#619)

Co-authored-by: VishalS-Microsoft <v-vishshinde@microsoft.com>

* directory update in dependabot template (#634)

---------

Co-authored-by: NirajC-Microsoft <v-nirajcha@microsoft.com>
Co-authored-by: VishalS-Microsoft <v-vishshinde@microsoft.com>
Co-authored-by: Prajwal-Microsoft <v-dcprajwal@microsoft.com>
* Agent deletion handled successfully

* use get azure credentials

* remove unused import

---------

Co-authored-by: Shreyas-Microsoft <v-swaikar@microsft.com>
feat: Add required environment variables for local debugging in .env generated by azd up
fix: Sample data processing script fails when using cross-subscription existing AI project resource ID
chore: Down merge from main to dev
VishalS-Microsoft and others added 8 commits August 26, 2025 12:39
* Added Troubleshoot.md files for BYOC-Client Advisor

* fixed Check Markdown Broken Links

* updated troubleshotingsteps file

* Changed MACAE Github issues link with BYOC issue link

---------

Co-authored-by: NirajC-Microsoft <v-nirajcha@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…teps.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…entifier for better formatting and readability.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…y, and the total value matches the asset value displayed in the left panel. (#651)
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances deployment documentation and troubleshooting capabilities while refining SQL query generation logic. The main purpose is to improve the deployment experience by providing comprehensive troubleshooting guidance and clarifying asset value query handling.

  • Added comprehensive troubleshooting documentation with detailed error resolution steps
  • Enhanced SQL prompt instructions to clarify asset value query logic
  • Improved resource tagging with deployer information for better auditability

Reviewed Changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 3 comments.

File Description
docs/TroubleShootingSteps.md New comprehensive troubleshooting guide with 25+ common Azure deployment errors and solutions
docs/DeploymentGuide.md Added reference to troubleshooting guide for deployment issues
src/App/backend/agents/agent_factory.py Updated SQL prompt to clarify asset value query logic (sum vs individual values)
infra/main.bicep Enhanced SQL prompt instructions and added CreatedBy tag with deployer username

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@microsoft microsoft deleted a comment from Copilot AI Sep 4, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…to prevent validation pipeline failures caused by the deployer function in the Bicep file. (#659)

* Adding a hardcoded createdBy parameter to the CAdeploy.yml file to prevent validation pipeline failures caused by the deployer function in the Bicep file.

* Consolidate parameters in CAdeploy.yml
@Roopan-Microsoft Roopan-Microsoft merged commit 6b95b13 into main Sep 5, 2025
15 checks passed
Copy link

github-actions bot commented Sep 8, 2025

🎉 This PR is included in version 1.8.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Roopan-Microsoft added a commit that referenced this pull request Sep 17, 2025
* chore: Dev to Main changes merge (#657)

* model deployment when reusing existing foundry

* change model deployment name

* removed system managed identity code

* seggregated the files

* fix: Updated file names

* chore: down merging main into dev (#638)

* fixed opent telemetry issue CustomDomainInUse, FlagMustBeSetForRestore (#618) (#619)

Co-authored-by: VishalS-Microsoft <v-vishshinde@microsoft.com>

* directory update in dependabot template (#634)

---------

Co-authored-by: NirajC-Microsoft <v-nirajcha@microsoft.com>
Co-authored-by: VishalS-Microsoft <v-vishshinde@microsoft.com>
Co-authored-by: Prajwal-Microsoft <v-dcprajwal@microsoft.com>

* added for cross-subscription existing AI project resource ID

* update

* fix: agent cleanup (#639)

* Agent deletion handled successfully

* use get azure credentials

* remove unused import

---------

Co-authored-by: Shreyas-Microsoft <v-swaikar@microsft.com>

* TS( 21657) Bicep Standard code changes

* Added required env variables for local debugging in .env generated by azd up

* Added "Required/Optional" and changed aiProjectName suffix.

* removed location tag

* foundry project documentation

* corrected name

* updated CAdeploy.yml

* update CAdeploy.yml

* changed pipeline variable

* updated main.json file

* updated yml file

* test

* test

* update

* update

* test

* update CAdeploy.yml

* CustomizingAzdparamMd

* deploymentMdUpdate

* Updated

* Update infra/main.bicep

Fixed typo error.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/App/backend/plugins/chat_with_data_plugin.py

Updated the finally block for function "get_SQL_Response"

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update infra/main.bicep

Removed Commented-out code

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Revert Copilot suggestion: `and project_client` is unnecessary.
`project_client` is always initialized before thread creation, so `if thread:` is sufficient.

* docs: Added Troubleshoot.md files for BYOC-Client Advisor (#650)

* Added Troubleshoot.md files for BYOC-Client Advisor

* fixed Check Markdown Broken Links

* updated troubleshotingsteps file

* Changed MACAE Github issues link with BYOC issue link

---------

Co-authored-by: NirajC-Microsoft <v-nirajcha@microsoft.com>

* added colon

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Replace 'u' with 'you' for proper grammarUpdate docs/TroubleShootingSteps.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* extra space removed

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* The command block is not properly closed

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* The command should be wrapped in a proper code block with language identifier for better formatting and readability.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* The total asset value and current asset value are responding correctly, and the total value matches the asset value  displayed in the left panel. (#651)

* Bicep file changes to add CreatedBy tag (#655)

* Update docs/TroubleShootingSteps.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: Adding a hardcoded createdBy parameter to the CAdeploy.yml file to prevent validation pipeline failures caused by the deployer function in the Bicep file. (#659)

* Adding a hardcoded createdBy parameter to the CAdeploy.yml file to prevent validation pipeline failures caused by the deployer function in the Bicep file.

* Consolidate parameters in CAdeploy.yml

---------

Co-authored-by: Priyanka-Microsoft <v-prisinghal@microsoft.com>
Co-authored-by: Prajwal D C <v-dcprajwal@microsoft.com>
Co-authored-by: Rafi-Microsoft <v-rafmd@microsoft.com>
Co-authored-by: VishalS-Microsoft <v-vishshinde@microsoft.com>
Co-authored-by: Kanchan Nagshetti (Persistent Systems Inc) <v-knagshetti@microsoft.com>
Co-authored-by: Shreyas-Microsoft <v-swaikar@microsoft.com>
Co-authored-by: Shreyas-Microsoft <v-swaikar@microsft.com>
Co-authored-by: Bangarraju-Microsoft <v-golib@microsoft.com>
Co-authored-by: Prasanjeet-Microsoft <v-singhprasa@microsoft.com>
Co-authored-by: UtkarshMishra-Microsoft <v-utkamishra@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Roopan P M <v-roopanpm@microsoft.com>
Co-authored-by: Prekshith-Microsoft <v-pdj@microsoft.com>
Co-authored-by: Roopan-Microsoft <168007406+Roopan-Microsoft@users.noreply.github.com>

* fix: merging dev to main changes (#661)

* model deployment when reusing existing foundry

* change model deployment name

* removed system managed identity code

* seggregated the files

* fix: Updated file names

* chore: down merging main into dev (#638)

* fixed opent telemetry issue CustomDomainInUse, FlagMustBeSetForRestore (#618) (#619)

Co-authored-by: VishalS-Microsoft <v-vishshinde@microsoft.com>

* directory update in dependabot template (#634)

---------

Co-authored-by: NirajC-Microsoft <v-nirajcha@microsoft.com>
Co-authored-by: VishalS-Microsoft <v-vishshinde@microsoft.com>
Co-authored-by: Prajwal-Microsoft <v-dcprajwal@microsoft.com>

* added for cross-subscription existing AI project resource ID

* update

* fix: agent cleanup (#639)

* Agent deletion handled successfully

* use get azure credentials

* remove unused import

---------

Co-authored-by: Shreyas-Microsoft <v-swaikar@microsft.com>

* TS( 21657) Bicep Standard code changes

* Added required env variables for local debugging in .env generated by azd up

* Added "Required/Optional" and changed aiProjectName suffix.

* removed location tag

* foundry project documentation

* corrected name

* updated CAdeploy.yml

* update CAdeploy.yml

* changed pipeline variable

* updated main.json file

* updated yml file

* test

* test

* update

* update

* test

* update CAdeploy.yml

* CustomizingAzdparamMd

* deploymentMdUpdate

* Updated

* Update infra/main.bicep

Fixed typo error.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/App/backend/plugins/chat_with_data_plugin.py

Updated the finally block for function "get_SQL_Response"

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update infra/main.bicep

Removed Commented-out code

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Revert Copilot suggestion: `and project_client` is unnecessary.
`project_client` is always initialized before thread creation, so `if thread:` is sufficient.

* docs: Added Troubleshoot.md files for BYOC-Client Advisor (#650)

* Added Troubleshoot.md files for BYOC-Client Advisor

* fixed Check Markdown Broken Links

* updated troubleshotingsteps file

* Changed MACAE Github issues link with BYOC issue link

---------

Co-authored-by: NirajC-Microsoft <v-nirajcha@microsoft.com>

* added colon

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Replace 'u' with 'you' for proper grammarUpdate docs/TroubleShootingSteps.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* extra space removed

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* The command block is not properly closed

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* The command should be wrapped in a proper code block with language identifier for better formatting and readability.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* The total asset value and current asset value are responding correctly, and the total value matches the asset value  displayed in the left panel. (#651)

* Bicep file changes to add CreatedBy tag (#655)

* Update docs/TroubleShootingSteps.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: Adding a hardcoded createdBy parameter to the CAdeploy.yml file to prevent validation pipeline failures caused by the deployer function in the Bicep file. (#659)

* Adding a hardcoded createdBy parameter to the CAdeploy.yml file to prevent validation pipeline failures caused by the deployer function in the Bicep file.

* Consolidate parameters in CAdeploy.yml

---------

Co-authored-by: Priyanka-Microsoft <v-prisinghal@microsoft.com>
Co-authored-by: Prajwal D C <v-dcprajwal@microsoft.com>
Co-authored-by: Rafi-Microsoft <v-rafmd@microsoft.com>
Co-authored-by: NirajC-Microsoft <v-nirajcha@microsoft.com>
Co-authored-by: VishalS-Microsoft <v-vishshinde@microsoft.com>
Co-authored-by: Kanchan Nagshetti (Persistent Systems Inc) <v-knagshetti@microsoft.com>
Co-authored-by: Shreyas-Microsoft <v-swaikar@microsoft.com>
Co-authored-by: Shreyas-Microsoft <v-swaikar@microsft.com>
Co-authored-by: Bangarraju-Microsoft <v-golib@microsoft.com>
Co-authored-by: Prasanjeet-Microsoft <v-singhprasa@microsoft.com>
Co-authored-by: UtkarshMishra-Microsoft <v-utkamishra@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Prekshith-Microsoft <v-pdj@microsoft.com>

* fixed vulnerabilities

* removed duplicate variable

---------

Co-authored-by: NirajC-Microsoft <v-nirajcha@microsoft.com>
Co-authored-by: Priyanka-Microsoft <v-prisinghal@microsoft.com>
Co-authored-by: Prajwal D C <v-dcprajwal@microsoft.com>
Co-authored-by: Rafi-Microsoft <v-rafmd@microsoft.com>
Co-authored-by: VishalS-Microsoft <v-vishshinde@microsoft.com>
Co-authored-by: Shreyas-Microsoft <v-swaikar@microsoft.com>
Co-authored-by: Shreyas-Microsoft <v-swaikar@microsft.com>
Co-authored-by: Bangarraju-Microsoft <v-golib@microsoft.com>
Co-authored-by: Prasanjeet-Microsoft <v-singhprasa@microsoft.com>
Co-authored-by: UtkarshMishra-Microsoft <v-utkamishra@microsoft.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Roopan P M <v-roopanpm@microsoft.com>
Co-authored-by: Prekshith-Microsoft <v-pdj@microsoft.com>
Co-authored-by: Roopan-Microsoft <168007406+Roopan-Microsoft@users.noreply.github.com>
Copy link

🎉 This PR is included in version 1.9.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.