Skip to content
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ azd up
- The repo-provided `azd`, Bicep, Terraform, and Azure CLI deployers are **container-based** App Service deployments.
- For those container deployments, do **not** set an App Service Stack Settings Startup command.
- The container already starts Gunicorn through `application/single_app/Dockerfile`.
- If your environment needs private or self-signed certificate authorities for outbound TLS checks to internal services, add them during image build using [docs/how-to/docker_customization.md](docs/how-to/docker_customization.md).
- If your environment needs private or self-signed certificate authorities for outbound TLS checks to internal services, add them during image build using [docs/guides/docker-customization.md](docs/guides/docker-customization.md).

### Native Python
- For **native Python App Service** deployments, deploy the `application/single_app` folder and set the App Service Startup command explicitly.
Expand Down Expand Up @@ -236,11 +236,11 @@ python -m gunicorn -c gunicorn.conf.py app:app

## Upgrade Paths

- For a concise upgrade decision guide, see [docs/how-to/upgrade_paths.md](docs/how-to/upgrade_paths.md).
- For a concise upgrade decision guide, see [docs/guides/upgrade-paths.md](docs/guides/upgrade-paths.md).

### Container
- **Container-based upgrades** should usually start with `azd deploy` for code-only changes. Use `azd up` only when the release also changes infrastructure.
- If your App Service is already configured to pull from ACR and you want image-only rollouts, use the ACR/image refresh approach described in [docs/how-to/upgrade_paths.md](docs/how-to/upgrade_paths.md) instead of treating every release as a full reprovisioning event.
- If your App Service is already configured to pull from ACR and you want image-only rollouts, use the ACR/image refresh approach described in [docs/guides/upgrade-paths.md](docs/guides/upgrade-paths.md) instead of treating every release as a full reprovisioning event.

### Native Python
- **Native Python App Service upgrades** should reuse the manual deployment path, validate the Startup command above, and deploy the `application/single_app` folder with VS Code or Azure CLI ZIP deploy.
Expand Down
2 changes: 1 addition & 1 deletion application/single_app/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
EXECUTOR_TYPE = 'thread'
EXECUTOR_MAX_WORKERS = 30
SESSION_TYPE = 'filesystem'
VERSION = "0.261.002"
VERSION = "0.261.003"
IS_DEVELOPMENT = is_development_env_enabled()

SESSION_COOKIE_SAMESITE = os.getenv('SESSION_COOKIE_SAMESITE', 'Lax')
Expand Down
2 changes: 1 addition & 1 deletion deployers/azurecli/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Simple Chat - Deployment using Azure CLI + PowerShell

[Return to Main](../README.md)
[Return to Main](../../README.md)

## Overview

Expand Down
2 changes: 1 addition & 1 deletion deployers/azurecli/deploy-simplechat.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ For Azure Government, use the corresponding sovereign-cloud private DNS zones su

For detailed private networking guidance, see:
- `deployers/bicep/README.md`
- `docs/how-to/enterprise_networking.md`
- `docs/guides/enterprise-networking.md`

============================================
Manual changes post-deployment.
Expand Down
2 changes: 1 addition & 1 deletion deployers/bicep/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ A: Base infrastructure (without optional services) costs approximately:
### Upgrading

**Q: How do I upgrade to a new version?**
A: For **code-only** container updates, prefer `azd deploy`. Use `azd provision --preview` and then `azd up` only when the release also changes infrastructure. See [../../docs/how-to/upgrade_paths.md](../../docs/how-to/upgrade_paths.md) for the upgrade decision guide.
A: For **code-only** container updates, prefer `azd deploy`. Use `azd provision --preview` and then `azd up` only when the release also changes infrastructure. See [../../docs/guides/upgrade-paths.md](../../docs/guides/upgrade-paths.md) for the upgrade decision guide.

---

Expand Down
6 changes: 3 additions & 3 deletions deployers/terraform/ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Simple Chat - Deployment using Terraform

[Return to Main](../README.md)
[Return to Main](../../README.md)

## Login to Azure CLI

