Inicio rápido de Microsoft Foundry

Note

Este documento hace referencia al portal de Microsoft Foundry (clásico).

🔄 Cambie a la documentación de Microsoft Foundry (nueva) si usa el nuevo portal.

En este inicio rápido, usará Microsoft Foundry para:

• Creación de un proyecto
• Implementar un modelo
• Ejecución de una finalización de chat
• Creación y ejecución de un agente
• Carga de archivos en el agente

El SDK de Microsoft Foundry está disponible en varios lenguajes, como Python, Java, TypeScript y C#. En este inicio rápido se proporcionan instrucciones para cada uno de estos idiomas.

Tip

El resto de este artículo muestra cómo crear y usar un proyecto Foundry. Revise Inicio rápido: Introducción a Microsoft Foundry (proyectos de Hub) si quiere usar un proyecto basado en Hub como alternativa. ¿Qué tipo de proyecto necesito?

Prerequisites

• Una cuenta de Azure con una suscripción activa. Si no tiene una, cree una cuenta gratuita de Azure, que incluye una suscripción de evaluación gratuita.
• Debe ser Propietario de la suscripción para obtener el control de acceso adecuado necesario para usar el proyecto.
• Instale los entornos de ejecución de lenguaje necesarios, las herramientas globales y las extensiones de VS Code, tal como se describe en Preparación del entorno de desarrollo.

Important

Antes de empezar, asegúrese de que el entorno de desarrollo esté listo.
Este inicio rápido se centra en pasos específicos del escenario , como la instalación del SDK, la autenticación y la ejecución de código de ejemplo.

Crear recursos

En el portal, puede explorar un amplio catálogo de modelos de vanguardia de muchos proveedores diferentes. Para este tutorial, busque y seleccione el modelo gpt-4o .

1. Inicie sesión en Microsoft Foundry. Asegúrese de que el conmutador New Foundry está desactivado. Estos pasos hacen referencia a Foundry (clásico).

   

2. Si está en un proyecto, seleccione Microsoft Foundry en la ruta de navegación superior izquierda para dejar el proyecto. Tú vas a crear uno nuevo en un momento.

3. En la página de inicio o el catálogo de modelos, seleccione gpt-4o (o gpt-4o-mini).

   

4. Seleccione Usar este modelo. Cuando se le solicite, escriba un nuevo nombre de proyecto y seleccione Crear.

5. Revise el nombre de la implementación y seleccione Crear.

6. A continuación, seleccione Conectar e implementar después de seleccionar un tipo de implementación.

7. Seleccione Abrir en el área de juegos en la página de implementación después de implementarla.

8. Llegará al área de juegos de chat con el modelo implementado previamente y listo para su uso.

Si estás construyendo un agente, puede empezar con Crear un agente. Los pasos son similares, pero en un orden diferente. Una vez creado el proyecto, llegará al entorno del agente en lugar del entorno del chat.

Ahora que tiene un agente, puede interactuar con él en el código o en el portal.

Prepárese para programar

Tip

El código usa la API de proyectos foundry (clásico) y no es compatible con la API de proyectos foundry (nuevo) (versión preliminar). Cambie a la documentación de Foundry (nuevo) para la versión (preliminar) de la API de proyectos de Foundry (nueva).

Python

1. Instale estos paquetes:

   pip install openai azure-identity azure-ai-projects==1.0.0
   

2. Microsoft Foundry Models permite a los clientes consumir los modelos más eficaces de los proveedores de modelos insignia mediante un único punto de conexión y credenciales. Esto significa que puede cambiar entre modelos y consumirlos desde la aplicación sin cambiar una sola línea de código.

   Copie el punto de conexión del proyecto Foundry en la sección Información general del proyecto. Lo usarás en un momento.

   

   Tip

   Si no ve el punto de conexión del proyecto Foundry, está usando un proyecto basado en hub. (Vea Tipos de proyectos). Cambie a un proyecto Foundry, o use los pasos anteriores para crear uno.

3. Asegúrese de iniciar sesión con el comando de la CLI az login (o az login --use-device-code) para autenticarse antes de ejecutar los scripts de Python.

Siga estos pasos a continuación o obtenga el código:

Obtención del código

C#

1. Instale los paquetes:

   Para trabajar con las herramientas de Foundry en su proyecto .NET, necesitará instalar varios paquetes NuGet. Agregue paquetes NuGet mediante la CLI de .NET en el terminal integrado:

   # Add Azure AI SDK packages
   dotnet add package Azure.Identity
   dotnet add package Azure.AI.Projects 
   dotnet add package Azure.AI.Agents.Persistent
   dotnet add package Azure.AI.Inference
   

2. Microsoft Foundry Models permite a los clientes consumir los modelos más eficaces de los proveedores de modelos insignia mediante un único punto de conexión y credenciales. Esto significa que puede cambiar entre modelos y consumirlos desde la aplicación sin cambiar una sola línea de código.

   Copie el punto de conexión del proyecto Foundry en la sección Información general del proyecto. Lo usarás en un momento.

   

   Tip

   Si no ve el punto de conexión del proyecto Foundry, está usando un proyecto basado en hub. (Vea Tipos de proyectos). Cambie a un proyecto Foundry, o use los pasos anteriores para crear uno.

3. Establezca estas variables de entorno para usarlas en los scripts. AZURE_AI_ENDPOINT es el punto de conexión del proyecto que has copiado anteriormente. Quite todo después de .com/ en ese punto de conexión para formar AZURE_AI_INFERENCE.

   AZURE_AI_ENDPOINT=https://your.services.ai.azure.com/api/projects/project
   AZURE_AI_INFERENCE=https://your.services.ai.azure.com/
   AZURE_AI_MODEL=your_model_name
   

   Tip

   Los ejemplos de agente requieren que la AZURE_AI_MODEL variable de entorno se establezca en un modelo compatible con OpenAI, por ejemplo gpt-4.1, , ya que no se admiten todos los modelos para casos de uso del agente, incluidas las herramientas.

4. Asegúrese de iniciar sesión con el comando de la CLI az login (o az login --use-device-code) para autenticarse antes de ejecutar los scripts de C#.

Siga estos pasos a continuación o obtenga el código:

Obtención del código

TypeScript

1. Asegúrese de iniciar sesión con el comando de la CLI az login (o az login --use-device-code) para autenticarse antes de ejecutar los scripts de TypeScript.

2. Descargue package.json.

3. Instalación de paquetes con npm install

4. Microsoft Foundry Models permite a los clientes consumir los modelos más eficaces de los proveedores de modelos insignia mediante un único punto de conexión y credenciales. Esto significa que puede cambiar entre modelos y consumirlos desde la aplicación sin cambiar una sola línea de código.

   Copie el punto de conexión del proyecto Foundry en la sección Información general del proyecto. Lo usarás en un momento.

   

   Tip

   Si no ve el punto de conexión del proyecto Foundry, está usando un proyecto basado en hub. (Vea Tipos de proyectos). Cambie a un proyecto Foundry, o use los pasos anteriores para crear uno.

