Den vollständigen Index der Dokumentation findest du in llms.txt. Die Markdown-Version einer Dokumentationsseite erhältst du, indem du .md an die URL der Seite anhängst.
Hauptnavigation
Design

Blaxel

Führe eine Sitzung der Agents API in einer Blaxel-Sandbox aus.

Im OpenAI Cookbook findest du Beispiele für die Verwaltung von Sandboxes über deine Anwendung und über Webhooks.

Im Leitfaden zu selbst gehosteten Sandboxes erfährst du, wie du den Executor einrichtest und welche Voraussetzungen für die Verbindung gelten.

Wähle aus, wie du die Sandboxes bereitstellen möchtest:

  • Über deine Anwendung: Folge dieser Anleitung, um Sandboxes aus deiner Anwendung heraus zu starten und zu stoppen.
  • Über Webhooks: Stelle einen Handler bereit, der auf Webhooks von OpenAI reagiert und Sandboxes startet oder die Verbindung zu ihnen wiederherstellt.

Einen Vergleich der beiden Modi findest du im Leitfaden zum Lebenszyklus einer Sandbox.

Bevor du beginnst

Du brauchst einen API-Schlüssel für dein OpenAI-Projekt, einen API-Schlüssel und einen Workspace für Blaxel sowie das Paket für die Codex CLI.

Setze BL_API_KEY und BL_WORKSPACE. Verwende OPENAI_API_KEY für Anfragen aus deiner Anwendung. Setze OPENAI_EXECUTOR_API_KEY auf einen Umgebungsschlüssel und übergib ausschließlich diesen Schlüssel als CODEX_API_KEY an die Sandbox.

Lege die Sandbox-Region im Code für die Bereitstellung fest. Wähle us-was-1, wenn du Dateien wie unten beschrieben mit Agent Drive dauerhaft speichern möchtest.

1. Blaxel-Umgebung einrichten

Erstelle eine selbst gehostete Sitzung und speichere ihre Umgebungs-ID. Erstelle mit dem Blaxel SDK oder der Blaxel API eine isolierte Sandbox mit dem konfigurierten Arbeitsverzeichnis. Installiere die Codex CLI in der Sandbox und starte den Executor mit dieser Umgebungs-ID und dem Umgebungsschlüssel.

Das Node-Image von Blaxel basiert auf Alpine Linux. Installiere deshalb ripgrep mit apk. Übergib den Umgebungsschlüssel als CODEX_API_KEY ausschließlich an den Executor-Prozess. Mit keep_alive=True verhinderst du, dass die Sandbox auf null Instanzen herunterskaliert, während der Executor läuft. Lege Zeitlimits für das Setup, den Executor und die Sandbox fest, damit nicht mehr genutzte Ressourcen nicht unbegrenzt weiterlaufen.

Erstelle für den regelmäßigen Einsatz ein Blaxel-Image, in dem Codex und ripgrep bereits installiert sind. So kann die Sandbox schneller eine Verbindung herstellen.

2. Sitzung ausführen

Sobald der Blaxel-Executor die Verbindung hergestellt hat, kannst du anhand der HTTP-Beispiele in Sitzungen ausführen und fortsetzen Eingaben senden und das Ergebnis als Stream empfangen. Wenn du fertig bist, lösche die Sitzung und stoppe die Sandbox beim Anbieter separat.

Starte die Sandbox, bevor du eine Eingabe sendest. Der Verarbeitungsschritt wartet, bis die Umgebung verbunden ist. Die Sitzung meldet die Verbindung im Ereignisstream mit agent.session.environment.connected.

An agent.session.turn.completed erkennst du, dass ein Verarbeitungsschritt erfolgreich abgeschlossen wurde. Auch nach einem fehlgeschlagenen oder abgebrochenen Schritt kann agent.session.idle folgen. Der Leerlaufstatus der Sitzung allein belegt also keinen erfolgreichen Abschluss.

Optional: Dateien über mehrere Sitzungen hinweg speichern

Mit Blaxel Agent Drive bleiben Dateien über mehrere Sandboxes und Sitzungen hinweg erhalten. Binde in jeder Sandbox dasselbe Laufwerk ein, um die Dateien gemeinsam zu nutzen. Agent Drive erfordert die Region us-was-1 und überträgt weder den Gesprächsverlauf noch den Sitzungszustand.

Weiterführende Dokumentation