Azure KI Agent Service Code Interpreter

Code Interpreter ermöglicht es den Agents, Python-Code in einer Sandkastenausführungsumgebung zu schreiben und auszuführen. Mit aktiviertem Code Interpreter kann Ihr Agent Code iterativ ausführen, um anspruchsvolleren Code, Mathe und Datenanalyseprobleme zu bearbeiten. Wenn Ihr Agent Code schreibt, der nicht ausgeführt werden kann, kann er diesen Code durchlaufen, indem er unterschiedlichen Code ändert und ausführt, bis die Codeausführung erfolgreich ist.

Wichtig

Für den Codeinterpreter fallen zusätzliche Gebühren an, die über die tokenbasierten Gebühren für die Azure OpenAI-Nutzung hinausgehen. Wenn Ihr Agent Code Interpreter gleichzeitig in zwei verschiedenen Threads aufruft, werden zwei Code Interpreter-Sitzungen erstellt. Jede Sitzung ist standardmäßig für eine Stunde aktiv.

Unterstützte Modelle

Die Modellseite enthält die aktuellsten Informationen zu Regionen/Modellen, in denen Agents und Code Interpreter unterstützt werden.

Es wird empfohlen, Agents mit den neuesten Modellen zu verwenden, um die neuen Features sowie die größeren Kontextfenster und aktuellere Trainingsdaten zu nutzen.

Definieren von Importen und Erstellen eines Projektclients

Python

Um Code Interpreter zu verwenden, fügen Sie zuerst die im Beispiel gezeigten import -Anweisungen hinzu, und erstellen Sie einen Projektclient, der eine Verbindungszeichenfolge zu Ihrem KI-Projekt enthält und zum Authentifizieren von API-Aufrufen verwendet wird.

import os
from azure.ai.projects import AIProjectClient
from azure.ai.projects.models import CodeInterpreterTool
from azure.ai.projects.models import FilePurpose
from azure.identity import DefaultAzureCredential
from pathlib import Path

# Create an Azure AI Client from a connection string, copied from your Azure AI Foundry project.
# At the moment, it should be in the format "<HostName>;<AzureSubscriptionId>;<ResourceGroup>;<HubName>"
# Customer needs to login to Azure subscription via Azure CLI and set the environment variables
project_client = AIProjectClient.from_connection_string(
    credential=DefaultAzureCredential(), conn_str=os.environ["PROJECT_CONNECTION_STRING"]
)

C#

Um Code Interpreter zu verwenden, müssen Sie zuerst einen Projektclient erstellen, der eine Verbindungszeichenfolge zu Ihrem KI-Projekt enthält und zum Authentifizieren von API-Aufrufen verwendet wird.

var connectionString = Environment.GetEnvironmentVariable("PROJECT_CONNECTION_STRING");
AgentsClient client = new AgentsClient(connectionString, new DefaultAzureCredential()); 

Hochladen einer Datei

Python

Laden Sie die Datei mithilfe der upload_and_poll() -Funktion hoch, und geben Sie den Dateipfad und den FilePurpose.AGENTS -Zweck an.

# Upload a file and add it to the client 
file = project_client.agents.upload_file_and_poll(
    file_path="nifty_500_quarterly_results.csv", purpose=FilePurpose.AGENTS
)
print(f"Uploaded file, file ID: {file.id}")

C#

Dateien können hochgeladen und dann von Agents oder Nachrichten referenziert werden. Verwenden Sie zunächst die generalisierte Upload-API mit einer purpose von Agents, um eine Datei-ID verfügbar zu machen. Nach dem Hochladen kann die Datei-ID bereitgestellt werden, um einen Vektorspeicher dafür zu erstellen. Die Vektorspeicher-ID kann dann bei der Erstellung einem Agent zur Verfügung gestellt werden.

Hinweis

Sie müssen keine toolResources bereitstellen, wenn Sie keinen Vektorspeicher erstellen.

