GitHub Copilot ChatGPT Claude Codex CLI Cursor opencode Skill Text

azure-ai-projects-java

Azure AI Projects SDK for Java. High-level SDK for Azure AI Foundry project management including connections, datasets, indexes, and evaluations. Triggers: "AIProjectClient java", "azure ai projects java", "Foundry project java", "ConnectionsClient", "DatasetsClient", "IndexesCli

Ciza · 0 points · 25 views 0 listing impressions 0 install-command copies
Download microsoft-skills-.github_plugins_azure-sdk-java_skills_azure-ai-projects-java-e58528d.zip · 4 KB

Install

skills CLI npx skills add https://github.com/microsoft/skills/tree/main/.github/plugins/azure-sdk-java/skills/azure-ai-projects-java
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install microsoft-skills@llmmart
Git git clone https://github.com/microsoft/skills.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole microsoft/skills collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

Azure AI Projects SDK for Java

High-level SDK for Azure AI Foundry project management with access to connections, datasets, indexes, and evaluations.

Installation

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-ai-projects</artifactId>
    <version>1.0.0-beta.1</version>
</dependency>

Environment Variables

PROJECT_ENDPOINT=https://<resource>.services.ai.azure.com/api/projects/<project> # Required for project configuration
AZURE_TOKEN_CREDENTIALS=prod  # Required only if DefaultAzureCredential is used in production

Authentication

import com.azure.ai.projects.AIProjectClientBuilder;
import com.azure.core.credential.TokenCredential;
import com.azure.identity.AzureIdentityEnvVars;
import com.azure.identity.DefaultAzureCredentialBuilder;
import com.azure.identity.ManagedIdentityCredentialBuilder;

TokenCredential credential = new DefaultAzureCredentialBuilder()
    .requireEnvVars(AzureIdentityEnvVars.AZURE_TOKEN_CREDENTIALS)
    .build();
// Or use a specific credential directly in production:
// See https://learn.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable#credential-classes
// TokenCredential credential = new ManagedIdentityCredentialBuilder().build();

AIProjectClientBuilder builder = new AIProjectClientBuilder()
    .endpoint(System.getenv("PROJECT_ENDPOINT"))
    .credential(credential);

Client Hierarchy

The SDK provides multiple sub-clients for different operations:

Client Purpose
ConnectionsClient Enumerate connected Azure resources
DatasetsClient Upload documents and manage datasets
DeploymentsClient Enumerate AI model deployments
IndexesClient Create and manage search indexes
EvaluationsClient Run AI model evaluations
EvaluatorsClient Manage evaluator configurations
SchedulesClient Manage scheduled operations
// Build sub-clients from builder
ConnectionsClient connectionsClient = builder.buildConnectionsClient();
DatasetsClient datasetsClient = builder.buildDatasetsClient();
DeploymentsClient deploymentsClient = builder.buildDeploymentsClient();
IndexesClient indexesClient = builder.buildIndexesClient();
EvaluationsClient evaluationsClient = builder.buildEvaluationsClient();

Core Operations

List Connections

import com.azure.ai.projects.models.Connection;
import com.azure.core.http.rest.PagedIterable;

PagedIterable<Connection> connections = connectionsClient.listConnections();
for (Connection connection : connections) {
    System.out.println("Name: " + connection.getName());
    System.out.println("Type: " + connection.getType());
    System.out.println("Credential Type: " + connection.getCredentials().getType());
}

List Indexes

indexesClient.listLatest().forEach(index -> {
    System.out.println("Index name: " + index.getName());
    System.out.println("Version: " + index.getVersion());
    System.out.println("Description: " + index.getDescription());
});

Create or Update Index

import com.azure.ai.projects.models.AzureAISearchIndex;
import com.azure.ai.projects.models.Index;

String indexName = "my-index";
String indexVersion = "1.0";
String searchConnectionName = System.getenv("AI_SEARCH_CONNECTION_NAME");
String searchIndexName = System.getenv("AI_SEARCH_INDEX_NAME");

Index index = indexesClient.createOrUpdate(
    indexName,
    indexVersion,
    new AzureAISearchIndex()
        .setConnectionName(searchConnectionName)
        .setIndexName(searchIndexName)
);

System.out.println("Created index: " + index.getName());

Access OpenAI Evaluations

The SDK exposes OpenAI's official SDK for evaluations:

import com.openai.services.EvalService;

EvalService evalService = evaluationsClient.getOpenAIClient();
// Use OpenAI evaluation APIs directly

Best Practices

  1. Use DefaultAzureCredential for production authentication
  2. Reuse client builder to create multiple sub-clients efficiently
  3. Handle pagination when listing resources with PagedIterable
  4. Use environment variables for connection names and configuration
  5. Check connection types before accessing credentials

Error Handling

import com.azure.core.exception.HttpResponseException;
import com.azure.core.exception.ResourceNotFoundException;

try {
    Index index = indexesClient.get(indexName, version);
} catch (ResourceNotFoundException e) {
    System.err.println("Index not found: " + indexName);
} catch (HttpResponseException e) {
    System.err.println("Error: " + e.getResponse().getStatusCode());
}

Reference Links

