Skip to content

Python: Point Foundry-migrated sample READMEs at the settings the code reads #9759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Naveen Chatlapalli (1aifanatic) wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Python: Point Foundry-migrated sample READMEs at the settings the code reads #9759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion python/samples/02-agents/context_providers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ These samples demonstrate how to use context providers to enrich agent conversat
**For `azure_ai_foundry_memory.py`:**
- `FOUNDRY_PROJECT_ENDPOINT`: Your Microsoft Foundry project endpoint
- `FOUNDRY_MODEL`: Chat/responses model deployment name
- `AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME`: Embedding model deployment name (e.g., `text-embedding-ada-002`)
- `AZURE_OPENAI_EMBEDDING_MODEL`: Embedding model deployment name (e.g., `text-embedding-ada-002`)
- Azure CLI authentication (`az login`)

**For `file_memory_provider.py`:**
Expand Down
4 changes: 2 additions & 2 deletions python/samples/02-agents/devui/agent_content_understanding/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Interactive web UI for uploading and chatting with documents, images, audio, and

1. Set environment variables (or create a `.env` file in `python/`):
```bash
FOUNDRY_PROJECT_ENDPOINT=https://your-project.api.azureml.ms
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME=gpt-4.1
FOUNDRY_PROJECT_ENDPOINT=https://your-account.services.ai.azure.com/api/projects/your-project
FOUNDRY_MODEL=gpt-4.1
AZURE_CONTENTUNDERSTANDING_ENDPOINT=https://your-cu-resource.cognitiveservices.azure.com/
```

Expand Down
2 changes: 1 addition & 1 deletion .../02-agents/devui/agent_content_understanding_file_search_azure_openai/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Interactive web UI for uploading and chatting with documents, images, audio, and
1. Set environment variables (or create a `.env` file in `python/`):
```bash
FOUNDRY_PROJECT_ENDPOINT=https://your-account.services.ai.azure.com/api/projects/your-project
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME=gpt-4.1
FOUNDRY_MODEL=gpt-4.1
AZURE_CONTENTUNDERSTANDING_ENDPOINT=https://your-cu-resource.services.ai.azure.com/
```

Expand Down
2 changes: 1 addition & 1 deletion python/samples/02-agents/skills/file_based_skill/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ file_based_skill/
Set the required environment variables in a `.env` file (see `python/.env.example`):

- `FOUNDRY_PROJECT_ENDPOINT`: Your Microsoft Foundry project endpoint
- `AZURE_OPENAI_MODEL`: The name of your model deployment (defaults to `gpt-4o-mini`)
- `FOUNDRY_MODEL`: The name of your model deployment (defaults to `gpt-4o-mini`)

### Authentication

Expand Down
4 changes: 2 additions & 2 deletions python/samples/02-agents/skills/mixed_skills/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ File scripts are executed as **local Python subprocesses** via the
Set environment variables (or create a `.env` file):

```
FOUNDRY_PROJECT_ENDPOINT=https://your-project.openai.azure.com/
AZURE_OPENAI_MODEL=gpt-4o-mini
FOUNDRY_PROJECT_ENDPOINT=https://your-account.services.ai.azure.com/api/projects/your-project
FOUNDRY_MODEL=gpt-4o-mini
```

Authenticate with Azure CLI:
Expand Down
11 changes: 5 additions & 6 deletions python/samples/05-end-to-end/chatkit-integration/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ The sample implements a ChatKit server using the `ChatKitServer` base class from
- **`WeatherChatKitServer`**: Custom ChatKit server implementation that:

- Extends `ChatKitServer[dict[str, Any]]`
- Uses Agent Framework's `Agent` with Azure OpenAI
- Uses Agent Framework's `Agent` with `FoundryChatClient`
- Converts ChatKit messages to Agent Framework format using `ThreadItemConverter`
- Streams responses back to ChatKit using `stream_agent_response`
- Creates and streams interactive widgets after agent responses
Expand Down Expand Up @@ -135,7 +135,7 @@ async for event in stream_widget(thread_id=thread.id, widget=widget):

- Python 3.10+
- Node.js 18.18+ and npm 9+
- Azure OpenAI service configured
- A Microsoft Foundry project with a deployed model
- Azure CLI for authentication (`az login`)

### Network Requirements
Expand Down Expand Up @@ -172,12 +172,11 @@ cd python/samples/05-end-to-end/chatkit-integration
pip install agent-framework-chatkit fastapi uvicorn azure-identity
```

2. **Configure Azure OpenAI:**
2. **Configure Microsoft Foundry:**

```bash
export AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/"
export AZURE_OPENAI_API_VERSION="2024-06-01"
export AZURE_OPENAI_MODEL="gpt-4o"
export FOUNDRY_PROJECT_ENDPOINT="https://your-account.services.ai.azure.com/api/projects/your-project"
export FOUNDRY_MODEL="gpt-4o"
```

3. **Authenticate with Azure:**
Expand Down
Loading