5. Establezca estas variables de entorno para usarlas en los scripts:

   MODEL_DEPLOYMENT_NAME=gpt-4o
   PROJECT_ENDPOINT=https://<your-foundry-resource-name>.services.ai.azure.com/api/projects/<your-foundry-project-name>
   

Siga estos pasos a continuación o obtenga el código:

Obtención del código

Java

Important

El código de este artículo usa paquetes que se encuentran actualmente en versión preliminar. Esta versión preliminar se ofrece sin acuerdo de nivel de servicio y no se recomienda para las cargas de trabajo de producción. Es posible que algunas características no sean compatibles o que tengan sus funcionalidades limitadas. Para más información, consulte Términos de uso complementarios para las versiones preliminares de Microsoft Azure.

1. Microsoft Foundry Models permite a los clientes consumir los modelos más eficaces de los proveedores de modelos insignia mediante un único punto de conexión y credenciales. Esto significa que puede cambiar entre modelos y consumirlos desde la aplicación sin cambiar una sola línea de código.

   Copie el punto de conexión del proyecto Foundry en la sección Información general del proyecto. Lo usarás en un momento.

   

   Tip

   Si no ve el punto de conexión del proyecto Foundry, está usando un proyecto basado en hub. (Vea Tipos de proyectos). Cambie a un proyecto Foundry, o use los pasos anteriores para crear uno.

2. Establezca estas variables de entorno para usarlas en los scripts:

   MODEL_DEPLOYMENT_NAME=gpt-4o
   PROJECT_ENDPOINT=https://<your-foundry-resource-name>.services.ai.azure.com/api/projects/<your-foundry-project-name>
   

3. Asegúrese de iniciar sesión con el comando de la CLI az login (o az login --use-device-code) para autenticarse antes de ejecutar los scripts de Java.

4. Descargue POM.XML en el IDE de Java.

Siga estos pasos a continuación o obtenga el código:

Obtención del código

REST API

1. Asegúrese de iniciar sesión con el comando de la CLI az login (o az login --use-device-code) para autenticarse antes de ejecutar el comando siguiente.

2. Obtenga un token de acceso temporal. Expirará en 60-90 minutos, necesitará actualizarlo después de eso.

   az account get-access-token --scope https://ai.azure.com/.default
   

3. Guarde los resultados como la variable AZURE_AI_AUTH_TOKENde entorno .

Siga estos pasos a continuación o obtenga el código:

Obtenga el código.

Portal de la Fundición

No es necesario realizar ninguna instalación para usar el portal de Foundry.

Chatear con un modelo

Las conversaciones por chat son la piedra angular de las aplicaciones de inteligencia artificial. Con finalizaciones de chat, puede enviar una lista de mensajes y obtener una respuesta del modelo.

Tip

El código usa la API de proyectos foundry (clásico) y no es compatible con la API de proyectos foundry (nuevo) (versión preliminar). Cambie a la documentación de Foundry (nuevo) para la versión (preliminar) de la API de proyectos de Foundry (nueva).

Python

Sustituya su punto de conexión por el endpoint en este código.

from azure.ai.projects import AIProjectClient
from azure.identity import DefaultAzureCredential

project = AIProjectClient(
    endpoint="https://your-foundry-resource-name.ai.azure.com/api/projects/project-name",
    credential=DefaultAzureCredential(),
)

models = project.get_openai_client(api_version="2024-10-21")
response = models.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "system", "content": "You are a helpful writing assistant"},
        {"role": "user", "content": "Write me a poem about flowers"},
    ],
)

print(response.choices[0].message.content)

C#

using System.ClientModel.Primitives;
using Azure.Identity;
using OpenAI;
using OpenAI.Chat;

#pragma warning disable OPENAI001

string projectEndpoint = System.Environment.GetEnvironmentVariable("AZURE_AI_INFERENCE")!;
string modelDeploymentName = System.Environment.GetEnvironmentVariable("AZURE_AI_MODEL")!;

BearerTokenPolicy tokenPolicy = new(
    new DefaultAzureCredential(),
    "https://ai.azure.com/.default");
OpenAIClient openAIClient = new(
    authenticationPolicy: tokenPolicy,
    options: new OpenAIClientOptions()
    {
        Endpoint = new($"{projectEndpoint}/openai/v1"),
    });
ChatClient chatClient = openAIClient.GetChatClient(modelDeploymentName);

ChatCompletion completion = await chatClient.CompleteChatAsync(
    [
        new SystemChatMessage("You are a helpful assistant."),
                    new UserChatMessage("How many feet are in a mile?")
    ]);

Console.WriteLine(completion.Content[0].Text);

TypeScript

// Get the Azure AI endpoint and deployment name from environment variables
const endpoint = process.env.PROJECT_ENDPOINT as string;
const deployment = process.env.MODEL_DEPLOYMENT_NAME || 'gpt-4o';

// Create an Azure OpenAI Client
const project = new AIProjectClient(endpoint, new DefaultAzureCredential());
const client = await project.getAzureOpenAIClient({
    // The API version should match the version of the Azure OpenAI resource
    apiVersion: "2024-12-01-preview"
});

// Create a chat completion
const chatCompletion = await client.chat.completions.create({
    model: deployment,
    messages: [
        { role: "system", content: "You are a helpful writing assistant" },
        { role: "user", content: "Write me a poem about flowers" },
    ],
});
console.log(`\n==================== 🌷 COMPLETIONS POEM ====================\n`);
console.log(chatCompletion.choices[0].message.content);

Java (versión preliminar)

package com.azure.ai.foundry.samples;

import com.azure.ai.inference.ChatCompletionsClient;
import com.azure.ai.inference.ChatCompletionsClientBuilder;
import com.azure.ai.inference.models.ChatCompletions;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.credential.TokenCredential;
import com.azure.core.exception.HttpResponseException;
import com.azure.core.util.logging.ClientLogger;
import com.azure.identity.DefaultAzureCredentialBuilder;

