2024-02-01: Authentication improvement, new JSON Parser

This release adds a new JSONParser class, which also serves as an example of how to bring in other local parsers for desired file formats. This release also includes improved token validation for authentications, so please merge that change if you are using the authentication feature.

What's Changed

• Add token validation by @mattgotteiner in #1186
• Add JsonFileParser to FileStrategy by @codebytes in #1195
• Fix search ranker level by @pamelafox in #1203
• Bump all Python dependencies by @dependabot in #1206
• Update doc on free deployment with video and other tips by @pamelafox in #1204
• Gpt4 + vision -verify access by create deployment by @dfberry in #1200
• Update README.md with correct link by @pamelafox in #1216

New Contributors

• @dfberry made their first contribution in #1200
• @codebytes made their first contribution in #1195

Full Changelog: 2024-01-27...2024-02-01

2024-01-27: Bugfix for GPT-4-with-vision, frontend file rename

This release includes a fix for developers using the GPT-4-with-vision option, and a rename of frontend files (OneShot -> Ask).

What's Changed

• Rename OneShot to Ask, update Black style by @pamelafox in #1191
• Account for vision key only situation by @pamelafox in #1192

Full Changelog: 2024-01-25...2024-01-27

2024-01-24: ACL improvements, OpenAI tools upgrade

This PR includes an important upgrade for anyone using the ACL feature, adding authentication checks for the /content endpoint. In addition, the authentication checks are now implemented as decorators which can be added to any route.

What's Changed

• Apply acls to citations by @mattgotteiner in #1160
• Update to tools parameter by @tonybaloney in #1175
• Update data indexing link in gpt4v.md by @waelkdouh in #1182

New Contributors

• @waelkdouh made their first contribution in #1182

Full Changelog: 23-01-2024...25-01-2024

2024-01-25: Support for free tiers

This release makes it possible to deploy the app on free tiers and with a free account. See https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/docs/deploy_lowcost.md for more details.

What's Changed

• Make it possible to deploy on free App Service and free Search Service tier by @pamelafox in #1166

Full Changelog: 25-01-2024...2024-01-25

2024-01-23: Evaluation tool, Lllamafile support, other bug fixes

This release contain small fixes to the optional authentication, GPT-4-Vision integration, prepdocs script, and local hot reloading.

It also includes a link to a new evaluation tool for evaluating app response quality and new documentation about running the app locally against a llamafile server.

What's Changed

• Add support for local OpenAI-compatible server, fix local hot reloading, add docs on local dev by @pamelafox in #1148
• Link to evaluation repo by @pamelafox in #1061
• Fix prepdocs by @mattgotteiner in #1064
• [BugFix] Fix logic in prepdocs to always update search index by @pamelafox in #1066
• [BugFix] Use default font when a specific font cannot be found by @pamelafox in #1069
• Explain the vision tabs by @pamelafox in #1067
• Add more tests for prepdocslib by @tonybaloney in #1082
• Correct pwsh command and location by @diberry in #1114
• bugfix: fix the same variable was used twice in the judgment by @swanypro in #1086
• Update Authentication to use local storage and easy auth refresh by @mattgotteiner in #1117
• bug #1152: Fix for indexing small docs by @marekjakimiuk1 in #1155
• Cast event as ChatAppResponse by @pamelafox in #1130
• Bump the github-actions group with 2 updates by @dependabot in #1075
• Bump jinja2 from 3.1.2 to 3.1.3 in /app/backend by @dependabot in #1128
• Bump pillow from 10.1.0 to 10.2.0 in /scripts by @dependabot in #1168
• Bump vite from 4.5.1 to 4.5.2 in /app/frontend by @dependabot in #1161

New Contributors

• @diberry made their first contribution in #1114
• @swanypro made their first contribution in #1086
• @marekjakimiuk1 made their first contribution in #1155

Full Changelog: 12-12-2023-automate-auth...23-01-2024

2023-12-13: Support for multi-modal search

