feat: AI Search Tool changes in Docgen

[Ragini-Microsoft]

Purpose

• ...
  This pull request introduces significant updates to the deployment workflows, infrastructure configurations, and documentation to integrate Azure AI Search services and improve deployment processes. Key changes include adding support for Azure AI Search in workflows and infrastructure, refining deployment scripts, and cleaning up unused or redundant configurations.

Workflow Enhancements

• .github/workflows/deploy.yml: Added AI_SEARCH_SERVICE_NAME to the deployment environment variables and passed it to the post-deployment script. [1] [2]
• .github/workflows/pylint.yml: Updated the Pylint configuration to exclude the tests directory.

Infrastructure Updates

• infra/deploy_ai_foundry.bicep:
  • Added resources for Azure AI Search, including identity and role assignments for integration with AI Foundry. [1] [2]
  • Updated the AI Search connection name and disabled local authentication for enhanced security. [1] [2]
• infra/deploy_app_service.bicep:
  • Introduced parameters and environment variables for Azure AI Search integration. [1] [2]
  • Removed unused parameters and variables, such as AzureSearchKey and useAiFoundrySdk. [1] [2]
  • Added role assignments for the AI Search service to grant necessary permissions.

Documentation Improvements

• docs/DeploymentGuide.md: Updated the sample data processing script to include the new aiSearchResourceName parameter.
• docs/README_LOCAL.md: Removed references to deprecated variables like AZURE_SEARCH_KEY and USE_AI_FOUNDRY_SDK. [1] [2]

Minor Refinements

• infra/main.bicep: Removed redundant blank lines for better readability. [1] [2]
• infra/deploy_app_service.bicep: Updated prompt templates to include additional constraints for Azure OpenAI.

These changes collectively enhance the system's integration with Azure AI Search, improve security, and streamline deployment processes.

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

• I have built and tested the code locally and in a deployed app
• For frontend changes, I have pulled the latest code from main, built the frontend, and committed all static files.
• This is a change for all users of this app. No code or asset is specific to my use case or my organization.

Other Information

[github-actions]

🎉 This PR is included in version 1.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