/**
 * Sample demonstrating non-streaming chat completion functionality
 * using the Azure AI Inference SDK, wired to your AOAI project endpoint.
 *
 * Environment variables:
 * - PROJECT_ENDPOINT:          Required. Your Azure AI project endpoint.
 * - AZURE_AI_API_KEY:          Optional. Your API key (falls back to DefaultAzureCredential).
 * - AZURE_MODEL_DEPLOYMENT_NAME: Optional. Model deployment name (default: "phi-4").
 * - AZURE_MODEL_API_PATH:      Optional. API path segment (default: "deployments").
 * - CHAT_PROMPT:               Optional. The prompt to send (uses a default if not provided).
 * 
 * SDK Features Demonstrated:
 * - Using the Azure AI Inference SDK (com.azure:azure-ai-inference:1.0.0-beta.5)
 * - Creating a ChatCompletionsClient with Azure or API key authentication
 * - Configuring endpoint paths for different model deployments
 * - Using the simplified complete() method for quick completions
 * - Accessing response content through strongly-typed objects
 * - Implementing proper error handling for service requests
 * - Choosing between DefaultAzureCredential and AzureKeyCredential
 * 
 */

public class ChatCompletionSample {
    private static final ClientLogger logger = new ClientLogger(ChatCompletionSample.class);

    public static void main(String[] args) {
        // 1) Read and validate the project endpoint
        String projectEndpoint = System.getenv("PROJECT_ENDPOINT");
        if (projectEndpoint == null || projectEndpoint.isBlank()) {
            logger.error("PROJECT_ENDPOINT is required but not set");
            return;
        }

        // 2) Optional auth + model settings
        String apiKey          = System.getenv("AZURE_AI_API_KEY");
        String deploymentName  = System.getenv("AZURE_MODEL_DEPLOYMENT_NAME");
        String apiPath         = System.getenv("AZURE_MODEL_API_PATH");
        String prompt          = System.getenv("CHAT_PROMPT");

        if (deploymentName == null || deploymentName.isBlank()) {
            deploymentName = "phi-4";
            logger.info("No AZURE_MODEL_DEPLOYMENT_NAME provided, using default: {}", deploymentName);
        }
        if (apiPath == null || apiPath.isBlank()) {
            apiPath = "deployments";
            logger.info("No AZURE_MODEL_API_PATH provided, using default: {}", apiPath);
        }
        if (prompt == null || prompt.isBlank()) {
            prompt = "What best practices should I follow when asking an AI model to review Java code?";
            logger.info("No CHAT_PROMPT provided, using default prompt: {}", prompt);
        }

        try {
            // 3) Build the full inference endpoint URL
            String fullEndpoint = projectEndpoint.endsWith("/") 
                ? projectEndpoint 
                : projectEndpoint + "/";
            fullEndpoint += apiPath + "/" + deploymentName;
            logger.info("Using inference endpoint: {}", fullEndpoint);

            // 4) Create the client with key or token credential :contentReference[oaicite:0]{index=0}
            ChatCompletionsClient client;
            if (apiKey != null && !apiKey.isBlank()) {
                logger.info("Authenticating using API key");
                client = new ChatCompletionsClientBuilder()
                    .credential(new AzureKeyCredential(apiKey))
                    .endpoint(fullEndpoint)
                    .buildClient();
            } else {
                logger.info("Authenticating using DefaultAzureCredential");
                TokenCredential credential = new DefaultAzureCredentialBuilder().build();
                client = new ChatCompletionsClientBuilder()
                    .credential(credential)
                    .endpoint(fullEndpoint)
                    .buildClient();
            }

            // 5) Send a simple chat completion request
            logger.info("Sending chat completion request with prompt: {}", prompt);
            ChatCompletions completions = client.complete(prompt);

            // 6) Process the response
            String content = completions.getChoice().getMessage().getContent();
            logger.info("Received response from model");
            System.out.println("\nResponse from AI assistant:\n" + content);
        } catch (HttpResponseException e) {
            // Handle API errors
            int status = e.getResponse().getStatusCode();
            logger.error("Service error {}: {}", status, e.getMessage());
            if (status == 401 || status == 403) {
                logger.error("Authentication failed. Check API key or Azure credentials.");
            } else if (status == 404) {
                logger.error("Deployment not found. Verify deployment name and endpoint.");
            } else if (status == 429) {
                logger.error("Rate limit exceeded. Please retry later.");
            }
        } catch (Exception e) {
            // Handle all other exceptions
            logger.error("Error in chat completion: {}", e.getMessage(), e);
        }
    }
}

REST API

Reemplace YOUR-FOUNDRY-RESOURCE-NAME con sus valores:

curl --request POST --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2024-10-21' \
-h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
-h 'content-type: application/json' \
-d '{
        "messages": [
            {"role": "system", 
            "content": "You are a helpful writing assistant"},
            {"role": "user", 
            "content": "Write me a poem about flowers"}
        ],
        "model": "gpt-4o"
    }'

Portal de la Fundición

1. En el área de juegos de chat, rellene el mensaje y seleccione Enviar.
2. El modelo devuelve una respuesta en el panel Respuesta .

Chatear con un agente

Cree un agente y chate con él.

Tip

El código usa la API de proyectos foundry (clásico) y no es compatible con la API de proyectos foundry (nuevo) (versión preliminar). Cambie a la documentación de Foundry (nuevo) para la versión (preliminar) de la API de proyectos de Foundry (nueva).

Python

Sustituya su punto de conexión por el endpoint en este código.

from azure.ai.projects import AIProjectClient
from azure.identity import DefaultAzureCredential
from azure.ai.agents.models import ListSortOrder, FilePurpose

project = AIProjectClient(
    endpoint="https://your-foundry-resource-name.ai.azure.com/api/projects/project-name",
    credential=DefaultAzureCredential(),
)

agent = project.agents.create_agent(
    model="gpt-4o",
    name="my-agent",
    instructions="You are a helpful writing assistant")

thread = project.agents.threads.create()
message = project.agents.messages.create(
    thread_id=thread.id, 
    role="user", 
    content="Write me a poem about flowers")

run = project.agents.runs.create_and_process(thread_id=thread.id, agent_id=agent.id)
if run.status == "failed":
    # Check if you got "Rate limit is exceeded.", then you want to get more quota
    print(f"Run failed: {run.last_error}")

# Get messages from the thread
messages = project.agents.messages.list(thread_id=thread.id)

# Get the last message from the sender
messages = project.agents.messages.list(thread_id=thread.id, order=ListSortOrder.ASCENDING)
for message in messages:
    if message.run_id == run.id and message.text_messages:
        print(f"{message.role}: {message.text_messages[-1].text.value}")

# Delete the agent once done
project.agents.delete_agent(agent.id)
print("Deleted agent")

C#

using Azure;
using Azure.Identity;
using Azure.AI.Agents.Persistent;

// Creating the Client for agents
var projectEndpoint = System.Environment.GetEnvironmentVariable("AZURE_AI_ENDPOINT");
var modelDeploymentName = System.Environment.GetEnvironmentVariable("AZURE_AI_MODEL");
PersistentAgentsClient client = new(projectEndpoint, new DefaultAzureCredential());