Resource URL
Product Docs https://learn.microsoft.com/azure/ai-studio/
API Reference https://learn.microsoft.com/rest/api/aifoundry/aiprojects/
GitHub Source https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/ai/azure-ai-projects
Samples https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/ai/azure-ai-projects/src/samples
Files (skills)
  • references
    • examples.md 11.8 KB
      Loading…
  • SKILL.md 5.4 KB
    ---
    name: azure-ai-projects-java
    description: |
      Azure AI Projects SDK for Java. High-level SDK for Azure AI Foundry project management including connections, datasets, indexes, and evaluations.
      Triggers: "AIProjectClient java", "azure ai projects java", "Foundry project java", "ConnectionsClient", "DatasetsClient", "IndexesClient".
    license: MIT
    metadata:
      author: Microsoft
      version: "1.0.0"
      package: com.azure:azure-ai-projects
    ---
    
    # Azure AI Projects SDK for Java
    
    High-level SDK for Azure AI Foundry project management with access to connections, datasets, indexes, and evaluations.
    
    ## Installation
    
    ```xml
    <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-ai-projects</artifactId>
        <version>1.0.0-beta.1</version>
    </dependency>
    ```
    
    ## Environment Variables
    
    ```bash
    PROJECT_ENDPOINT=https://<resource>.services.ai.azure.com/api/projects/<project> # Required for project configuration
    AZURE_TOKEN_CREDENTIALS=prod  # Required only if DefaultAzureCredential is used in production
    ```
    
    ## Authentication
    
    ```java
    import com.azure.ai.projects.AIProjectClientBuilder;
    import com.azure.core.credential.TokenCredential;
    import com.azure.identity.AzureIdentityEnvVars;
    import com.azure.identity.DefaultAzureCredentialBuilder;
    import com.azure.identity.ManagedIdentityCredentialBuilder;
    
    TokenCredential credential = new DefaultAzureCredentialBuilder()
        .requireEnvVars(AzureIdentityEnvVars.AZURE_TOKEN_CREDENTIALS)
        .build();
    // Or use a specific credential directly in production:
    // See https://learn.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable#credential-classes
    // TokenCredential credential = new ManagedIdentityCredentialBuilder().build();
    
    AIProjectClientBuilder builder = new AIProjectClientBuilder()
        .endpoint(System.getenv("PROJECT_ENDPOINT"))
        .credential(credential);
    ```
    
    ## Client Hierarchy
    
    The SDK provides multiple sub-clients for different operations:
    
    | Client | Purpose |
    |--------|---------|
    | `ConnectionsClient` | Enumerate connected Azure resources |
    | `DatasetsClient` | Upload documents and manage datasets |
    | `DeploymentsClient` | Enumerate AI model deployments |
    | `IndexesClient` | Create and manage search indexes |
    | `EvaluationsClient` | Run AI model evaluations |
    | `EvaluatorsClient` | Manage evaluator configurations |
    | `SchedulesClient` | Manage scheduled operations |
    
    ```java
    // Build sub-clients from builder
    ConnectionsClient connectionsClient = builder.buildConnectionsClient();
    DatasetsClient datasetsClient = builder.buildDatasetsClient();
    DeploymentsClient deploymentsClient = builder.buildDeploymentsClient();
    IndexesClient indexesClient = builder.buildIndexesClient();
    EvaluationsClient evaluationsClient = builder.buildEvaluationsClient();
    ```
    
    ## Core Operations
    
    ### List Connections
    
    ```java
    import com.azure.ai.projects.models.Connection;
    import com.azure.core.http.rest.PagedIterable;
    
    PagedIterable<Connection> connections = connectionsClient.listConnections();
    for (Connection connection : connections) {
        System.out.println("Name: " + connection.getName());
        System.out.println("Type: " + connection.getType());
        System.out.println("Credential Type: " + connection.getCredentials().getType());
    }
    ```
    
    ### List Indexes
    
    ```java
    indexesClient.listLatest().forEach(index -> {
        System.out.println("Index name: " + index.getName());
        System.out.println("Version: " + index.getVersion());
        System.out.println("Description: " + index.getDescription());
    });
    ```
    
    ### Create or Update Index
    
    ```java
    import com.azure.ai.projects.models.AzureAISearchIndex;
    import com.azure.ai.projects.models.Index;
    
    String indexName = "my-index";
    String indexVersion = "1.0";
    String searchConnectionName = System.getenv("AI_SEARCH_CONNECTION_NAME");
    String searchIndexName = System.getenv("AI_SEARCH_INDEX_NAME");
    
    Index index = indexesClient.createOrUpdate(
        indexName,
        indexVersion,
        new AzureAISearchIndex()
            .setConnectionName(searchConnectionName)
            .setIndexName(searchIndexName)
    );
    
    System.out.println("Created index: " + index.getName());
    ```
    
    ### Access OpenAI Evaluations
    
    The SDK exposes OpenAI's official SDK for evaluations:
    
    ```java
    import com.openai.services.EvalService;
    
    EvalService evalService = evaluationsClient.getOpenAIClient();
    // Use OpenAI evaluation APIs directly
    ```
    
    ## Best Practices
    
    1. **Use DefaultAzureCredential** for production authentication
    2. **Reuse client builder** to create multiple sub-clients efficiently
    3. **Handle pagination** when listing resources with `PagedIterable`
    4. **Use environment variables** for connection names and configuration
    5. **Check connection types** before accessing credentials
    
    ## Error Handling
    
    ```java
    import com.azure.core.exception.HttpResponseException;
    import com.azure.core.exception.ResourceNotFoundException;
    
    try {
        Index index = indexesClient.get(indexName, version);
    } catch (ResourceNotFoundException e) {
        System.err.println("Index not found: " + indexName);
    } catch (HttpResponseException e) {
        System.err.println("Error: " + e.getResponse().getStatusCode());
    }
    ```
    
    ## Reference Links
    
    | Resource | URL |
    |----------|-----|
    | Product Docs | https://learn.microsoft.com/azure/ai-studio/ |
    | API Reference | https://learn.microsoft.com/rest/api/aifoundry/aiprojects/ |
    | GitHub Source | https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/ai/azure-ai-projects |
    | Samples | https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/ai/azure-ai-projects/src/samples |
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.