Skip to content

Commit e7d9490

Browse files
authored
Fix Projects SDK README.md, to mention the correct env variables used in the code snippet below (#42496)
1 parent 29b3fd6 commit e7d9490

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

sdk/ai/azure-ai-projects/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,10 +91,7 @@ project_client = AIProjectClient(
9191

9292
The `.agents` property on the `AIProjectsClient` gives you access to an authenticated `AgentsClient` from the `azure-ai-agents` package. Below we show how to create an Agent and delete it. To see what you can do with the Agent you created, see the [many samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ai/azure-ai-agents/samples) and the [README.md](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/ai/azure-ai-agents) file of the dependent `azure-ai-agents` package.
9393

94-
The code below assumes the following:
95-
96-
* `model_deployment_name` (a string) is defined. It's the deployment name of an AI model in your Foundry Project, as shown in the "Models + endpoints" tab, under the "Name" column.
97-
* `connection_name` (a string) is defined. It's the name of the connection to a resource of type "Azure OpenAI", as shown in the "Connected resources" tab, under the "Name" column, in the "Management Center" of your Foundry Project.
94+
The code below assumes `model_deployment_name` (a string) is defined. It's the deployment name of an AI model in your Foundry Project, as shown in the "Models + endpoints" tab, under the "Name" column.
9895

9996
<!-- SNIPPET:sample_agents.agents_sample -->
10097

@@ -122,8 +119,11 @@ These could be OpenAI models, Microsoft models, or models from other providers.
122119
Use the code below to get an authenticated [AzureOpenAI](https://github.com/openai/openai-python?tab=readme-ov-file#microsoft-azure-openai)
123120
from the [openai](https://pypi.org/project/openai/) package, and execute a chat completions or responses calls.
124121

125-
The code below assumes `model_deployment_name` (a string) is defined. It's the deployment name of an AI model in your
122+
The code below assumes the following:
123+
124+
* `model_deployment_name` (a string) is defined. It's the deployment name of an AI model in your
126125
Foundry Project, or a connected Azure OpenAI resource. As shown in the "Models + endpoints" tab, under the "Name" column.
126+
* `connection_name` (a string) is defined. It's the name of the connection to a resource of type "Azure OpenAI", as shown in the "Connected resources" tab, under the "Name" column, in the "Management Center" of your Foundry Project.
127127

128128
Update the `api_version` value with one found in the "Data plane - inference" row [in this table](https://learn.microsoft.com/azure/ai-foundry/openai/reference#api-specs).
129129

0 commit comments

Comments
 (0)