// Create an Agent with toolResources and process Agent run
PersistentAgent agent = client.Administration.CreateAgent(
        model: modelDeploymentName,
        name: "SDK Test Agent - Tutor",
        instructions: "You are a personal electronics tutor. Write and run code to answer questions.",
        tools: new List<ToolDefinition> { new CodeInterpreterToolDefinition() });

// Create thread for communication
PersistentAgentThread thread = client.Threads.CreateThread();

// Create message to thread
PersistentThreadMessage messageResponse = client.Messages.CreateMessage(
    thread.Id,
    MessageRole.User,
    "I need to solve the equation `3x + 11 = 14`. Can you help me?");

// Run the Agent
ThreadRun run = client.Runs.CreateRun(thread, agent);

// Wait for the run to complete
do
{
    Thread.Sleep(TimeSpan.FromMilliseconds(500));
    run = client.Runs.GetRun(thread.Id, run.Id);
}
while (run.Status == RunStatus.Queued
    || run.Status == RunStatus.InProgress);
Pageable<PersistentThreadMessage> messages = client.Messages.GetMessages(
    threadId: thread.Id,
    order: ListSortOrder.Ascending
);
// Print the messages in the thread
WriteMessages(messages);

// Delete the thread and agent after use
client.Threads.DeleteThread(thread.Id);
client.Administration.DeleteAgent(agent.Id);

// Temporary function to use a list of messages in the thread and write them to the console.
static void WriteMessages(IEnumerable<PersistentThreadMessage> messages)
{
    foreach (PersistentThreadMessage threadMessage in messages)
    {
        Console.Write($"{threadMessage.CreatedAt:yyyy-MM-dd HH:mm:ss} - {threadMessage.Role,10}: ");
        foreach (MessageContent contentItem in threadMessage.ContentItems)
        {
            if (contentItem is MessageTextContent textItem)
            {
                Console.Write(textItem.Text);
            }
            else if (contentItem is MessageImageFileContent imageFileItem)
            {
                Console.Write($"<image from ID: {imageFileItem.FileId}");
            }
            Console.WriteLine();
        }
    }
}

TypeScript

const endpoint = process.env.PROJECT_ENDPOINT as string;
const deployment = process.env.MODEL_DEPLOYMENT_NAME || 'gpt-4o';
const client = new AIProjectClient(endpoint, new DefaultAzureCredential());

// Create an Agent
const agent = await client.agents.createAgent(deployment, {
    name: 'my-agent',
    instructions: 'You are a helpful agent'
});
console.log(`\n==================== 🕵️  POEM AGENT ====================`);

// Create a thread and message
const thread = await client.agents.threads.create();
const prompt = 'Write me a poem about flowers';
console.log(`\n---------------- 📝 User Prompt ---------------- \n${prompt}`);
await client.agents.messages.create(thread.id, 'user', prompt);

// Create run
let run = await client.agents.runs.create(thread.id, agent.id);

// Wait for run to complete
console.log(`\n---------------- 🚦 Run Status ----------------`);
while (['queued', 'in_progress', 'requires_action'].includes(run.status)) {
    // Avoid adding a lot of messages to the console
    await new Promise((resolve) => setTimeout(resolve, 1000));
    run = await client.agents.runs.get(thread.id, run.id);
    console.log(`Run status: ${run.status}`);
}

console.log('\n---------------- 📊 Token Usage ----------------');
console.table([run.usage]);

const messagesIterator = await client.agents.messages.list(thread.id);
const assistantMessage = await getAssistantMessage(messagesIterator);
console.log('\n---------------- 💬 Response ----------------');
printAssistantMessage(assistantMessage);

// Clean up
console.log(`\n---------------- 🧹 Clean Up Poem Agent ----------------`);
await client.agents.deleteAgent(agent.id);
console.log(`Deleted Agent, Agent ID: ${agent.id}`);

Java (versión preliminar)

package com.azure.ai.foundry.samples;

import com.azure.ai.agents.persistent.PersistentAgentsClient;
import com.azure.ai.agents.persistent.PersistentAgentsClientBuilder;
import com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient;
import com.azure.ai.agents.persistent.models.CreateAgentOptions;
import com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions;
import com.azure.ai.agents.persistent.models.PersistentAgent;
import com.azure.ai.agents.persistent.models.ThreadRun;
import com.azure.core.credential.TokenCredential;
import com.azure.core.exception.HttpResponseException;
import com.azure.core.util.logging.ClientLogger;
import com.azure.identity.DefaultAzureCredentialBuilder;


/**
 * Sample demonstrating how to work with Azure AI Agents using the Azure AI Agents Persistent SDK.
 * 
 * This sample shows how to:
 * - Set up authentication with Azure credentials
 * - Create a persistent agent with custom instructions
 * - Start a thread and run with the agent
 * - Access various properties of the agent and thread run
 * - Work with the PersistentAgentsClient and PersistentAgentsAdministrationClient
 * 
 * Environment variables:
 * - AZURE_ENDPOINT: Optional fallback. The base endpoint for your Azure AI service if PROJECT_ENDPOINT is not provided.
 * - PROJECT_ENDPOINT: Required. The endpoint for your Azure AI Project.
 * - MODEL_DEPLOYMENT_NAME: Optional. The model deployment name (defaults to "gpt-4o").
 * - AGENT_NAME: Optional. The name to give to the created agent (defaults to "java-quickstart-agent").
 * - AGENT_INSTRUCTIONS: Optional. The instructions for the agent (defaults to a helpful assistant).
 * 
 * Note: This sample requires proper Azure authentication. It uses DefaultAzureCredential which supports
 * multiple authentication methods including environment variables, managed identities, and interactive login.
 * 
 * SDK Features Demonstrated:
 * - Using the Azure AI Agents Persistent SDK (com.azure:azure-ai-agents-persistent:1.0.0-beta.2)
 * - Creating an authenticated client with DefaultAzureCredential
 * - Using the PersistentAgentsClientBuilder pattern for client instantiation
 * - Working with the PersistentAgentsAdministrationClient for agent management
 * - Creating agents with specific configurations (name, model, instructions)
 * - Starting threads and runs for agent conversations
 * - Working with agent state and thread management
 * - Accessing agent and thread run properties
 * - Implementing proper error handling for Azure service interactions
 */
public class AgentSample {
    private static final ClientLogger logger = new ClientLogger(AgentSample.class);

