2024-05-29: Speech Input/Output

The big feature in this release is the option to add speech input (via the browser) and speech output (via Azure speech SDK). See how to enable the new features in the guide here:
https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/docs/deploy_features.md#enabling-speech-inputoutput

This release also includes some updates for the chat-with-vision approach.

What's Changed

• Don't set bypass rules for ComputerVision type of Cognitive Services by @pamelafox in #1657
• Update GPT-4 version in readme by @pamelafox in #1663
• Use chat model for query rewriting by @pamelafox in #1659
• Add speech recognizer and synthesis on browser interface by @sowu880 in #113

New Contributors

• @sowu880 made their first contribution in #113

Full Changelog: 2024-05-28...2024-05-29

2024-05-28: Security improvements for Document Intelligence, Free Search Tier

The most notable changes in this release relate to security:

• Disablement of API key based access for Azure Document Intelligence. Our repository does not use keys to authenticate to the DI service, only managed identity, so keys should not be needed. If you use the same Document Intelligence instance for other projects and need key-based access for it, then you should set "disableLocalAuth: false" in the Bicep.
• Removal of search keys for free tier of search service. I originally mistakenly thought that the free tier of search service did not support managed identity, but it's actually the case that it doesn't support outbound managed identity, relevant if you're using indexers or skills with it. It does support inbound managed identity, so we removed the key and key vault for that feature. This won't affect most developers, since the default deployment uses the standard tier.

What's Changed

• Fix Add Default Key for Retrieval Mode to Persist the Change by @john0isaac in #1609
• Additional pointers to docs on private endpoints and load balancing by @pamelafox in #1618
• Removing unneeded key for free search service by @pamelafox in #1620
• Bump the python-requirements group across 1 directory with 65 updates by @dependabot in #1623
• Add load testing user class for gpt-4-vision use case by @pamelafox in #1633
• Fix samples browser by @diberry in #1631
• Fix samples browser - bookmarks by @diberry in #1637
• Improve token counting for messages with package by @pamelafox in #1577
• Fix output variable for global document access by @mattgotteiner in #1645
• Updates to login docs (login step, Entra branding) by @pamelafox in #1574
• Disable key auth for Azure Document Intelligence by @pamelafox in #1629

Full Changelog: 2024-05-15B...2024-05-28

2024-05-15B: Deploying with private access

We've now made it possible for you to deploy this app with public access disabled, using Azure private endpoints and private DNS Zones. For more details, read the private deployment guide.

As always, please report any issues you encounter when trying this new feature.

What's Changed

• Optional deployment of Private Networks, Private Endpoints plus optional configuration of an ACL rule for all backend services by @tonybaloney in #864

Full Changelog: 2024-05-15...2024-05-15B

2024-05-15: Authentication improvements for public documents

This release adds new environment variables for more flexibility when using user authentication and user access control. Here is the updated section of the documentation about authentication section:

1. (Optional) To require access control when using the app, run azd env set AZURE_ENFORCE_ACCESS_CONTROL true. Authentication is always required to search on documents with access control assigned, regardless of if unauthenticated access is enabled or not.
2. (Optional) To allow authenticated users to search on documents that have no access controls assigned, even when access control is required, run azd env set AZURE_ENABLE_GLOBAL_DOCUMENT_ACCESS true.
3. (Optional) To allow unauthenticated users to use the app, even when access control is enforced, run azd env set AZURE_ENABLE_UNAUTHENTICATED_ACCESS true. AZURE_ENABLE_GLOBAL_DOCUMENT_ACCESS should also be set to true if you want unauthenticated users to be able to search on documents with no access control.

See the full steps here:
https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/docs/login_and_acl.md#automatic-setup

Please file issues if you see any problems with the new capabilities.
 

What's Changed

• Add note about OPENAI_HOST and azd deployment by @pamelafox in #1479
• Update customization.md - fix broken doc links by @tamram in #1592
• Add roles descriptions to roles.sh by @cedricvidal in #1583
• Escape single quote marks for search filters by @pamelafox in #1599
• Updating load balancing instructions by @andredewes in #1598
• Allow public documents when authentication is enabled by @mattgotteiner in #1576

New Contributors

• @tamram made their first contribution in #1592
• @cedricvidal made their first contribution in #1583

Full Changelog: 2024-04-25...2024-05-15

