Azure AI Projects Java

1---
2name: azure-ai-projects-java
3description: |
4  Azure AI Projects SDK for Java. High-level SDK for Azure AI Foundry project management including connections, datasets, indexes, and evaluations.
5  Triggers: "AIProjectClient java", "azure ai projects java", "Foundry project java", "ConnectionsClient", "DatasetsClient", "IndexesClient".
6package: com.azure:azure-ai-projects
7---
8 
9# Azure AI Projects SDK for Java
10 
11High-level SDK for Azure AI Foundry project management with access to connections, datasets, indexes, and evaluations.
12 
13## Installation
14 
15```xml
16<dependency>
17    <groupId>com.azure</groupId>
18    <artifactId>azure-ai-projects</artifactId>
19    <version>1.0.0-beta.1</version>
20</dependency>
21```
22 
23## Environment Variables
24 
25```bash
26PROJECT_ENDPOINT=https://<resource>.services.ai.azure.com/api/projects/<project>
27```
28 
29## Authentication
30 
31```java
32import com.azure.ai.projects.AIProjectClientBuilder;
33import com.azure.identity.DefaultAzureCredentialBuilder;
34 
35AIProjectClientBuilder builder = new AIProjectClientBuilder()
36    .endpoint(System.getenv("PROJECT_ENDPOINT"))
37    .credential(new DefaultAzureCredentialBuilder().build());
38```
39 
40## Client Hierarchy
41 
42The SDK provides multiple sub-clients for different operations:
43 
44| Client | Purpose |
45|--------|---------|
46| `ConnectionsClient` | Enumerate connected Azure resources |
47| `DatasetsClient` | Upload documents and manage datasets |
48| `DeploymentsClient` | Enumerate AI model deployments |
49| `IndexesClient` | Create and manage search indexes |
50| `EvaluationsClient` | Run AI model evaluations |
51| `EvaluatorsClient` | Manage evaluator configurations |
52| `SchedulesClient` | Manage scheduled operations |
53 
54```java
55// Build sub-clients from builder
56ConnectionsClient connectionsClient = builder.buildConnectionsClient();
57DatasetsClient datasetsClient = builder.buildDatasetsClient();
58DeploymentsClient deploymentsClient = builder.buildDeploymentsClient();
59IndexesClient indexesClient = builder.buildIndexesClient();
60EvaluationsClient evaluationsClient = builder.buildEvaluationsClient();
61```
62 
63## Core Operations
64 
65### List Connections
66 
67```java
68import com.azure.ai.projects.models.Connection;
69import com.azure.core.http.rest.PagedIterable;
70 
71PagedIterable<Connection> connections = connectionsClient.listConnections();
72for (Connection connection : connections) {
73    System.out.println("Name: " + connection.getName());
74    System.out.println("Type: " + connection.getType());
75    System.out.println("Credential Type: " + connection.getCredentials().getType());
76}
77```
78 
79### List Indexes
80 
81```java
82indexesClient.listLatest().forEach(index -> {
83    System.out.println("Index name: " + index.getName());
84    System.out.println("Version: " + index.getVersion());
85    System.out.println("Description: " + index.getDescription());
86});
87```
88 
89### Create or Update Index
90 
91```java
92import com.azure.ai.projects.models.AzureAISearchIndex;
93import com.azure.ai.projects.models.Index;
94 
95String indexName = "my-index";
96String indexVersion = "1.0";
97String searchConnectionName = System.getenv("AI_SEARCH_CONNECTION_NAME");
98String searchIndexName = System.getenv("AI_SEARCH_INDEX_NAME");
99 
100Index index = indexesClient.createOrUpdate(
101    indexName,
102    indexVersion,
103    new AzureAISearchIndex()
104        .setConnectionName(searchConnectionName)
105        .setIndexName(searchIndexName)
106);
107 
108System.out.println("Created index: " + index.getName());
109```
110 
111### Access OpenAI Evaluations
112 
113The SDK exposes OpenAI's official SDK for evaluations:
114 
115```java
116import com.openai.services.EvalService;
117 
118EvalService evalService = evaluationsClient.getOpenAIClient();
119// Use OpenAI evaluation APIs directly
120```
121 
122## Best Practices
123 
1241. **Use DefaultAzureCredential** for production authentication
1252. **Reuse client builder** to create multiple sub-clients efficiently
1263. **Handle pagination** when listing resources with `PagedIterable`
1274. **Use environment variables** for connection names and configuration
1285. **Check connection types** before accessing credentials
129 
130## Error Handling
131 
132```java
133import com.azure.core.exception.HttpResponseException;
134import com.azure.core.exception.ResourceNotFoundException;
135 
136try {
137    Index index = indexesClient.get(indexName, version);
138} catch (ResourceNotFoundException e) {
139    System.err.println("Index not found: " + indexName);
140} catch (HttpResponseException e) {
141    System.err.println("Error: " + e.getResponse().getStatusCode());
142}
143```
144 
145## Reference Links
146 
147| Resource | URL |
148|----------|-----|
149| Product Docs | https://learn.microsoft.com/azure/ai-studio/ |
150| API Reference | https://learn.microsoft.com/rest/api/aifoundry/aiprojects/ |
151| GitHub Source | https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/ai/azure-ai-projects |
152| Samples | https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/ai/azure-ai-projects/src/samples |
153