    public static void main(String[] args) {
        // Load environment variables with better error handling, supporting both .env and system environment variables
        String endpoint = System.getenv("AZURE_ENDPOINT");
        String projectEndpoint = System.getenv("PROJECT_ENDPOINT");
        String modelName = System.getenv("MODEL_DEPLOYMENT_NAME");
        String agentName = System.getenv("AGENT_NAME");
        String instructions = System.getenv("AGENT_INSTRUCTIONS");

        

        // Check for required endpoint configuration
        if (projectEndpoint == null && endpoint == null) {
            String errorMessage = "Environment variables not configured. Required: either PROJECT_ENDPOINT or AZURE_ENDPOINT must be set.";
            logger.error("ERROR: {}", errorMessage);
            logger.error("Please set your environment variables or create a .env file. See README.md for details.");
            return;
        }
        
        // Use AZURE_ENDPOINT as fallback if PROJECT_ENDPOINT not set
        if (projectEndpoint == null) {
            projectEndpoint = endpoint;
            logger.info("Using AZURE_ENDPOINT as PROJECT_ENDPOINT: {}", projectEndpoint);
        }

        // Set defaults for optional parameters with informative logging
        if (modelName == null) {
            modelName = "gpt-4o";
            logger.info("No MODEL_DEPLOYMENT_NAME provided, using default: {}", modelName);
        }
        if (agentName == null) {
            agentName = "java-quickstart-agent";
            logger.info("No AGENT_NAME provided, using default: {}", agentName);
        }
        if (instructions == null) {
            instructions = "You are a helpful assistant that provides clear and concise information.";
            logger.info("No AGENT_INSTRUCTIONS provided, using default instructions");
        }

        // Create Azure credential with DefaultAzureCredentialBuilder
        // This supports multiple authentication methods including environment variables,
        // managed identities, and interactive browser login
        logger.info("Building DefaultAzureCredential");
        TokenCredential credential = new DefaultAzureCredentialBuilder().build();

        try {
            // Build the general agents client
            logger.info("Creating PersistentAgentsClient with endpoint: {}", projectEndpoint);
            PersistentAgentsClient agentsClient = new PersistentAgentsClientBuilder()
                .endpoint(projectEndpoint)
                .credential(credential)
                .buildClient();

            // Derive the administration client
            logger.info("Getting PersistentAgentsAdministrationClient");
            PersistentAgentsAdministrationClient adminClient =
                agentsClient.getPersistentAgentsAdministrationClient();

            // Create an agent
            logger.info("Creating agent with name: {}, model: {}", agentName, modelName);
            PersistentAgent agent = adminClient.createAgent(
                new CreateAgentOptions(modelName)
                    .setName(agentName)
                    .setInstructions(instructions)
            );
            logger.info("Agent created: ID={}, Name={}", agent.getId(), agent.getName());
            logger.info("Agent model: {}", agent.getModel());

            // Start a thread/run on the general client
            logger.info("Creating thread and run with agent ID: {}", agent.getId());
            ThreadRun runResult = agentsClient.createThreadAndRun(
                new CreateThreadAndRunOptions(agent.getId())
            );
            logger.info("ThreadRun created: ThreadId={}", runResult.getThreadId());

            // List available getters on ThreadRun for informational purposes
            logger.info("\nAvailable getters on ThreadRun:");
            for (var method : ThreadRun.class.getMethods()) {
                if (method.getName().startsWith("get")) {
                    logger.info(" - {}", method.getName());
                }
            }

            logger.info("\nDemo completed successfully!");
            
        } catch (HttpResponseException e) {
            // Handle service-specific errors with detailed information
            int statusCode = e.getResponse().getStatusCode();
            logger.error("Service error {}: {}", statusCode, e.getMessage());
            logger.error("Refer to the Azure AI Agents documentation for troubleshooting information.");
        } catch (Exception e) {
            // Handle general exceptions
            logger.error("Error in agent sample: {}", e.getMessage(), e);
        }
    }
}

REST API

Reemplace YOUR-FOUNDRY-RESOURCE-NAME y YOUR-PROJECT-NAME por sus valores:

# Create agent
curl --request POST --url "https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/assistants?api-version=v1" \
    -h "authorization: Bearer $AZURE_AI_AUTH_TOKEN" \
    -h "content-type: application/json" \
    -d '{
            "model": "gpt-4o",
            "name": "my-agent",
            "instructions": "You are a helpful writing assistant"
        }'
#Lets say agent ID created is asst_123456789. Use this to run the agent

# Create thread
curl --request POST --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/threads?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
    -h 'content-type: application/json'

#Lets say thread ID created is thread_123456789. Use this in the next step

# Create message using thread ID
curl --request POST --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/threads/thread_123456789/messages?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
    -h 'content-type: application/json' \
    -d '{
            "role": "user",
            "content": "Write me a poem about flowers"
        }'

# Run thread with the agent - use both agent id and thread id
curl --request POST --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/threads/thread_123456789/runs?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
    -h 'content-type: application/json' \
    --data '{
        "assistant_id": "asst_123456789"
    }'

# List the messages in the thread using thread ID
curl --request GET --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/threads/thread_123456789/messages?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
    -h 'content-type: application/json'

# Delete agent once done using agent id
curl --request DELETE --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/assistants/asst_123456789?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
    -h 'content-type: application/json'

Portal de la Fundición

Cuando esté listo para probar un agente, se creará un agente predeterminado para usted automáticamente. Para chatear con este agente:

1. En el panel izquierdo, seleccione Áreas de juegos.
2. En la tarjeta de Área de juegos de agentes, seleccione Vamos.
3. Agregue instrucciones, como "Usted es un asistente de escritura útil".
4. Comience a hablar con su agente, por ejemplo, "Escriba un poema sobre flores".

---

Adición de archivos al agente

Los agentes tienen funcionalidades eficaces mediante el uso de herramientas. Vamos a agregar una herramienta de búsqueda de archivos que nos permita realizar la recuperación de conocimientos.

• Descargue product_info_1.md para darle al agente.

Tip

El código usa la API de proyectos foundry (clásico) y no es compatible con la API de proyectos foundry (nuevo) (versión preliminar). Cambie a la documentación de Foundry (nuevo) para la versión (preliminar) de la API de proyectos de Foundry (nueva).

Python

Sustituya su punto de conexión por el endpoint en este código.

from azure.ai.projects import AIProjectClient
from azure.identity import DefaultAzureCredential
from azure.ai.agents.models import ListSortOrder, FileSearchTool

project = AIProjectClient(
    endpoint="https://your-foundry-resource-name.ai.azure.com/api/projects/project-name",
    credential=DefaultAzureCredential(),
)

# Upload file and create vector store
file = project.agents.files.upload(file_path="./product_info_1.md", purpose=FilePurpose.AGENTS)
vector_store = project.agents.vector_stores.create_and_poll(file_ids=[file.id], name="my_vectorstore")

# Create file search tool and agent
file_search = FileSearchTool(vector_store_ids=[vector_store.id])
agent = project.agents.create_agent(
    model="gpt-4o",
    name="my-assistant",
    instructions="You are a helpful assistant and can search information from uploaded files",
    tools=file_search.definitions,
    tool_resources=file_search.resources,
)

