Ahmed Muhsin
bb3d3c2efc
* Add workflow support for Azure Functions * fix compatability with latest framework changes and add integration tests * refactor code * remove white space Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * align help text with actual port used Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * replace instance id with a place holder Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * remove unused import Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * remove redundant typing import and fix SIM115 * fix latest breaking changes * fix mypy issues * clean up imports * define source marker strings as constants * fix json module name * refactor _extract_message_content_from_dict * refactor serialization * add helper method for error response construction and remove _extract_message_content_from_dict since it is not needed * use strict tpe checking for edges * change how duplicate agent registrations are handled * cancel approval_task on HITL timeout * update docstring * fix: align azurefunctions package with core API changes after rebase - State.import_state/export_state are now sync (removed await) - Add State.commit() before export_state() in activity execution - Rename executor parameter shared_state -> state - Rename ctx.set_shared_state/get_shared_state -> set_state/get_state (sync) - WorkflowBuilder now takes start_executor as constructor kwarg - Update WorkflowOutputEvent -> WorkflowEvent with type='output' - Update RequestInfoEvent -> WorkflowEvent[Any] - Update SharedState -> State in test imports - Update duplicate agent name tests to match new warning behavior - Update sample README API references * fix sample check errors * fix mypy issues * fix trailing white spaces * fix test imports * feat: add durable workflow samples and adapt to main branch changes - Add workflow samples 09-12 to 04-hosting/azure_functions/ - Adapt to ChatMessage -> Message rename from main - Adapt to pickle-based checkpoint encoding from main - Simplify _serialization.py to delegate to core encode/decode - Fix Message -> WorkflowMessage disambiguation in _context.py - Remove non-existent _checkpoint_summary import * fix: update create_checkpoint signature to match superclass * fix: correct relative link in HITL sample README * fix: resolve import breakage after rebase (State, DurableAgentThread, get_logger) --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Dmytro Struk <13853051+dmytrostruk@users.noreply.github.com>
These are common instructions for setting up your environment for every sample in this directory. These samples illustrate the Durable extensibility for Agent Framework running in Azure Functions.
All of these samples are set up to run in Azure Functions. Azure Functions has a local development tool called CoreTools which we will set up to run these samples locally.
Environment Setup
1. Install dependencies and create appropriate services
-
Install Azure Functions Core Tools 4.x
-
Install Azurite storage emulator
-
Create an Azure OpenAI resource. Note the Azure OpenAI endpoint, deployment name, and the key (or ensure you can authenticate with
AzureCliCredential). -
Install a tool to execute HTTP calls, for example the REST Client extension
-
[Optionally] Create an Azure Function Python app to later deploy your app to Azure if you so desire.
2. Create and activate a virtual environment
Windows (PowerShell):
python -m venv .venv
.venv\Scripts\Activate.ps1
Linux/macOS:
python -m venv .venv
source .venv/bin/activate
3. Running the samples
-
Inside each sample:
-
Install Python dependencies – from the sample directory, run
pip install -r requirements.txt(or the equivalent in your active virtual environment). -
Copy
local.settings.json.templatetolocal.settings.json, then updateAZURE_OPENAI_ENDPOINTandAZURE_OPENAI_CHAT_DEPLOYMENT_NAMEfor Azure OpenAI authentication. The samples useAzureCliCredentialby default, so ensure you're logged in viaaz login.- Alternatively, you can use API key authentication by setting
AZURE_OPENAI_API_KEYand updating the code to useAzureOpenAIChatClient()without the credential parameter. - Keep
TASKHUB_NAMEset todefaultunless you plan to change the durable task hub name.
- Alternatively, you can use API key authentication by setting
-
Run the command
func startfrom the root of the sample -
Follow each sample's README for scenario-specific steps, and use its
demo.httpfile (or provided curl examples) to trigger the hosted HTTP endpoints.
-