// Upload a file and wait for it to be processed
Response<AgentFile> uploadAgentFileResponse = await client.UploadFileAsync(
    filePath: "sample_file_for_upload.txt",
    purpose: AgentFilePurpose.Agents);

AgentFile uploadedAgentFile = uploadAgentFileResponse.Value;

// 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
VectorStore vectorStore = await client.CreateVectorStoreAsync(
    fileIds:  new List<string> { uploadedAgentFile.Id },
    name: "my_vector_store");

CodeInterpreterToolResource codeInterpreterToolResource = new CodeInterpreterToolResource();
CodeInterpreterToolResource.VectorStoreIds.Add(vectorStore.Id);

Erstellen eines Agents mit dem Code-Interpreter-Tool

Python

Definieren Sie das code_interpreter -Tool mit CodeInterpreterTool(), und schließen Sie die Datei-ID der Datei ein, die Sie hochgeladen haben. Erstellen Sie anschließend den Agent mit tools festgelegt auf code_interpreter.definitions und tool_resources festgelegt auf code_interpreter.resources.

code_interpreter = CodeInterpreterTool(file_ids=[file.id])

# create agent with code interpreter tool and tools_resources
agent = project_client.agents.create_agent(
    model="gpt-4o-mini",
    name="my-agent",
    instructions="You are helpful agent",
    tools=code_interpreter.definitions,
    tool_resources=code_interpreter.resources,
)

C#

Response<Agent> agentResponse = await client.CreateAgentAsync(
    model: "gpt-4o-mini",
    name: "My agent",
    instructions: "You are a helpful agent.",
    tools: new List<ToolDefinition> { new CodeInterpreterToolDefinition() },
    toolResources: new ToolResources() { CodeInterpreter = codeInterpreterToolResource });
Agent agent = agentResponse.Value;

Erstellen eines Threads, einer Nachricht und Abrufen der Agent-Antwort

Python

Erstellen Sie als Nächstes einen Thread mit create_thread(), und fügen Sie eine Nachricht mithilfe von create_message() an, die das Code-Interpreter-Tool auslöst. Erstellen und führen Sie anschließend eine Ausführung mit create_and_process_run() aus. Sobald die Ausführung abgeschlossen ist, können Sie die Datei aus dem Agent mit delete_file() löschen, um Speicherplatz im Agent freizugeben. Drucken Sie schließlich die Nachrichten vom Agent.

# create a thread
thread = project_client.agents.create_thread()
print(f"Created thread, thread ID: {thread.id}")

# create a message
message = project_client.agents.create_message(
    thread_id=thread.id,
    role="user",
    content="Could you please create bar chart in the TRANSPORTATION sector for the operating profit from the uploaded csv file and provide file to me?",
)
print(f"Created message, message ID: {message.id}")

# create and execute a run
run = project_client.agents.create_and_process_run(thread_id=thread.id, assistant_id=agent.id)
print(f"Run finished with status: {run.status}")

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}")

# delete the original file from the agent to free up space (note: this does not delete your version of the file)
project_client.agents.delete_file(file.id)
print("Deleted file")

# print the messages from the agent
messages = project_client.agents.list_messages(thread_id=thread.id)
print(f"Messages: {messages}")

# get the most recent message from the assistant
last_msg = messages.get_last_text_message_by_sender("assistant")
if last_msg:
    print(f"Last Message: {last_msg.text.value}")

C#

Erstellen Sie als Nächstes einen Thread mit CreateThreadAsync() und einen Thread mit CreateMessageAsync(). Nachdem der Thread erstellt wurde, können Sie ihr Nachrichten mit CreateMessageAsync() hinzufügen, die dazu führen, dass das Code Interpreter Tool ausgelöst wird. Erstellen Sie eine Ausführung, und fahren Sie dann mit der Abfrage fort, bis der Terminalstatus erreicht ist. Wenn die Ausführung erfolgreich war, analysieren Sie die Antwort des Agents, indem Sie die Nachrichten auflisten.

//Create a thread
Response<AgentThread> threadResponse = await client.CreateThreadAsync();
AgentThread thread = threadResponse.Value;