• Feature Enhancement:

Introduces multimodal capabilities to the RAG sample.
Leverages Azure OpenAI GPT-4 Vision-preview for enhanced functionality.

• Integration:

Integrates seamlessly with Azure OpenAI GPT-4 Vision for powerful multimodal capabilities.

• Documentation Update:

New documentation available in docs/gpt4.md for setting up and experiencing the new multimodal capability.
Users are encouraged to review the documentation for a smooth onboarding experience.

• How to Get Started:

Follow the instructions in docs/gpt4.md to configure and unlock the multimodal features.

What's Changed

• Update python-test.yaml with 3.12 by @pamelafox in #1030
• Bump vite from 4.4.11 to 4.4.12 in /app/frontend by @dependabot in #1034
• Bump the python-requirements group with 5 updates by @dependabot in #1029
• Bump the node-packages group in /app/frontend with 14 updates by @dependabot in #1038
• Integrate GPT4-vision support by @srbalakr in #1056

Full Changelog: 04-12-2023...12-13-2023

2023-12-12: Automation of Login and Entra ID setup

This is another large release with improvements to automate the setup of Entra ID authentication (login and access control).
See the updated guide for steps on setting it up using azd:
https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/LoginAndAclSetup.md#automatic-setup

We have several improvements planned to auth, please follow these issues:
https://github.com/Azure-Samples/azure-search-openai-demo/issues?q=is%3Aopen+is%3Aissue+author%3Amattmsft+label%3Aauth

As usual, post in the issue tracker if you attempt to use the new automated setup and run into any issues.

What's Changed

• Automate Login Setup by @mattmsft in #891
• [Bugfix] Change the if condition for GPT-V to check USE_GPTV to fix non-GPTV usage by @pamelafox in #1060
• Disable funding notice during npm install process by @pamelafox in #1037
• Update README.md openai link by @pamelafox in #1035
• Bump the github-actions group with 2 updates by @dependabot in #1047

Full Changelog: 12-13-2023...12-12-2023-automate-auth

2023-04-12: OpenAI 1.0 Upgrade

The big change in today's release is upgrading to OpenAI 1.0 SDK. This should not cause any backwards compatibility issues.

What's Changed

• Upgrade OpenAI SDK to v1 by @tonybaloney in #1017
• [Docs] Update search internationalization links to table with string values by @pamelafox in #993
• [Docs] Add to readme: links, getting help, load balancing by @pamelafox in #1019

Full Changelog: 29-11-2023...04-12-2023

2023-11-29: Fall release

We're going to start using releases more consistently. You can choose to watch just the "releases" in this repository to be notified of the latest changes. This is our first release since July, so the changelog below includes quite a few changes.

The most notable changes are:

• streaming responses in the UI and backend
• optional login and document ACLs
• rendering full PDFs instead of single pages in the UI
• support for non-Azure OpenAI
• removal of langchain-based approaches
• calculation of MD5 hashes when uploading docs (to avoid redundant uploads later)

What's Changed