Expand Down Expand Up @@ -49,7 +49,7 @@ If you plan to reuse enterprise-managed networking, make sure these prerequisite
For detailed networking guidance, see:

- [../bicep/README.md](../bicep/README.md)
- [../../docs/how-to/enterprise_networking.md](../../docs/how-to/enterprise_networking.md)
- [../../docs/guides/enterprise-networking.md](../../docs/guides/enterprise-networking.md)

## Configure Terraform Secrets

Expand Down Expand Up @@ -93,7 +93,7 @@ If you use `az acr build`, run it from the repository root so the Docker build c

- For **code-only** container updates, publish a new image to ACR and follow the existing App Service container rollout process instead of rerunning Terraform for every release.
- Use Terraform when you are intentionally changing infrastructure or configuration that belongs in Terraform state.
- See [../../docs/how-to/upgrade_paths.md](../../docs/how-to/upgrade_paths.md) for the native-vs-container upgrade guide and the ACR/image-only rollout notes.
- See [../../docs/guides/upgrade-paths.md](../../docs/guides/upgrade-paths.md) for the native-vs-container upgrade guide and the ACR/image-only rollout notes.

## Terraform deployment

Expand Down
2 changes: 1 addition & 1 deletion deployers/version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.25
1.0.26
30 changes: 18 additions & 12 deletions docs/admin/knowledge.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,13 @@ These settings decide what evidence enters the system and how it becomes searcha

### Web Search {#web-search-section}

The Web Search section belongs to the Web & Research tab. Use it with the adjacent settings in this group so related rollout, access, and operational choices stay aligned.
Web Search lets chat ground a single message in current public web results. SimpleChat does not call a search API directly. It calls an Azure AI Foundry agent that you create and configure, and that agent uses the Grounding with Bing Search tool to run the query and return results with citations.

Two things gate the capability, and both are required. `enable_web_search` turns it on, and `web_search_consent_accepted` records that an administrator acknowledged that Grounding with Bing Search moves data outside the Azure compliance boundary and operates under separate terms. Enabling the toggle without accepting the consent leaves the feature off.

Only the user's current chat message is sent to the agent. Conversation history, workspace documents, attached file contents, and system prompts are never included in the outbound query. Decide your rollout policy on that basis, and use the notice settings below if you want users reminded of it in the composer.

An agent ID is not optional. If it is missing, chat tells the user web search is unavailable rather than silently answering from training data, so a half-finished configuration fails loudly instead of quietly degrading.

### URL Access {#url-access-section}

Expand All @@ -51,19 +57,19 @@ The Deep Research section belongs to the Web & Research tab. Use it with the adj

| Setting | What it does | Default | Notes |
| --- | --- | --- | --- |
| Enable Web Search via Foundry Agent | Adds web search through the configured Azure AI Foundry agent for approved chat flows. | Off | `enable_web_search`; capability toggle |
| Show data notice to users when web search is used | Exposes the capability after required services, permissions, and rollout policy are ready. | Off | `enable_web_search_user_notice`; capability toggle |
| Notice Text | This message will be shown to users once per session when they first use web search. | N/A (runtime control) | `web_search_user_notice_text` |
| Enable Web Search via Foundry Agent | Adds web search through the configured Azure AI Foundry agent for approved chat flows. Requires accepted consent to take effect. | Off | `enable_web_search`; capability toggle |
| Show data notice to users when web search is used | Shows a dismissible banner above the chat composer while web search is active, so users know the message will leave the tenant. | Off | `enable_web_search_user_notice`; capability toggle |
| Notice Text | The banner wording. Shown once per browser session, from the first time the user activates web search until they dismiss it. | N/A (runtime control) | `web_search_user_notice_text` |
| Foundry Project Endpoint | Project endpoint format: https://<foundry-resource>.services.ai.azure.com/api/projects/<project-name> (not the inference endpoint). | N/A (runtime control) | `web_search_foundry_endpoint` |
| Foundry API Version | Pins the service API version SimpleChat sends with requests for this feature. | N/A (runtime control) | `web_search_foundry_api_version` |
| Foundry Agent ID | Narrows the admin list shown for foundry agent id. | N/A (runtime control) | `web_search_foundry_agent_id` |
| Authentication Type | Identity must have Cognitive Services User and AI Developer roles on the Foundry project. | N/A (runtime control) | `web_search_foundry_auth_type` |
| Cloud | Narrows the admin list shown for cloud. | N/A (runtime control) | `web_search_foundry_cloud` |
| Managed Identity Type | Narrows the admin list shown for managed identity type. | N/A (runtime control) | `web_search_foundry_managed_identity_type` |
| Authority Endpoint (Custom Cloud) | Narrows the admin list shown for authority endpoint (custom cloud). | N/A (runtime control) | `web_search_foundry_authority` |
| Managed Identity Client ID (UAMI) | Narrows the admin list shown for managed identity client id (uami). | N/A (runtime control) | `web_search_foundry_managed_identity_client_id` |
| Tenant ID | Narrows the admin list shown for tenant id. | N/A (runtime control) | `web_search_foundry_tenant_id` |
| Client ID | Narrows the admin list shown for client id. | N/A (runtime control) | `web_search_foundry_client_id` |
| Foundry Agent ID | Identifies the agent that carries the Grounding with Bing Search tool. Without it, chat reports web search as unavailable. | N/A (runtime control) | `web_search_foundry_agent_id` |
| Authentication Type | Selects how SimpleChat authenticates to the Foundry project. The identity must have Cognitive Services User and AI Developer roles on that project. | N/A (runtime control) | `web_search_foundry_auth_type` |
| Cloud | Selects the Azure cloud whose endpoints and authority are used to reach the Foundry project. | N/A (runtime control) | `web_search_foundry_cloud` |
| Managed Identity Type | Chooses between the system-assigned identity and a user-assigned identity when authenticating with a managed identity. | N/A (runtime control) | `web_search_foundry_managed_identity_type` |
| Authority Endpoint (Custom Cloud) | Overrides the login authority when the selected cloud is a custom or sovereign environment. | N/A (runtime control) | `web_search_foundry_authority` |
| Managed Identity Client ID (UAMI) | Identifies which user-assigned managed identity to authenticate with. | N/A (runtime control) | `web_search_foundry_managed_identity_client_id` |
| Tenant ID | Directory the service principal authenticates against. | N/A (runtime control) | `web_search_foundry_tenant_id` |
| Client ID | Application ID of the service principal used for authentication. | N/A (runtime control) | `web_search_foundry_client_id` |
| Client Secret | Provides the secret credential used when the selected authentication mode requires one. | N/A (runtime control) | `web_search_foundry_client_secret` |
| Enable URL Access for chat and workflows | Allows chat and workflows to inspect user-provided URLs within the configured URL limits and domain policy. | Off | `enable_url_access`; capability toggle |
| Require UrlAccessUser App Role | Required app role value: UrlAccessUser. Assign this role to users or groups in the Enterprise App before enabling the requirement. When enabled, only assigned users can use URL Access in chat or enable it for workflows. | Off | `require_member_of_url_access_user` |
Expand Down
6 changes: 3 additions & 3 deletions docs/explanation/features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ category: Version History

## Tutorial Features

- [Guided Tutorials](GUIDED_TUTORIALS.md)
- [User Tutorial Visibility Preference](USER_TUTORIAL_VISIBILITY_PREFERENCE.md)
- [Guided Tutorials](v0.241.001/GUIDED_TUTORIALS.md)
- [User Tutorial Visibility Preference](v0.241.001/USER_TUTORIAL_VISIBILITY_PREFERENCE.md)

## Admin Experience Features