# Create thread and process user message
thread = project.agents.threads.create()
project.agents.messages.create(thread_id=thread.id, role="user", content="Hello, what Contoso products do you know?")
run = project.agents.runs.create_and_process(thread_id=thread.id, agent_id=agent.id)

# Handle run status
if run.status == "failed":
    print(f"Run failed: {run.last_error}")

# Print thread messages
messages = project.agents.messages.list(thread_id=thread.id, order=ListSortOrder.ASCENDING)
for message in messages:
    if message.run_id == run.id and message.text_messages:
        print(f"{message.role}: {message.text_messages[-1].text.value}")

# Cleanup resources
project.agents.vector_stores.delete(vector_store.id)
project.agents.files.delete(file_id=file.id)
project.agents.delete_agent(agent.id)

C#

using Azure;
using Azure.Identity;
using Azure.AI.Agents.Persistent;

// Creating the Client for agents and vector stores
var projectEndpoint = System.Environment.GetEnvironmentVariable("AZURE_AI_ENDPOINT");
var modelDeploymentName = System.Environment.GetEnvironmentVariable("AZURE_AI_MODEL");
PersistentAgentsClient client = new(projectEndpoint, new DefaultAzureCredential());

PersistentAgentFileInfo uploadedAgentFile = client.Files.UploadFile(
    filePath: "product_info_1.md",
    purpose: PersistentAgentFilePurpose.Agents);

// Create a vector store with the file and wait for it to be processed.
// If you do not specify a vector store, create_message will create a vector store with a default expiration policy of seven days after they were last active

Dictionary<string, string> fileIds = new()
{
    { uploadedAgentFile.Id, uploadedAgentFile.Filename }
};

PersistentAgentsVectorStore vectorStore = client.VectorStores.CreateVectorStore(
    name: "my_vector_store");

// Add file ID to vector store.
VectorStoreFile vctFile = client.VectorStores.CreateVectorStoreFile(
    vectorStoreId: vectorStore.Id,
    fileId: uploadedAgentFile.Id
);

Console.WriteLine($"Added file to vector store. The id file in the vector store is {vctFile.Id}.");

FileSearchToolResource fileSearchToolResource = new FileSearchToolResource();
fileSearchToolResource.VectorStoreIds.Add(vectorStore.Id);

// Create an Agent with toolResources and process Agent run
PersistentAgent agent = client.Administration.CreateAgent(
        model: modelDeploymentName,
        name: "SDK Test Agent - Retrieval",
        instructions: "You are a helpful agent that can help fetch data from files you know about.",
        tools: new List<ToolDefinition> { new FileSearchToolDefinition() },
        toolResources: new ToolResources() { FileSearch = fileSearchToolResource });

// Create thread for communication
PersistentAgentThread thread = client.Threads.CreateThread();

// Create message to thread
PersistentThreadMessage messageResponse = client.Messages.CreateMessage(
    thread.Id,
    MessageRole.User,
    "Can you give me information on how to mount the product?");

// Run the Agent
ThreadRun run = client.Runs.CreateRun(thread, agent);

// Wait for the run to complete
// This is a blocking call, so it will wait until the run is completed
do
{
    Thread.Sleep(TimeSpan.FromMilliseconds(500));
    run = client.Runs.GetRun(thread.Id, run.Id);
}
while (run.Status == RunStatus.Queued
    || run.Status == RunStatus.InProgress);

// Create a list of messages in the thread and write them to the console.
Pageable<PersistentThreadMessage> messages = client.Messages.GetMessages(
    threadId: thread.Id,
    order: ListSortOrder.Ascending
);
WriteMessages(messages, fileIds);

// Delete the thread and agent after use
client.VectorStores.DeleteVectorStore(vectorStore.Id);
client.Files.DeleteFile(uploadedAgentFile.Id);
client.Threads.DeleteThread(thread.Id);
client.Administration.DeleteAgent(agent.Id);

// Helper method to write messages to the console
static void WriteMessages(IEnumerable<PersistentThreadMessage> messages, Dictionary<string, string> fileIds)
{
    foreach (PersistentThreadMessage threadMessage in messages)
    {
        Console.Write($"{threadMessage.CreatedAt:yyyy-MM-dd HH:mm:ss} - {threadMessage.Role,10}: ");
        foreach (MessageContent contentItem in threadMessage.ContentItems)
        {
            if (contentItem is MessageTextContent textItem)
            {
                if (threadMessage.Role == MessageRole.Agent && textItem.Annotations.Count > 0)
                {
                    string strMessage = textItem.Text;
                    foreach (MessageTextAnnotation annotation in textItem.Annotations)
                    {
                        if (annotation is MessageTextFilePathAnnotation pathAnnotation)
                        {
                            strMessage = replaceReferences(fileIds, pathAnnotation.FileId, pathAnnotation.Text, strMessage);
                        }
                        else if (annotation is MessageTextFileCitationAnnotation citationAnnotation)
                        {
                            strMessage = replaceReferences(fileIds, citationAnnotation.FileId, citationAnnotation.Text, strMessage);
                        }
                    }
                    Console.Write(strMessage);
                }
                else
                {
                    Console.Write(textItem.Text);
                }
            }
            else if (contentItem is MessageImageFileContent imageFileItem)
            {
                Console.Write($"<image from ID: {imageFileItem.FileId}");
            }
            Console.WriteLine();
        }
    }
}

// Helper method to replace file references in the text
static string replaceReferences(Dictionary<string, string> fileIds, string fileID, string placeholder, string text)
{
    if (fileIds.TryGetValue(fileID, out string replacement))
        return text.Replace(placeholder, $" [{replacement}]");
    else
        return text.Replace(placeholder, $" [{fileID}]");
}

TypeScript

// Upload a file named product_info_1.md
console.log(`\n==================== 🕵️  FILE AGENT ====================`);
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const filePath = path.join(__dirname, '../data/product_info_1.md');
const fileStream = fs.createReadStream(filePath);
fileStream.on('data', (chunk: string | Buffer) => {
    console.log(`Read ${chunk.length} bytes of data.`);
});
const file = await client.agents.files.upload(fileStream, 'assistants', {
    fileName: 'product_info_1.md'
});
console.log(`Uploaded file, ID: ${file.id}`);
const vectorStore = await client.agents.vectorStores.create({
    fileIds: [file.id], // Associate the uploaded file with the vector store
    name: 'my_vectorstore'
});
console.log('\n---------------- 🗃️ Vector Store Info ----------------');
console.table([
    {
        'Vector Store ID': vectorStore.id,
        'Usage (bytes)': vectorStore.usageBytes,
        'File Count': vectorStore.fileCounts?.total ?? 'N/A'
    }
]);