2024-04-25: Bugfixes for free sku, ADLS2, storageUrl

Today's release includes a variety of bugfixes:

What's Changed

• Fix gunicorn config to use single worker for free sku by @pamelafox in #1551
• Adding missing adls2 variables to azd pipeline by @pamelafox in #1544
• Adding user-upload as a feature in sample comparison by @pamelafox in #1542
• Disable OpenAI key access by @pamelafox in #1555
• Add storageurl field if missing in index by @pamelafox in #1556

Full Changelog: 2024-04-19...2024-04-25

2024-04-19: Improved security for user-uploaded documents

This release improves the security of the optional user upload mechanism by adding a storageUrl field to disambiguate between user-uploaded files and admin-uploaded files with the same name. Now when running manageacl.py, you must specify the full storageUrl whose ACLs require updating.
If you have an existing search index from before this release, please follow steps in README to add the new storageUrl field and backfill it to existing chunks in the index:
https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/docs/deploy_features.md#enabling-user-document-upload

What's Changed

• Adds storageURL field to track file location by @pamelafox in #1535
• Disable key-based storage account access in Bicep by @pamelafox in #1518
• Bump idna from 3.6 to 3.7 in /app/backend by @dependabot in #1525
• Bump vite from 4.5.2 to 4.5.3 in /app/frontend by @dependabot in #1488
• Fix gpt-4 vision link by @adamdougal in #1546

New Contributors

• @adamdougal made their first contribution in #1546

Full Changelog: 2024-04-10...2024-04-19

2024-04-10: Graph SDK for auth setup

We are now using msgraph-sdk instead of direct HTTP calls for our scripts that setup Entra application registrations. There should be no functional difference after the change.

What's Changed

• Bump pillow from 10.2.0 to 10.3.0 in /app/backend by @dependabot in #1486
• Port to the Graph SDK for authentication scripts by @pamelafox in #1510

Full Changelog: 2024-03-09...2024-03-10

2024-04-09: Optional user document upload feature

The latest release includes a feature that changes the codebase significantly, the ability for users to upload documents. In order to implement this feature, we moved prepdocslib into app/backend (out of scripts). If your fork has changes in prepdocslib, you may want to merge with the commit before this feature, and then merge this commit, which only moves the files without changing them.

If you want to enable user document upload, follow the documentation at: https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/docs/deploy_features.md#enabling-user-document-upload
Note that you will need to enable user authentication as a prerequisite for user upload, since only authenticated users can upload.
⚠️ Please see these open issues regarding access control: #1531 , #1532

What's Changed

• Optional upload documents feature by @pamelafox in #1395
• Update README.md with right links to deploy docs by @pamelafox in #1466
• Correct datalakepath argument in prepdocs.sh and prepdocs.ps1 by @pamelafox in #1478
• Bump the github-actions group with 1 update by @dependabot in #1474
• Enforce RBAC only for non-free search service by @pamelafox in #1502
• Update link to pricing calculator to fix Document Intelligence estimation by @pamelafox in #1480
• Update document level access control docs by @mattgotteiner in #1511
• Fix Access control list documentation link issues by @mattgotteiner in #1512

Full Changelog: 2024-03-26...2024-03-09

2024-03-26: New embedding models, more azd environment variables

This release includes additional ways to customize your application setup.

You can try out the new embedding models following steps here:
https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/docs/deploy_features.md#using-text-embedding-3-models

You can also use environment variables to reuse existing Azure resources (which previously required a Bicep change):
https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/docs/deploy_existing.md

Please let us know if you run into any issues with the latest release by filing an issue in the issue tracker.

What's Changed

• Force soft delete and purge for keyvault by @tonybaloney in #1462
• Added Environment Variables for setting Names of Resources by @giterinhub in #1389
• Fix broken links by @pamelafox in #1450
• Add support for using new embedding models with different dimensions by @pamelafox in #1378

Full Changelog: 2024-03-25...2024-03-26

2024-03-25: GPT-4 environment variables

You can now specify your GPT model name and version entirely in the azd environment variables. See updated documentation here:
https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/docs/deploy_features.md#using-gpt-4

What's Changed

• Fix search secret name environment variable for free deploys by @pamelafox in #1455
• Allow manual setting of the OpenAI Deployment Name, Version, Capacity and Model by @john0isaac in #1386

Full Changelog: 2024-03-20...2024-03-25