- [Azure OpenAI Identity Setup Guide](v0.250.001/AZURE_OPENAI_IDENTITY_SETUP_GUIDE.md)
- [AI Voice Conversations Setup Guide](AI_VOICE_CONVERSATIONS_SETUP_GUIDE.md)
- [AI Voice Conversations Setup Guide](v0.241.006/AI_VOICE_CONVERSATIONS_SETUP_GUIDE.md)
- [Activity Log Auto-Refresh](CONTROL_CENTER_ACTIVITY_LOG_AUTO_REFRESH.md)
- [Activity Log Layout Presets](ACTIVITY_LOG_LAYOUT_PRESETS.md)
- [Content Safety Violation Messages](CONTENT_SAFETY_VIOLATION_MESSAGES.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -270,8 +270,8 @@ The timer framework can be extended to support:

## Related Documentation

- [Admin Configuration Guide](../admin_configuration.md)
- [Application Workflows](../application_workflows.md)
- [Admin Configuration Guide](../../../admin_configuration.md)
- Application Workflows
- [Fix Documentation](../fixes/)
- [Functional Tests](../../functional_tests/)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -492,9 +492,9 @@ No dedicated functional test file created yet. Recommended test file:
10. **Approval Comments**: Threaded comments/discussion on approval requests

## Related Documentation
- [Control Center Overview](../admin_configuration.md)
- [Notification System](../features/NOTIFICATION_SYSTEM.md) (if exists)
- [Group Management](../features/GROUP_MANAGEMENT.md) (if exists)
- [Control Center Overview](../../../admin_configuration.md)
- Notification System
- Group Management

## Support & Troubleshooting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,9 @@ The test validates:

## Related Documentation

- [Document Creation Activity Logging](./DOCUMENT_CREATION_ACTIVITY_LOGGING.md)
- [Document Deletion Activity Logging](./DOCUMENT_DELETION_ACTIVITY_LOGGING.md)
- [Activity Logging Architecture](./ACTIVITY_LOGGING_ARCHITECTURE.md)
- Document Creation Activity Logging
- Document Deletion Activity Logging
- Activity Logging Architecture

## Performance Considerations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,8 +255,8 @@ If the Azure OpenAI API doesn't return token usage (older API versions or differ

## Related Documentation

- [Tabular Data CSV Storage Fix](../fixes/TABULAR_DATA_CSV_STORAGE_FIX.md)
- [Agent Model Display Fixes](../fixes/AGENT_MODEL_DISPLAY_FIXES.md)
- [Tabular Data CSV Storage Fix](../../fixes/v0.229.001/TABULAR_DATA_CSV_STORAGE_FIX.md)
- [Agent Model Display Fixes](../../fixes/v0.229.001/AGENT_MODEL_DISPLAY_FIXES.md)
- Main codebase: `application/single_app/`

## Implementation Notes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -315,9 +315,9 @@ The test validates:

## Related Documentation

- [Group Status Change Activity Logging](./GROUP_STATUS_CHANGE_ACTIVITY_LOGGING.md)
- [Document Creation Activity Logging](./DOCUMENT_CREATION_ACTIVITY_LOGGING.md)
- [Activity Logging Architecture](./ACTIVITY_LOGGING_ARCHITECTURE.md)
- Group Status Change Activity Logging
- Document Creation Activity Logging
- Activity Logging Architecture

## Performance Considerations

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -582,4 +582,4 @@ This prevents all modifications while maintaining full read access.

**Related Documentation:**
- [Group Status UI Visibility](GROUP_STATUS_UI_VISIBILITY.md) - Dynamic UI hiding feature
- [Activity Logging](../explanation/activity_logging.md)
- Activity Logging
Original file line number Diff line number Diff line change
Expand Up @@ -288,9 +288,9 @@ No configuration changes required. The feature is enabled by default for all new

## Related Documentation

- [Message Management Architecture](./MESSAGE_MANAGEMENT_ARCHITECTURE.md)
- [Conversation Metadata](./CONVERSATION_METADATA.md)
- [Message Masking](../fixes/MESSAGE_MASKING_FIX.md)
- Message Management Architecture
- Conversation Metadata
- Message Masking

## References

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -359,8 +359,8 @@ Potential improvements for future versions:

## Related Documentation

- [Audio File Support Feature](AUDIO_FILE_SUPPORT.md) (uses same Speech Service)
- [Admin Configuration Guide](../admin_configuration.md)
- Audio File Support Feature (uses same Speech Service)
- [Admin Configuration Guide](../../../admin_configuration.md)
- [Azure Speech Service Documentation](https://learn.microsoft.com/azure/ai-services/speech-service/)

## Version History
Expand Down
4 changes: 2 additions & 2 deletions docs/explanation/features/v0.235.001/TEXT_TO_SPEECH.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,8 +343,8 @@ Tests:

## Related Documentation
- [Azure Speech Service Documentation](https://docs.microsoft.com/azure/cognitive-services/speech-service/)
- [Speech-to-Text Feature](./SPEECH_TO_TEXT.md)
- [Agent Integration](./AGENT_ORCHESTRATION.md)
- Speech-to-Text Feature
- Agent Integration

## Support and Feedback
For issues, feature requests, or feedback, please contact the development team or file an issue in the project repository.
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ When consent is accepted, the following information is logged:

## Related Features

- [Azure AI Foundry Agent Support](AZURE_AI_FOUNDRY_AGENT_SUPPORT.md)
- Azure AI Foundry Agent Support
- Agent-based chat with real-time information

## Dependencies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,6 @@ This enhancement is backward compatible:

## Related Documentation

- [Smart HTTP Plugin PDF Support](SMART_HTTP_PLUGIN_PDF_SUPPORT.md)
- [Enhanced Citations Implementation](ENHANCED_CITATIONS_IMPLEMENTATION.md)
- [Plugin Documentation and Testing Standards](DOCUMENTATION_AND_TESTING_STANDARDS.md)
- Smart HTTP Plugin PDF Support
- Enhanced Citations Implementation
- Plugin Documentation and Testing Standards
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ To validate the fix:

## Related Documentation

- [EMBEDDING_TOKEN_TRACKING.md](EMBEDDING_TOKEN_TRACKING.md) - Original feature documentation (v0.233.298)
- [EMBEDDING_TOKEN_TRACKING.md](../../features/v0.235.001/EMBEDDING_TOKEN_TRACKING.md) - Original feature documentation (v0.233.298)
- [PDF_EMBEDDING_TOKEN_TRACKING_FIX.md](PDF_EMBEDDING_TOKEN_TRACKING_FIX.md) - PDF fix documentation (v0.233.299)
- [Functional Test: test_embedding_token_tracking.py](../../functional_tests/test_embedding_token_tracking.py)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,6 @@ embedding_model_deployment_name: "text-embedding-3-small"
```

## Related Documentation
- [Embedding Token Tracking Feature](../features/EMBEDDING_TOKEN_TRACKING.md)
- [Embedding Token Tracking Feature](../../features/v0.235.001/EMBEDDING_TOKEN_TRACKING.md)
- Main implementation: `application/single_app/functions_documents.py`
- Test: `functional_tests/test_embedding_token_tracking.py`
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ DEBUG_LOG_ENABLED = True

## Related

- [Azure AI Foundry Agent Support](../features/v0.236.011/AZURE_AI_FOUNDRY_AGENT_SUPPORT.md)
- Azure AI Foundry Agent Support
- Bing Grounding Tool Configuration
- Error Handling Best Practices

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,6 @@ After the fix, retention policy execution should:

## Related Documentation

- [Retention Policy Feature Documentation](../../features/RETENTION_POLICY.md)
- Retention Policy Feature Documentation
- [v0.236.012 NotFound Error Fix](../v0.236.012/RETENTION_POLICY_NOTFOUND_FIX.md)
- [v0.235.022 Document Deletion Fix](../v0.235.022/RETENTION_POLICY_DOCUMENT_DELETION_FIX.md)
Original file line number Diff line number Diff line change
Expand Up @@ -198,4 +198,4 @@ This fix ensures compatibility with all three conversation schemas that exist in

- [v0.237.004 Null Last Activity Fix](../v0.237.004/RETENTION_POLICY_NULL_LAST_ACTIVITY_FIX.md)
- [v0.236.012 NotFound Error Fix](../v0.236.012/RETENTION_POLICY_NOTFOUND_FIX.md)
- [Retention Policy Feature Documentation](../../features/RETENTION_POLICY.md)
- Retention Policy Feature Documentation
Loading
Loading