// Create an Agent and a FileSearch tool
const fileSearchTool = ToolUtility.createFileSearchTool([vectorStore.id]);
const fileAgent = await client.agents.createAgent(deployment, {
    name: 'my-file-agent',
    instructions: 'You are a helpful assistant and can search information from uploaded files',
    tools: [fileSearchTool.definition],
    toolResources: fileSearchTool.resources
});

// Create a thread and message
const fileSearchThread = await client.agents.threads.create({ toolResources: fileSearchTool.resources });
const filePrompt = 'What are the steps to setup the TrailMaster X4 Tent?';
console.log(`\n---------------- 📝 User Prompt ---------------- \n${filePrompt}`);
await client.agents.messages.create(fileSearchThread.id, 'user', filePrompt);

// Create run
let fileSearchRun = await client.agents.runs.create(fileSearchThread.id, fileAgent.id).stream();

for await (const eventMessage of fileSearchRun) {
    if (eventMessage.event === DoneEvent.Done) {
        console.log(`Run completed: ${eventMessage.data}`);
    }
    if (eventMessage.event === ErrorEvent.Error) {
        console.log(`An error occurred. ${eventMessage.data}`);
    }
}

const fileSearchMessagesIterator = await client.agents.messages.list(fileSearchThread.id);
const fileAssistantMessage = await getAssistantMessage(fileSearchMessagesIterator);
console.log(`\n---------------- 💬 Response ---------------- \n`);
printAssistantMessage(fileAssistantMessage);

// Clean up
console.log(`\n---------------- 🧹 Clean Up File Agent ----------------`);
client.agents.vectorStores.delete(vectorStore.id);
client.agents.files.delete(file.id);
client.agents.deleteAgent(fileAgent.id);
console.log(`Deleted VectorStore, File, and FileAgent. FileAgent ID: ${fileAgent.id}`);

Java (versión preliminar)

package com.azure.ai.foundry.samples;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;

import com.azure.ai.agents.persistent.PersistentAgentsClient;
import com.azure.ai.agents.persistent.PersistentAgentsClientBuilder;
import com.azure.ai.agents.persistent.PersistentAgentsAdministrationClient;
import com.azure.ai.agents.persistent.models.CreateAgentOptions;
import com.azure.ai.agents.persistent.models.CreateThreadAndRunOptions;
import com.azure.ai.agents.persistent.models.PersistentAgent;
import com.azure.ai.agents.persistent.models.ThreadRun;
import com.azure.core.exception.HttpResponseException;
import com.azure.core.util.logging.ClientLogger;
import com.azure.identity.DefaultAzureCredentialBuilder;

/**
 * Sample demonstrating agent creation with document capabilities using Azure AI Agents Persistent SDK.
 * 
 * This sample shows how to:
 * - Set up authentication with Azure credentials
 * - Create a temporary document file for demonstration purposes
 * - Create a persistent agent with custom instructions for document search
 * - Start a thread and run with the agent that can access document content
 * - Work with file-based knowledge sources for agent interactions
 * 
 * Environment variables:
 * - AZURE_ENDPOINT: Optional fallback. The base endpoint for your Azure AI service if PROJECT_ENDPOINT is not provided.
 * - PROJECT_ENDPOINT: Required. The endpoint for your Azure AI Project.
 * - MODEL_DEPLOYMENT_NAME: Optional. The model deployment name (defaults to "gpt-4o").
 * - AGENT_NAME: Optional. The name to give to the created agent (defaults to "java-file-search-agent").
 * - AGENT_INSTRUCTIONS: Optional. The instructions for the agent (defaults to document-focused instructions).
 * 
 * Note: This sample demonstrates the creation of an agent that can process document content.
 * In a real-world scenario, you might want to integrate with Azure AI Search or similar services
 * for more advanced document processing capabilities.
 * 
 * SDK Features Demonstrated:
 * - Using the Azure AI Agents Persistent SDK (com.azure:azure-ai-agents-persistent:1.0.0-beta.2)
 * - Creating an authenticated client with DefaultAzureCredential
 * - Using the PersistentAgentsClientBuilder for client instantiation 
 * - Working with the PersistentAgentsAdministrationClient for agent management
 * - Creating temporary document files for agent access
 * - Adding document knowledge sources to agents
 * - Creating document-aware agents that can search and reference content
 * - Starting threads and runs for document-based Q&A
 * - Error handling for Azure service and file operations
 */
public class FileSearchAgentSample {
    private static final ClientLogger logger = new ClientLogger(FileSearchAgentSample.class);
    
    public static void main(String[] args) {
        // Load environment variables with proper error handling
        String endpoint = System.getenv("AZURE_ENDPOINT");
        String projectEndpoint = System.getenv("PROJECT_ENDPOINT");
        String modelName = System.getenv("MODEL_DEPLOYMENT_NAME");
        String agentName = System.getenv("AGENT_NAME");
        String instructions = System.getenv("AGENT_INSTRUCTIONS");

        // Check for required endpoint configuration
        if (projectEndpoint == null && endpoint == null) {
            String errorMessage = "Environment variables not configured. Required: either PROJECT_ENDPOINT or AZURE_ENDPOINT must be set.";
            logger.error("ERROR: {}", errorMessage);
            logger.error("Please set your environment variables or create a .env file. See README.md for details.");
            return;
        }
        
        // Set defaults for optional parameters
        if (modelName == null) {
            modelName = "gpt-4o";
            logger.info("No MODEL_DEPLOYMENT_NAME provided, using default: {}", modelName);
        }
        if (agentName == null) {
            agentName = "java-file-search-agent";
            logger.info("No AGENT_NAME provided, using default: {}", agentName);
        }
        if (instructions == null) {
            instructions = "You are a helpful assistant that can answer questions about documents.";
            logger.info("No AGENT_INSTRUCTIONS provided, using default instructions: {}", instructions);
        }

        logger.info("Building DefaultAzureCredential");
        var credential = new DefaultAzureCredentialBuilder().build();

        // Use AZURE_ENDPOINT as fallback if PROJECT_ENDPOINT not set
        String finalEndpoint = projectEndpoint != null ? projectEndpoint : endpoint;
        logger.info("Using endpoint: {}", finalEndpoint);

        try {
            // Build the general agents client with proper error handling
            logger.info("Creating PersistentAgentsClient with endpoint: {}", finalEndpoint);
            PersistentAgentsClient agentsClient = new PersistentAgentsClientBuilder()
                .endpoint(finalEndpoint)
                .credential(credential)
                .buildClient();

            // Derive the administration client
            logger.info("Getting PersistentAgentsAdministrationClient");
            PersistentAgentsAdministrationClient adminClient =
                agentsClient.getPersistentAgentsAdministrationClient();

            // Create sample document for demonstration
            Path tmpFile = createSampleDocument();
            logger.info("Created sample document at: {}", tmpFile);
            String filePreview = Files.readString(tmpFile).substring(0, 200) + "...";
            logger.info("{}", filePreview);

            // Create the agent with proper configuration
            logger.info("Creating agent with name: {}, model: {}", agentName, modelName);
            PersistentAgent agent = adminClient.createAgent(
                new CreateAgentOptions(modelName)
                    .setName(agentName)
                    .setInstructions(instructions)
            );
            logger.info("Agent ID: {}", agent.getId());
            logger.info("Agent model: {}", agent.getModel());

            // Start a thread and run on the general client
            logger.info("Creating thread and run with agent ID: {}", agent.getId());
            ThreadRun threadRun = agentsClient.createThreadAndRun(
                new CreateThreadAndRunOptions(agent.getId())
            );
            logger.info("ThreadRun ID: {}", threadRun.getThreadId());

            // Display success message
            logger.info("\nDemo completed successfully!");

        } catch (HttpResponseException e) {
            // Handle service-specific errors with detailed information
            int statusCode = e.getResponse().getStatusCode();
            logger.error("Service error {}: {}", statusCode, e.getMessage());
            logger.error("Refer to the Azure AI Agents documentation for troubleshooting information.");
            
        } catch (IOException e) {
            // Handle IO exceptions specifically for file operations
            logger.error("I/O error while creating sample document: {}", e.getMessage(), e);
            
        } catch (Exception e) {
            // Handle general exceptions
            logger.error("Error in file search agent sample: {}", e.getMessage(), e);
        }
    }

