Skip to content

Python: list FOUNDRY_* settings in the multimodal input sample README #9757

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

Closed
NingLin Liu (ninglinLiu) wants to merge 1 commit into from
+6 −9
Closed

Python: list FOUNDRY_* settings in the multimodal input sample README #9757

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
11 changes: 4 additions & 7 deletions python/samples/02-agents/multimodal_input/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,12 @@ Set the following environment variables before running the examples:
**For OpenAI:**
- `OPENAI_API_KEY`: Your OpenAI API key

**For Azure OpenAI:**
**For the Azure samples (`azure_chat_multimodal.py` and `azure_responses_multimodal.py`, which use `FoundryChatClient`):**

- `AZURE_OPENAI_ENDPOINT`: Your Azure OpenAI endpoint
- `AZURE_OPENAI_MODEL`: The name of your Azure OpenAI chat model deployment
- `AZURE_OPENAI_MODEL`: The name of your Azure OpenAI responses model deployment
- `FOUNDRY_PROJECT_ENDPOINT`: Your Microsoft Foundry project endpoint
- `FOUNDRY_MODEL`: The name of your model deployment

Optionally for Azure OpenAI:
- `AZURE_OPENAI_API_VERSION`: The API version to use (default is `2024-10-21`)
- `AZURE_OPENAI_API_KEY`: Your Azure OpenAI API key (if not using `AzureCliCredential`)
These samples authenticate with `AzureCliCredential`, so run `az login` first.

**Note:** You can also provide configuration directly in code instead of using environment variables:
```python
Expand Down
2 changes: 1 addition & 1 deletion python/samples/02-agents/multimodal_input/azure_chat_multimodal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def create_sample_image() -> str:
async def test_image() -> None:
"""Test image analysis with Azure OpenAI."""
# For authentication, run `az login` command in terminal or replace AzureCliCredential with preferred
# authentication option. Requires AZURE_OPENAI_ENDPOINT and FOUNDRY_MODEL
# authentication option. Requires FOUNDRY_PROJECT_ENDPOINT and FOUNDRY_MODEL
# environment variables to be set.
# Alternatively, you can pass model explicitly:
# client = FoundryChatClient(credential=AzureCliCredential(), model="your-deployment-name")
Expand Down
2 changes: 1 addition & 1 deletion python/samples/02-agents/multimodal_input/azure_responses_multimodal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def create_sample_image() -> str:
async def test_image() -> None:
"""Test image analysis with Azure OpenAI Responses API."""
# For authentication, run `az login` command in terminal or replace AzureCliCredential with preferred
# authentication option. Requires AZURE_OPENAI_ENDPOINT and FOUNDRY_MODEL
# authentication option. Requires FOUNDRY_PROJECT_ENDPOINT and FOUNDRY_MODEL
# environment variables to be set.
# Alternatively, you can pass model explicitly:
# client = FoundryChatClient(credential=AzureCliCredential(), model="your-deployment-name")
Expand Down
Loading