//With a thread created, messages can be created on it:
Response<ThreadMessage> messageResponse = await client.CreateMessageAsync(
    thread.Id,
    MessageRole.User,
    "I need to solve the equation `3x + 11 = 14`. Can you help me?");
ThreadMessage message = messageResponse.Value;

//A run can then be started that evaluates the thread against an agent:
Response<ThreadRun> runResponse = await client.CreateRunAsync(
    thread.Id,
    agent.Id,
    additionalInstructions: "Please address the user as Jane Doe. The user has a premium account.");
ThreadRun run = runResponse.Value;

//Once the run has started, it should then be polled until it reaches a terminal status:
do
{
    await Task.Delay(TimeSpan.FromMilliseconds(500));
    runResponse = await client.GetRunAsync(thread.Id, runResponse.Value.Id);
}
while (runResponse.Value.Status == RunStatus.Queued
    || runResponse.Value.Status == RunStatus.InProgress);

//Assuming the run successfully completed, listing messages from the thread that was run will now reflect new information added by the agent:

Response<PageableList<ThreadMessage>> afterRunMessagesResponse
    = await client.GetMessagesAsync(thread.Id);
IReadOnlyList<ThreadMessage> messages = afterRunMessagesResponse.Value.Data;

// Note: messages iterate from newest to oldest, with the messages[0] being the most recent
foreach (ThreadMessage 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();
    }
}

Herunterladen von Dateien, die vom Code Interpreter generiert wurden

Python

Dateien, die von Code Interpreter generiert werden, finden Sie in den Antworten des Agents auf Nachrichten. Sie können die Bilddatei herunterladen, die von Code Interpreter generiert wurde, indem Sie die image_contents der Antwort durchlaufen und save_file() mit einem Namen und der Datei-ID aufrufen.

# save the newly created file
for image_content in messages.image_contents:
  print(f"Image File ID: {image_content.image_file.file_id}")
  file_name = f"{image_content.image_file.file_id}_image_file.png"
  project_client.agents.save_file(file_id=image_content.image_file.file_id, file_name=file_name)
  print(f"Saved image file to: {Path.cwd() / file_name}") 

C#

Dateien, die von Code Interpreter generiert werden, finden Sie in den Antworten des Agents auf Nachrichten. Sie können die Bilddatei herunterladen, die von Code Interpreter generiert wird, indem Sie die Nachrichten der Antwort durchlaufen und nach einem ImageFileId suchen. Wenn dieses Feld vorhanden ist, verwenden Sie den folgenden Code:

foreach (MessageContent contentItem in message.Content)
{
    if (!string.IsNullOrEmpty(contentItem.ImageFileId))
    {
        OpenAIFileInfo imageInfo = await fileClient.GetFileAsync(contentItem.ImageFileId);
        BinaryData imageBytes = await fileClient.DownloadFileAsync(contentItem.ImageFileId);
        using FileStream stream = File.OpenWrite($"{imageInfo.Filename}.png");
        imageBytes.ToStream().CopyTo(stream);

        Console.WriteLine($"<image: {imageInfo.Filename}.png>");
    }
}

Unterstützte Dateitypen

Dateiformat	MIME-Typ
.c	text/x-c
.cpp	text/x-c++
.csv	application/csv
.docx	application/vnd.openxmlformats-officedocument.wordprocessingml.document
.html	text/html
.java	text/x-java
.json	application/json
.md	text/markdown
.pdf	application/pdf
.php	text/x-php
.pptx	application/vnd.openxmlformats-officedocument.presentationml.presentation
.py	text/x-python
.py	text/x-script.python
.rb	text/x-ruby
.tex	text/x-tex
.txt	text/plain
.css	text/css
.jpeg	image/jpeg
.jpg	image/jpeg
.js	text/javascript
.gif	image/gif
.png	image/png
.tar	application/x-tar
.ts	application/typescript
.xlsx	application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
.xml	application/xml oder text/xml
.zip	application/zip

Siehe auch

• Erfahren Sie mehr über Agents.