    /**
     * Creates a sample markdown document with cloud computing information.
     * 
     * This method demonstrates:
     * - Creating a temporary file that will be automatically deleted when the JVM exits
     * - Writing structured markdown content to the file
     * - Logging file creation and preview of content
     * 
     * In a real application, you might read existing files or create more complex documents.
     * You could also upload them to a document storage service for persistent access.
     * 
     * @return Path to the created temporary file
     * @throws IOException if an I/O error occurs during file creation or writing
     */
    private static Path createSampleDocument() throws IOException {
        logger.info("Creating sample document");
        String content = """
            # Cloud Computing Overview
            
            Cloud computing is the delivery of computing services over the internet, including servers, storage,
            databases, networking, software, analytics, and intelligence. Cloud services offer faster innovation,
            flexible resources, and economies of scale.
            
            ## Key Cloud Service Models
            
            1. **Infrastructure as a Service (IaaS)** - Provides virtualized computing resources
            2. **Platform as a Service (PaaS)** - Provides hardware and software tools over the internet
            3. **Software as a Service (SaaS)** - Delivers software applications over the internet
            
            ## Major Cloud Providers
            
            - Microsoft Azure
            - Amazon Web Services (AWS)
            - Google Cloud Platform (GCP)
            - IBM Cloud
            
            ## Benefits of Cloud Computing
            
            - Cost efficiency
            - Scalability
            - Reliability
            - Performance
            - Security
            """;
        
        Path tempFile = Files.createTempFile("cloud-doc", ".md");
        Files.writeString(tempFile, content);
        logger.info("Sample document created at: {}", tempFile);
        return tempFile;
    }
}

REST API

Reemplace YOUR-FOUNDRY-RESOURCE-NAME y YOUR-PROJECT-NAME por sus valores:

#Upload the file
curl --request POST --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/files?api-version=v1' \ 
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \ 
    -f purpose="assistant" \
    -f file="@product_info_1.md" #File object (not file name) to be uploaded.
#Lets say file ID created is assistant-123456789. Use this in the next step

# create vector store
curl --request POST --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/vector_stores?api-version=v1' \ 
-h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \ 
-h 'content-type: application/json' \ 
-d '{
        "name": "my_vectorstore",
        "file_ids": ["assistant-123456789"]
    }'
#Lets say Vector Store ID created is vs_123456789. Use this in the next step

# Create Agent for File Search
curl --request POST --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/assistants?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \ 
    -h 'content-type: application/json' \ 
    -d '{
        "model": "gpt-4o",
        "name": "my-assistant",
        "instructions": "You are a helpful assistant and can search information from uploaded files",
        "tools": [{"type": "file_search"}],
        "tool_resources": {"file_search": {"vector_store_ids": ["vs_123456789"]}}
    }'
#Lets say agent ID created is asst_123456789. Use this to run the agent

# Create thread
curl --request POST --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/threads?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
    -h 'content-type: application/json'
#Lets say thread ID created is thread_123456789. Use this in the next step

# Create message using thread ID
curl --request POST --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/threads/thread_123456789/messages?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
    -h 'content-type: application/json' \
    -d '{
            "role": "user",
            "content": "Hello, what Contoso products do you know?"
        }'

# Run thread with the agent - use both agent id and thread id
curl --request POST --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/threads/thread_123456789/runs?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
    -h 'content-type: application/json' \
    --data '{
        "assistant_id": "asst_123456789"
    }'

# List the messages in the thread using thread ID
curl --request GET --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/threads/thread_123456789/messages?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
    -h 'content-type: application/json'

# Delete agent once done using agent id
curl --request DELETE --url 'https://YOUR-FOUNDRY-RESOURCE-NAME.services.ai.azure.com/api/projects/YOUR-PROJECT-NAME/assistants/asst_123456789?api-version=v1' \
    -h 'authorization: Bearer $AZURE_AI_AUTH_TOKEN' \
    -h 'content-type: application/json'

Portal de la Fundición

1. En el panel Configuración del agente, desplácese hacia abajo si es necesario para encontrar Conocimiento.
2. Selecciona Agregar.
3. Seleccione Archivos para cargar el archivo product_info_1.md.
4. Seleccione Seleccionar archivos locales en Agregar archivos.
5. Seleccione Cargar y guardar.
6. Cambie las instrucciones de los agentes, como "Usted es un asistente útil y puede buscar información de los archivos cargados".
7. Haga una pregunta, por ejemplo, "Hola, ¿qué productos de Contoso conoces?"
8. Para agregar más archivos, seleccione ... en AgentVectorStore y, a continuación, seleccione Administrar.

Limpieza de recursos

Si ya no necesita ninguno de los recursos que ha creado, elimine el grupo de recursos asociado al proyecto.

En el portal de Microsoft Foundry, seleccione el nombre del proyecto en la esquina superior derecha. A continuación, seleccione el vínculo del grupo de recursos para abrirlo en Azure Portal. Seleccione el grupo de recursos y, a continuación, seleccione Eliminar. Confirme que desea eliminar el grupo de recursos.

Contenido relacionado

• Inicio rápido: Creación de un nuevo agente
• Introducción a la biblioteca cliente