agents.json: eine Open-Source-Spezifikation für Intelligenzen zur Interaktion mit APIs über natürliche Sprache

Allgemeine Einführung

agents.json ist eine Open-Source-Spezifikation, die vom Wildcard AI-Team auf der Grundlage des OpenAPI-Standards entwickelt wurde und Intelligenzen eine effiziente Kommunikation mit APIs über natürliche Sprache ermöglichen soll. Sie definiert den Interaktionsvertrag zwischen Intelligenzen und APIs durch strukturierte JSON-Dateien, optimiert die Endpunktsuche und Parametergenerierung und löst das Problem der chaotischen Reihenfolge und geringen Genauigkeit, wenn Intelligenzen APIs aufrufen. Das Projekt ist in der Version 0.1.0 auf GitHub (https://github.com/wild-card-ai/agents-json) unter der Apache 2.0-Lizenz gehostet, und die Beteiligung der Gemeinschaft wird gefördert. Mit dem Wildcard Bridge Python-Paket können Entwickler agents.json-Dateien laden, parsen und ausführen, um mehrstufige API-Aufrufe zu automatisieren.

Agents.json ist eine quelloffene JSON-Spezifikation, die den Vertrag für die Interaktion zwischen API und KI-Intelligenz formell beschreibt und auf dem OpenAPI-Standard aufbaut.

Funktionsliste

• Natürliche Sprache gesteuerte API-AufrufeIntelligentsia löst API-Operationen in Alltagssprache aus.
• Erweiterungen auf der Grundlage von OpenAPINeue Interaktionsregeln für OpenAPI zur Optimierung der Nutzung von Intelligenzen.
• Aufgabenabläufe und VerknüpfungenDefinition von mehrstufigen Aufgabenflüssen (Flows) und Aktionsverbindungen (Links), um die Reihenfolge der Anrufe zu gewährleisten.
• zustandsloses DesignClient-Management-Status zur Unterstützung bestehender Infrastrukturen.
• SDK-UnterstützungWildcard Bridge lädt und führt Spezifikationsdateien aus, um die Entwicklung zu vereinfachen.

Hilfe verwenden

Zugang und Vorbereitung

agents.json ist eine Spezifikationsdatei, die in Verbindung mit dem SDK verwendet oder manuell geschrieben werden sollte. So funktioniert sie:

1. die Datei agents.json abrufen

• offizielles Beispiel::
  Holen Sie sich ein Schnellstart-Notizbuch von Wildcard AI, zum Beispiel:
  • Erneut senden:resend.ipynb
  • Gestreift:einzeln.ipynb
  • Google Sheets, etc:mehrfach-dynamisch.ipynb
• Individuelles Schreiben::
  Boden Vollständiges Schemadie die Datei erstellt. Zum Beispiel:

  {
  "apiVersion": "0.1.0",
  "baseUrl": "https://api.example.com",
  "chains": {
  "get_data": {
  "description": "获取指定数据",
  "agent_instructions": "根据用户输入提取数据",
  "steps": [{"endpoint": "/data", "method": "GET"}]
  }
  }
  }

Es wird empfohlen, die /.well-known/agents.json Wege, die von der Intelligenz leicht entdeckt werden können.

2. die Installation der Wildcard-Brücke

• AnfragePython 3.10+.
• umziehen::
  1. Befehl ausführen:

     pip install wildcard-bridge
     

  2. Validierung:

     python -c "import wildcard_bridge; print(wildcard_bridge.__version__)"
     

3. die Konfigurationsumgebung

• Unterstützung bei der ZertifizierungBasic, ApiKey und Bearer-Authentifizierung werden unterstützt. Beispiel:

  from wildcard_bridge import Bridge
  bridge = Bridge(auth={"type": "ApiKey", "key": "your-api-key"})
  

• Vernetzte IntelligenzZugriff auf unterstützte LLMs (z. B. OpenAI) und Vorbereitung von Basis-Prompts.

Bedienung der Hauptfunktionen

Funktion 1: Laden und Parsen der Spezifikationsdatei

• umziehen::
  1. Datei laden:

     bridge.load_agents_json("path/to/agents.json")
     

  2. Betrachten Sie die Aufgabenkette:

     chains = bridge.get_available_chains()
     print(chains)  # 输出可用任务，如 ["get_data"]
     

• verwenden.Verständnis der unterstützten Operationen, bereit zur Ausführung.

Funktion 2: Ausführung von Aufgabenabläufen

• umziehen::
  1. Führen Sie die Aufgabe aus:

     result = bridge.run_chain("get_data", {"query": "sales report"})
     print(result)  # 输出 API 返回结果
     

  2. Überprüfen Sie die Rücksendedaten.
• Nehmen SieDer Benutzer sagt: "Gib mir den Verkaufsbericht", und der Smart Body ruft automatisch die API auf.

Funktion 3: Fehlersuche und Optimierung

• Komponenten während der Prüfung anpassen::

  bridge.enable_debug()
  result = bridge.run_chain("get_data", {"query": "test"})
  

  Überprüfen Sie die Protokolle, um sicherzustellen, dass jeder Schritt korrekt ist.

• OptimierungAnpassungen agent_instructions oder Beispiele, um die Genauigkeit der Intelligenz zu verbessern.

Featured Function Bedienung

Aufgabenablauf und Verknüpfungsdesign

• Arbeitsablauf::
  1. Definieren Sie mehrstufige Aufgabenabläufe, wie z. B. Google Mail-Antworten:

     {
     "chains": {
     "reply_email": {
     "description": "回复邮件",
     "agent_instructions": "根据用户输入回复邮件",
     "steps": [
     {"endpoint": "/threads/{threadId}", "method": "GET"},
     {"endpoint": "/messages/send", "method": "POST"}
     ]
     }
     }
     }
     

  2. Laufen:

     bridge.run_chain("reply_email", {"threadId": "123", "reply": "已收到"})
     

• LichtblickDie Abläufe und Verknüpfungen stellen sicher, dass die Anrufe in der richtigen Reihenfolge erfolgen und die Intelligenz nicht über sie nachdenken muss.

Zustandslose Kompatibilität mit bestehenden Systemen

• realisieren::
  Das SDK läuft auf der Client-Seite und ist für serverlose Umgebungen angepasst:

  def lambda_handler(event, context):
  bridge = Bridge(auth={"type": "Bearer", "token": event["token"]})
  bridge.load_agents_json("s3://bucket/agents.json")
  return bridge.run_chain("task", event["args"])
  

• SchneidkanteEs ist nicht erforderlich, den API-Server zu ändern, sondern ihn einfach zu verwenden.

Beispiel: Stripe-Zahlungsanfrage

• agents.json::

  {
  "baseUrl": "https://api.stripe.com/v1",
  "chains": {
  "check_payment": {
  "description": "查询支付状态",
  "agent_instructions": "根据支付 ID 返回状态",
  "steps": [{"endpoint": "/charges/{chargeId}", "method": "GET"}]
  }
  }
  }
  

• in Bewegung sein::

  result = bridge.run_chain("check_payment", {"chargeId": "ch_123"})
  print(result)
  

• WirkungDer intelligente Körper gibt den Zahlungsstatus direkt zurück, was einfach und effizient ist.

caveat

• BürgschaftSchlüssel werden in Umgebungsvariablen gespeichert, um ein Auslaufen zu verhindern.
• kommunal: Beitreten Diskord Holen Sie sich Unterstützung.
• (Computer-)Datei: Referenz offizielles Dokument.