• Add more tests for core/ folder by @pamelafox in #430
• Update FAQ to include common failures reasons with links by @johnrsanders in #252
• Add simple validation by @pamelafox in #445
• Using azd feature by @pamelafox in #429
• Rewrite roles.ps1 in bash by @ahnl in #351
• Fix for paths with spaces by @amithkk in #71
• Fix path to env file in README by @openjck in #153
• Add 3.8 and 3.9 to test to matrix, fix type bug by @pamelafox in #454
• Require Node 14+ by @pamelafox in #453
• Update imports to explicit named imports for prepdocs by @pamelafox in #452
• Update notebooks to chatcompletion api by @srbalakr in #463
• Tell Oryx to configure gunicorn workers dynamically by @pamelafox in #461
• Adjust regions by @pamelafox in #467
• Add more to troubleshooting section by @pamelafox in #470
• Respect ENV values for resource group and index name by @Patrick-Davis-MSFT in #469
• Startup script for App Service by @pamelafox in #464
• Ensure openai token by @gukoff in #262
• Run ruff, add to precommit by @pamelafox in #491
• Use an app factory pattern to enable app testing by @pamelafox in #495
• Port to Quart by @pamelafox in #503
• Update README.md with FAQ comparing to other repo by @pamelafox in #512
• Sample Locust loadtest by @pamelafox in #486
• Change to port 50505 by @pamelafox in #523
• Gunicorn timeout by @pamelafox in #524
• Add application insights for request and backend tracing of performance data by @tonybaloney in #515
• Update main.bicep with more allowed regions by @pamelafox in #520
• Address recent bugs by @srbalakr in #529
• Add more details to costs section by @pamelafox in #537
• Update README.md to include clear authentication/access control and steps to secure deployed app by @andyloree in #536
• Add workaround for connection reset issue by @pamelafox in #525
• Fix typo in prepdocs.py by @eltociear in #539
• Remove unneeded deployment by @pamelafox in #540
• Typo "Azure Open AI"→"Azure OpenAI" by @hyoshioka0128 in #545
• Update README.md based on Connor's flow by @pamelafox in #548
• Remove defaults for getenv by @pamelafox in #550
• Update README.md location list by @pamelafox in #551
• Update README.md FAQ re gpt-4 by @pamelafox in #553
• Bump langchain from 0.0.187 to 0.0.236 in /notebooks by @dependabot in #522
• Bump langchain from 0.0.187 to 0.0.236 in /app/backend by @dependabot in #521
• Add Azure Security for DevOps to CI Pipeline by @tonybaloney in #557
• Adding table of contents to main readme by @connorwehrum in #554
• Use Standard_LRS instead of Standard_ZRS by @debonte in #567
• Allow for subdirectory structure within data directory by @PfisterAn in #569
• Make SARIF uploads optional but automatic for the main repo by @tonybaloney in #578
• Create stale-bot.yml for tidying up backlog by @tonybaloney in #579
• Remove notebooks by @pamelafox in #588
• Update README.md with chat/ask question by @pamelafox in #584
• Add section about productionizing by @pamelafox in #577
• Update README.md deploying section by @pamelafox in #589
• Update README.md about local env by @pamelafox in #587
• Indexing: Improve vectors throughput by @srbalakr in #556
• Adds optional streaming support for chat requests by @pamelafox in #532
• Explicitly set https required by @tonybaloney in #581
• Update README.md with account reqs by @pamelafox in #609
• Fix prepdocs compatibility with openai key and add test by @pamelafox in #605
• Use environ vs getenv by @pamelafox in #611
• Update README.md with logging info by @pamelafox in #610
• Fix devcontainer name by @iemejia in #613
• Fix prompt_template override, add tests by @pamelafox in #606
• Update README.md with azd up descrip by @pamelafox in #602
• Make it easier to re-use a search service by @pamelafox in #620
• Add parameter for configuring storage sku by @pamelafox in #628
• Reword top label by @pamelafox in #627
• Only validate bicep on changes to infra folder by @tonybaloney in #631
• Run black on all Python files by @pamelafox in #632
• Adding support for non-Azure openai instances by @carlotta94c in #507
• Readme on deploying to existing RG by @pamelafox in #637
• Hotfix to prepdocs.ps1 to fix env variable by @pamelafox in #639
• Adding anchors to FAQs by @pamelafox in #638
• Comparison table by @pamelafox in #640
• Clarify which search Skus are compatible by @pamelafox in #642
• Fix prepdocs to handle empty env variables by @pamelafox in #651
• Smooth streaming, fix partial citation, and ensure visibility. by @SteveJSteiner in #659
• Adding more regions by @tonybaloney in #660
• Stabilize search query generation by @srbalakr in #652
• Hotfix: Workaround for stream bug by @pamelafox in https://github.com/Azure-Sa...

2023-07-18: Vector search enabled

This release added vector search from Azure AI search.