From 7bcac25ab64fbee2c5be93c73fa1f7e5aa2452da Mon Sep 17 00:00:00 2001 From: aifanatic Date: Thu, 22 Oct 2026 07:51:38 -0500 Subject: [PATCH] .NET: Point Foundry-migrated sample READMEs at FOUNDRY_* settings #6557 moved these samples' code to AIProjectClient and FOUNDRY_PROJECT_ENDPOINT / FOUNDRY_MODEL (and FOUNDRY_EMBEDDING_MODEL), but their READMEs still told readers to set AZURE_OPENAI_ENDPOINT / AZURE_OPENAI_DEPLOYMENT_NAME, so following the README fails with "FOUNDRY_PROJECT_ENDPOINT is not set." Co-Authored-By: Claude Opus 5.5 --- .../Agent_Step01_FileBasedSkills/README.md | 6 +++--- .../Agent_Step02_CodeDefinedSkills/README.md | 6 +++--- .../Agent_Step03_ClassBasedSkills/README.md | 6 +++--- .../AgentSkills/Agent_Step04_MixedSkills/README.md | 6 +++--- .../Agent_Step06_McpBasedSkills/README.md | 6 +++--- .../README.md | 12 ++++++------ .../AgentWithRAG_Step05_Neo4jGraphRAG/README.md | 6 +++--- .../Agents/Agent_Step02_StructuredOutput/README.md | 8 ++++---- .../README.md | 8 ++++---- .../Agent_Step14_BackgroundResponses/README.md | 8 ++++---- .../Agents/Agent_Step18_CompactionPipeline/README.md | 6 +++--- .../README.md | 6 +++--- .../Agent_Step20_DynamicFunctionTools/README.md | 6 +++--- 13 files changed, 45 insertions(+), 45 deletions(-) diff --git a/dotnet/samples/02-agents/AgentSkills/Agent_Step01_FileBasedSkills/README.md b/dotnet/samples/02-agents/AgentSkills/Agent_Step01_FileBasedSkills/README.md index 0c5b7f8416a..ac85762a8ea 100644 --- a/dotnet/samples/02-agents/AgentSkills/Agent_Step01_FileBasedSkills/README.md +++ b/dotnet/samples/02-agents/AgentSkills/Agent_Step01_FileBasedSkills/README.md @@ -23,14 +23,14 @@ Converts between common units (miles↔km, pounds↔kg) using a multiplication f ### Prerequisites - .NET 10.0 SDK -- Azure OpenAI endpoint with a deployed model +- A Microsoft Foundry project with a deployed model - Python 3 installed and available as `python3` on your PATH ### Setup ```bash -export AZURE_OPENAI_ENDPOINT="https://your-endpoint.openai.azure.com/" -export AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" +export FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" +export FOUNDRY_MODEL="gpt-5.4-mini" ``` ### Run diff --git a/dotnet/samples/02-agents/AgentSkills/Agent_Step02_CodeDefinedSkills/README.md b/dotnet/samples/02-agents/AgentSkills/Agent_Step02_CodeDefinedSkills/README.md index bb31b257136..762e4336f05 100644 --- a/dotnet/samples/02-agents/AgentSkills/Agent_Step02_CodeDefinedSkills/README.md +++ b/dotnet/samples/02-agents/AgentSkills/Agent_Step02_CodeDefinedSkills/README.md @@ -25,13 +25,13 @@ Converts between common units using multiplication factors. Defined entirely in ### Prerequisites - .NET 10.0 SDK -- Azure OpenAI endpoint with a deployed model +- A Microsoft Foundry project with a deployed model ### Setup ```bash -export AZURE_OPENAI_ENDPOINT="https://your-endpoint.openai.azure.com/" -export AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" +export FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" +export FOUNDRY_MODEL="gpt-5.4-mini" ``` ### Run diff --git a/dotnet/samples/02-agents/AgentSkills/Agent_Step03_ClassBasedSkills/README.md b/dotnet/samples/02-agents/AgentSkills/Agent_Step03_ClassBasedSkills/README.md index 028cb05a37c..9d72201f21a 100644 --- a/dotnet/samples/02-agents/AgentSkills/Agent_Step03_ClassBasedSkills/README.md +++ b/dotnet/samples/02-agents/AgentSkills/Agent_Step03_ClassBasedSkills/README.md @@ -26,13 +26,13 @@ A `UnitConverterSkill` class that converts between common units. Defined in `Pro ### Prerequisites - .NET 10.0 SDK -- Azure OpenAI endpoint with a deployed model +- A Microsoft Foundry project with a deployed model ### Setup ```bash -export AZURE_OPENAI_ENDPOINT="https://your-endpoint.openai.azure.com/" -export AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" +export FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" +export FOUNDRY_MODEL="gpt-5.4-mini" ``` ### Run diff --git a/dotnet/samples/02-agents/AgentSkills/Agent_Step04_MixedSkills/README.md b/dotnet/samples/02-agents/AgentSkills/Agent_Step04_MixedSkills/README.md index 7681359414a..f1148600eff 100644 --- a/dotnet/samples/02-agents/AgentSkills/Agent_Step04_MixedSkills/README.md +++ b/dotnet/samples/02-agents/AgentSkills/Agent_Step04_MixedSkills/README.md @@ -39,13 +39,13 @@ Defined as `TemperatureConverterSkill` class in `Program.cs`. Converts °F↔°C ### Prerequisites - .NET 10.0 SDK -- Azure OpenAI endpoint with a deployed model +- A Microsoft Foundry project with a deployed model ### Setup ```bash -export AZURE_OPENAI_ENDPOINT="https://your-endpoint.openai.azure.com/" -export AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" +export FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" +export FOUNDRY_MODEL="gpt-5.4-mini" ``` ### Run diff --git a/dotnet/samples/02-agents/AgentSkills/Agent_Step06_McpBasedSkills/README.md b/dotnet/samples/02-agents/AgentSkills/Agent_Step06_McpBasedSkills/README.md index c74d0eae1fd..157ef33e742 100644 --- a/dotnet/samples/02-agents/AgentSkills/Agent_Step06_McpBasedSkills/README.md +++ b/dotnet/samples/02-agents/AgentSkills/Agent_Step06_McpBasedSkills/README.md @@ -18,13 +18,13 @@ This sample demonstrates how to discover **Agent Skills served over MCP** with a ### Prerequisites - .NET 10.0 SDK -- Azure OpenAI endpoint with a deployed model +- A Microsoft Foundry project with a deployed model ### Setup ```powershell -$env:AZURE_OPENAI_ENDPOINT="https://your-endpoint.openai.azure.com/" -$env:AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" +$env:FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" +$env:FOUNDRY_MODEL="gpt-5.4-mini" ``` ### Run diff --git a/dotnet/samples/02-agents/AgentWithRAG/AgentWithRAG_Step02_CustomVectorStoreRAG/README.md b/dotnet/samples/02-agents/AgentWithRAG/AgentWithRAG_Step02_CustomVectorStoreRAG/README.md index 7875a5d3cfd..8c0a92d704e 100644 --- a/dotnet/samples/02-agents/AgentWithRAG/AgentWithRAG_Step02_CustomVectorStoreRAG/README.md +++ b/dotnet/samples/02-agents/AgentWithRAG/AgentWithRAG_Step02_CustomVectorStoreRAG/README.md @@ -7,24 +7,24 @@ This sample uses Qdrant for the vector store, but this can easily be swapped out ## Prerequisites - .NET 10 SDK or later -- Azure OpenAI service endpoint -- Both a chat completion and embedding deployment configured in the Azure OpenAI resource +- A Microsoft Foundry project endpoint +- Both a chat completion and embedding deployment configured in the Foundry project - Azure CLI installed and authenticated (for Azure credential authentication) - User has the `Cognitive Services OpenAI Contributor` role for the Azure OpenAI resource. - An existing Qdrant instance. You can use a managed service or run a local instance using Docker, but the sample assumes the instance is running locally. **Note**: These samples use Azure OpenAI models. For more information, see [how to deploy Azure OpenAI models with Microsoft Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/how-to/deploy-models-openai). -**Note**: These samples use Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Azure OpenAI resource and have the `Cognitive Services OpenAI Contributor` role. For more information, see the [Azure CLI documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively). +**Note**: These samples use Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Foundry project and have the `Cognitive Services OpenAI Contributor` role. For more information, see the [Azure CLI documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively). ## Running the sample from the console Set the following environment variables: ```powershell -$env:AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/" # Replace with your Azure OpenAI resource endpoint -$env:AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini -$env:AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME="text-embedding-3-large" # Optional, defaults to text-embedding-3-large +$env:FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" # Replace with your Foundry project endpoint +$env:FOUNDRY_MODEL="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini +$env:FOUNDRY_EMBEDDING_MODEL="text-embedding-3-large" # Optional, defaults to text-embedding-3-large ``` If the variables are not set, you will be prompted for the values when running the samples. diff --git a/dotnet/samples/02-agents/AgentWithRAG/AgentWithRAG_Step05_Neo4jGraphRAG/README.md b/dotnet/samples/02-agents/AgentWithRAG/AgentWithRAG_Step05_Neo4jGraphRAG/README.md index 7295f89ca11..e383f6d74b4 100644 --- a/dotnet/samples/02-agents/AgentWithRAG/AgentWithRAG_Step05_Neo4jGraphRAG/README.md +++ b/dotnet/samples/02-agents/AgentWithRAG/AgentWithRAG_Step05_Neo4jGraphRAG/README.md @@ -7,15 +7,15 @@ The sample uses a Neo4j fulltext index for retrieval and a Cypher `RetrievalQuer ## Prerequisites - .NET 10 SDK or later -- Azure OpenAI endpoint and chat deployment +- A Microsoft Foundry project with a chat model deployment - Azure CLI installed and authenticated - A Neo4j database with chunked documents and a fulltext index such as `search_chunks` ## Environment variables ```powershell -$env:AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/" -$env:AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" +$env:FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" +$env:FOUNDRY_MODEL="gpt-5.4-mini" $env:NEO4J_URI="neo4j+s://your-instance.databases.neo4j.io" $env:NEO4J_USERNAME="neo4j" $env:NEO4J_PASSWORD="your-password" diff --git a/dotnet/samples/02-agents/Agents/Agent_Step02_StructuredOutput/README.md b/dotnet/samples/02-agents/Agents/Agent_Step02_StructuredOutput/README.md index babe679ea25..0c1354bdad1 100644 --- a/dotnet/samples/02-agents/Agents/Agent_Step02_StructuredOutput/README.md +++ b/dotnet/samples/02-agents/Agents/Agent_Step02_StructuredOutput/README.md @@ -14,21 +14,21 @@ This sample demonstrates how to configure ChatClientAgent to produce structured Before you begin, ensure you have the following prerequisites: - .NET 10 SDK or later -- Azure OpenAI service endpoint and deployment configured +- Microsoft Foundry project endpoint and model configured - Azure CLI installed and authenticated (for Azure credential authentication) - User has the `Cognitive Services OpenAI Contributor` role for the Azure OpenAI resource **Note**: This sample uses Azure OpenAI models. For more information, see [how to deploy Azure OpenAI models with Microsoft Foundry](https://learn.microsoft.com/en-us/azure/ai-foundry/how-to/deploy-models-openai). -**Note**: This demo uses Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Azure OpenAI resource and have the `Cognitive Services OpenAI Contributor` role. For more information, see the [Azure CLI documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively). +**Note**: This demo uses Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Foundry project and have the `Cognitive Services OpenAI Contributor` role. For more information, see the [Azure CLI documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively). ## Environment Variables Set the following environment variables: ```powershell -$env:AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/" # Replace with your Azure OpenAI resource endpoint -$env:AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini +$env:FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" # Replace with your Foundry project endpoint +$env:FOUNDRY_MODEL="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini ``` ## Run the sample diff --git a/dotnet/samples/02-agents/Agents/Agent_Step10_BackgroundResponsesWithToolsAndPersistence/README.md b/dotnet/samples/02-agents/Agents/Agent_Step10_BackgroundResponsesWithToolsAndPersistence/README.md index b5be2cdd4c0..7cba7c858b7 100644 --- a/dotnet/samples/02-agents/Agents/Agent_Step10_BackgroundResponsesWithToolsAndPersistence/README.md +++ b/dotnet/samples/02-agents/Agents/Agent_Step10_BackgroundResponsesWithToolsAndPersistence/README.md @@ -15,14 +15,14 @@ For more information, see the [official documentation](https://learn.microsoft.c Before you begin, ensure you have the following prerequisites: - .NET 10 SDK or later -- Azure OpenAI service endpoint and deployment configured +- Microsoft Foundry project endpoint and model configured - Azure CLI installed and authenticated (for Azure credential authentication) -**Note**: This demo uses Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Azure OpenAI resource. For more information, see the [Azure CLI documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively). +**Note**: This demo uses Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Foundry project. For more information, see the [Azure CLI documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively). Set the following environment variables: ```powershell -$env:AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/" # Replace with your Azure OpenAI resource endpoint -$env:AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini +$env:FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" # Replace with your Foundry project endpoint +$env:FOUNDRY_MODEL="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini ``` diff --git a/dotnet/samples/02-agents/Agents/Agent_Step14_BackgroundResponses/README.md b/dotnet/samples/02-agents/Agents/Agent_Step14_BackgroundResponses/README.md index 2a668f9e6c7..571bea9a73b 100644 --- a/dotnet/samples/02-agents/Agents/Agent_Step14_BackgroundResponses/README.md +++ b/dotnet/samples/02-agents/Agents/Agent_Step14_BackgroundResponses/README.md @@ -14,14 +14,14 @@ For more information, see the [official documentation](https://learn.microsoft.c Before you begin, ensure you have the following prerequisites: - .NET 10 SDK or later -- Azure OpenAI service endpoint and deployment configured +- Microsoft Foundry project endpoint and model configured - Azure CLI installed and authenticated (for Azure credential authentication) -**Note**: This demo uses Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Azure OpenAI resource. For more information, see the [Azure CLI documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively). +**Note**: This demo uses Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Foundry project. For more information, see the [Azure CLI documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively). Set the following environment variables: ```powershell -$env:AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/" # Replace with your Azure OpenAI resource endpoint -$env:AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini +$env:FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" # Replace with your Foundry project endpoint +$env:FOUNDRY_MODEL="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini ``` \ No newline at end of file diff --git a/dotnet/samples/02-agents/Agents/Agent_Step18_CompactionPipeline/README.md b/dotnet/samples/02-agents/Agents/Agent_Step18_CompactionPipeline/README.md index ebb649a5011..ce21e318131 100644 --- a/dotnet/samples/02-agents/Agents/Agent_Step18_CompactionPipeline/README.md +++ b/dotnet/samples/02-agents/Agents/Agent_Step18_CompactionPipeline/README.md @@ -111,7 +111,7 @@ Order strategies from **least aggressive** to **most aggressive**. The pipeline ## Prerequisites - .NET 10 SDK or later -- Azure OpenAI service endpoint and model deployment +- Microsoft Foundry project endpoint and model configured - Azure CLI installed and authenticated **Note**: This sample uses `DefaultAzureCredential`. Sign in with `az login` before running. For production, prefer a specific credential such as `ManagedIdentityCredential`. For more information, see the [Azure CLI authentication documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively). @@ -119,8 +119,8 @@ Order strategies from **least aggressive** to **most aggressive**. The pipeline ## Environment Variables ```powershell -$env:AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/" # Required -$env:AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini +$env:FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" # Required +$env:FOUNDRY_MODEL="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini ``` ## Running the Sample diff --git a/dotnet/samples/02-agents/Agents/Agent_Step19_InFunctionLoopCheckpointing/README.md b/dotnet/samples/02-agents/Agents/Agent_Step19_InFunctionLoopCheckpointing/README.md index 25ac6162759..85e7081d234 100644 --- a/dotnet/samples/02-agents/Agents/Agent_Step19_InFunctionLoopCheckpointing/README.md +++ b/dotnet/samples/02-agents/Agents/Agent_Step19_InFunctionLoopCheckpointing/README.md @@ -36,7 +36,7 @@ ChatClientAgent ## Prerequisites - .NET 10 SDK or later -- Azure OpenAI service endpoint and model deployment +- Microsoft Foundry project endpoint and model configured - Azure CLI installed and authenticated **Note**: This sample uses `DefaultAzureCredential`. Sign in with `az login` before running. For production, prefer a specific credential such as `ManagedIdentityCredential`. For more information, see the [Azure CLI authentication documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively). @@ -44,8 +44,8 @@ ChatClientAgent ## Environment Variables ```powershell -$env:AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/" # Required -$env:AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini +$env:FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" # Required +$env:FOUNDRY_MODEL="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini ``` ## Running the Sample diff --git a/dotnet/samples/02-agents/Agents/Agent_Step20_DynamicFunctionTools/README.md b/dotnet/samples/02-agents/Agents/Agent_Step20_DynamicFunctionTools/README.md index fb0245b542a..15bb366f917 100644 --- a/dotnet/samples/02-agents/Agents/Agent_Step20_DynamicFunctionTools/README.md +++ b/dotnet/samples/02-agents/Agents/Agent_Step20_DynamicFunctionTools/README.md @@ -18,7 +18,7 @@ This sample demonstrates how to dynamically expand the set of function tools ava ## Prerequisites - .NET 10 SDK or later -- Azure OpenAI service endpoint and deployment configured +- Microsoft Foundry project endpoint and model configured - Azure CLI installed and authenticated (for Azure credential authentication) - User has the `Cognitive Services OpenAI Contributor` role for the Azure OpenAI resource @@ -27,8 +27,8 @@ This sample demonstrates how to dynamically expand the set of function tools ava Set the required environment variables: ```powershell -$env:AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/" -$env:AZURE_OPENAI_DEPLOYMENT_NAME="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini +$env:FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" +$env:FOUNDRY_MODEL="gpt-5.4-mini" # Optional, defaults to gpt-5.4-mini ``` Run the sample: