Zum Hauptinhalt springen

Überblick

Dieses Beispiel führt mit web_search von der Schlüsselvorbereitung über ein kostenloses Angebot zur Ausführung und zum Ergebnis. Sie benötigen nur eine Bash-kompatible Shell und cURL, kein sprachspezifisches SDK.

Voraussetzungen

Bereiten Sie vor dem API-Aufruf Folgendes vor:
  • Ein NoimosAI-Konto mit Zugang zur Developer Platform
  • Ein Developer-Platform-Projekt mit aktiviertem API-Zugriff
  • Ein Entwickler-API-Schlüssel mit Präfix nmp_ und erforderlichen Berechtigungen
  • Eine Bash-kompatible Shell
  • cURL, jq und uuidgen
Prüfen Sie für kostenpflichtige Aufträge auch verfügbares USD-Prepaid-Guthaben und monatliche Projektlimits. Schlüsselberechtigungen erläutert Anfragen authentifizieren. Wird kein zugängliches Projekt angezeigt, bitten Sie einen OWNER oder ADMIN der Organisation, ein Projekt anzulegen oder Sie hinzuzufügen. API-Schlüssel erstellen Sie innerhalb eines Projekts, dem Sie angehören.

API ausführen

Ihre erste Ausführung erfolgt in sieben Schritten.

1. API-Schlüssel in der Developer Platform erstellen

Ein Projektmitglied mit Rolle ADMIN oder DEVELOPER kann in der Developer Platform so einen Schlüssel erstellen:
  1. An der Developer Platform anmelden und ein Projekt auswählen.
  2. API-Schlüssel öffnen und Neuen Schlüssel erstellen wählen.
  3. Aussagekräftigen Namen, Ablaufdatum und benötigte Berechtigungen festlegen und den Schlüssel erstellen.
  4. Den nur einmal angezeigten geheimen Schlüssel sicher speichern.
Für diese Anleitung benötigen Sie project:read, tools:read, tools:execute und executions:read. Wählen Sie für andere Zwecke nur benötigte Berechtigungen.

2. API-Schlüssel und Basis-URL setzen

Speichern Sie API-Schlüssel und Basis-URL in Umgebungsvariablen, damit Geheimnisse nicht direkt im Befehlsverlauf oder Quellcode stehen.
Der Schlüssel wird nur bei Erstellung einmal angezeigt. Speichern Sie ihn nicht in Git-Repositories, geteilten Dokumenten oder clientseitigem JavaScript.

3. Projekt des Schlüssels prüfen

Prüfen Sie zuerst, ob der Schlüssel zum vorgesehenen Developer-Platform-Projekt gehört.
Bei Erfolg enthält data Organisations-ID, Projekt-ID und Projektname. Ist es nicht das erwartete Projekt, prüfen Sie den Schlüssel vor kostenpflichtigen Aufträgen.

4. Verfügbare Tools prüfen

Rufen Sie aktuelle Toolnamen, Beschreibungen, Eingabeschemas, Beispiele, Verfügbarkeit und Preise ab.
Prüfen Sie executionEnabled für die gesamte Antwort und available für das Tool. Nutzen Sie diese Antwort als aktuelle Grundlage, statt Toolanzahl, Modelle, Schemas oder Preise fest anzunehmen. Filtern Sie die gespeicherte Antwort, um nur web_search anzuzeigen.

5. Vor Ausführung ein Angebot einholen

Senden Sie Toolnamen und Argumente, um Preisversion und maximalen Reservierungsbetrag zu erhalten. Dies startet keinen kostenpflichtigen Auftrag.
Das Angebot liefert priceVersion und maximumChargeMicros für die Ausführung. Übernehmen Sie beide Werte unverändert; eine eigene Berechnung ist unnötig. maximumChargeMicros ist eine Ganzzahl in Millionsteln eines USD: 1 USD entspricht 1,000,000 micros.
Die obigen Beträge zeigen nur das Antwortformat. Im nächsten Schritt lesen Sie die tatsächlichen Werte aus der gespeicherten Antwort.

6. Angebotene Anfrage ausführen

Verwenden Sie dieselben Tools und Argumente wie im Angebot und ergänzen Sie Preisversion und maximalen Reservierungsbetrag. Fügen Sie einen Idempotenzschlüssel für diese logische Anfrage hinzu.
Das Beispiel übernimmt das Angebot aus Schritt 5 und erzeugt mit uuidgen einen neuen Idempotenzschlüssel. Bei Annahme werden HTTP 202 und eine Ausführungs-ID zurückgegeben.
Die Antwort enthält außerdem Preisversion, Ausgabe, Fehler und Zeitangaben. chargedMicros: 0 während der Verarbeitung bedeutet nicht, dass die Ausführung kostenlos abgerechnet wurde.

7. Ergebnis mit derselben Ausführungs-ID abfragen

Fragen Sie die in Schritt 6 gespeicherte ID bis zum Abschluss in Abständen von mindestens fünf Sekunden ab.
queued, running und waiting bedeuten laufende Verarbeitung. Bei succeeded lesen Sie output und chargedMicros. Weitere Status erläutert Ausführung und Abrechnung verwalten.
Ist die Antwort auf die Ausführung unbekannt, senden Sie nicht mit einem neuen Idempotenzschlüssel erneut. Derselbe Inhalt mit demselben Schlüssel liefert die bereits angenommene Ausführung.

Weiterführende Seiten

Lesen Sie anschließend die für Ihre Implementierung relevanten Seiten: