Skip to content

Commit ca06ef3

Browse files
committed
add comments
1 parent 8424e28 commit ca06ef3

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

articles/ai-foundry/how-to/develop/sdk-overview.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ The Azure AI Foundry SDK is a set of client libraries and services designed to w
4141

4242
## Unified Projects client library
4343

44+
The following examples show how to connect to your Azure AI Foundry project using different programming languages. This connection is the first step to accessing models, data, and AI services through the SDK. Each code block demonstrates how to authenticate and create a client for your project endpoint.
45+
46+
> [!TIP]
47+
> The code samples below are starting points. You’ll use these clients to interact with models, run evaluations, and more, as described in the client libraries section below.
4448

4549

4650
::: zone pivot="programming-language-python"
@@ -62,6 +66,7 @@ The [Azure AI Foundry Projects client library for Python](/python/api/overview/a
6266
project = AIProjectClient(
6367
endpoint="your_project_endpoint", # Replace with your endpoint
6468
credential=DefaultAzureCredential())
69+
# The AIProjectClient lets you access models, data, and services in your project.
6570
```
6671
::: zone-end
6772

@@ -88,6 +93,7 @@ The [Azure AI Foundry Projects client library for Java (preview)](/java/api/over
8893
.credential(new DefaultAzureCredential())
8994
.endpoint(endpoint)
9095
.buildClient();
96+
// The ProjectsClient enables unified access to your project's resources.
9197
```
9298
9399
@@ -113,6 +119,7 @@ The [Azure AI Foundry Projects client library for JavaScript](/javascript/api/ov
113119
114120
const endpoint = "your_project_endpoint"; // Replace with your actual endpoint
115121
const project = new AIProjectClient(endpoint, new DefaultAzureCredential());
122+
// The AIProjectClient lets you access models, data, and services in your project.
116123
```
117124
118125
@@ -147,17 +154,20 @@ The [Azure AI Foundry Projects client library for .NET](/dotnet/api/overview/azu
147154
credential,
148155
new string[] { "https://cognitiveservices.azure.com/.default" }
149156
);
157+
// The PerRetry position ensures the authentication policy is applied to every retry attempt.
158+
// This is important for robust authentication in distributed/cloud environments.
150159
clientOptions.AddPolicy(tokenPolicy, HttpPipelinePosition.PerRetry);
151160
152161
var projectClient = new ChatCompletionsClient(
153162
endpointUrl,
154163
credential,
155164
clientOptions
156165
);
166+
// The ChatCompletionsClient lets you interact with models and services in your project.
157167
```
158168
159169
::: zone-end
160-
170+
After you create a client, you can use it to access models, run evaluations, and connect to other AI services. The next section lists the available client libraries and shows how to use them for specific Azure AI services.
161171
<a name="azure-ai-foundry-agent-service"></a>
162172
* Using the project endpoint, you can:
163173
- [Use Foundry Model](../../quickstarts/get-started-code.md), including Azure OpenAI

0 commit comments

Comments
 (0)