AI

Bright Data OpenAPI-Spezifikationen für die Integration in KI als Tools

Entdecken Sie, wie die Bright Data OpenAPI-Spezifikationen die Integration von SERP-API und Web Unlocker-API in KI-Workflows vereinfachen, mit Schritt-für-Schritt-Anleitungen und Beispielen.
12 min lesen
OpenAPI specs for Bright Data integration in AI agents

In diesem Blogbeitrag erfahren Sie:

  • Was die OpenAPI-Spezifikation ist.
  • Warum sie für die Tool-Definition in KI-Frameworks und -Plattformen so beliebt ist.
  • Wie Bright Data OpenAPI für eine vereinfachte Integration in KI-Agenten und Workflows unterstützt.
  • Die OpenAPI-Spezifikation der Bright Data Web Unlocker API.
  • Die OpenAPI-Spezifikation der Bright Data SERP-API.
  • Wie diese Spezifikationen in einer realen KI-Plattform funktionieren

Lassen Sie uns eintauchen!

Was ist die OpenAPI-Spezifikation?

Die OpenAPI-Spezifikation (OAS) ist ein sprachunabhängiger, offener Standard zur Beschreibung von RESTful-APIs. Sie bietet ein strukturiertes, maschinenlesbares Format (in der Regel YAML oder JSON) zur Definition der Operationen, Parameter, Antworten, Sicherheitsschemata und anderer Merkmale einer API.

Entdecken Sie das GitHub-Repository für die Spezifikation!

Hinweis: Die OpenAPI-Spezifikation hieß ursprünglich „Swagger-Spezifikation”. Wenn Sie also nach „Bright Data Swagger-Spezifikationen” suchen, sind Sie hier genau richtig!

Warum viele KI-Lösungen für die Werkzeugdefinition auf OpenAPI-Spezifikationen setzen

Viele KI-Frameworks unterstützen OpenAPI für die Werkzeugdefinition. Der Hauptgrund dafür ist, dass die OpenAPI-Spezifikation einen standardisierten, maschinenlesbaren Vertrag bereitstellt, der genau beschreibt, was eine externe API tut.

Diese Standardisierung bietet drei wesentliche Vorteile:

  1. Interoperabilität und minimale Reibungsverluste: OpenAPI ist ein weit verbreiteter Standard. Sobald Sie eine Spezifikation bereitstellen, kann die Plattform die API automatisch importieren, Eingabeformulare, Aufrufe und die Verarbeitung von Antworten generieren und sie in ihre Tools integrieren.
  2. Reduzierte Lernkurve: Selbst nicht-technische Benutzer können Tools mit APIs erstellen, indem sie einfach OpenAPI-Spezifikationen aus der Dokumentation oder anderen Quellen kopieren. Somit ist keine manuelle Verkabelung oder Codierung erforderlich, weshalb die OpenAPI-Unterstützung in Low-Code-/No-Code-KI-Plattformen so verbreitet ist.
  3. Bessere Wartung: Mit einem expliziten API-Vertrag sind Updates einfach. Wenn sich die API weiterentwickelt, müssen Sie nur die Spezifikation in der Tool-Definition aktualisieren, was die Wartung erheblich vereinfacht und den Bedarf an umfangreichen Neuprogrammierungen reduziert.

Kurz gesagt: Die Definition von Tools über OpenAPI öffnet die Tür zu einem unternehmensfähigen Ökosystem, in dem CRMs, Datenanbieter, interne APIs und andere externe Dienste sicher verbunden, dokumentiert und mit minimalem manuellem Aufwand in KI-Agenten, Pipelines und Workflows gewartet werden können.

Vorstellung der OpenAPI-Spezifikationen von Bright Data

Bright Data bietet eine Reihe von Produkten und Dienstleistungen für die Extraktion von Webdaten, automatisierte Webinteraktion, Web-Crawling und vieles mehr.

Diese Lösungen sind über APIs (und auch über No-Code-Optionen) verfügbar, was bedeutet, dass Sie sie mithilfe von OpenAPI-Spezifikationen in KI-Plattformen konfigurieren können, die diese Funktion unterstützen.

In diesem Artikel konzentrieren wir uns auf zwei der wichtigsten Tools von Bright Data:

  • SERP-API: Extrahiert automatisch strukturierte Daten aus Suchmaschinen wie Google, Bing und Yandex. Sie übernimmt komplexe Aufgaben wie Proxy-Verwaltung, CAPTCHA-Lösung und JavaScript-Rendering, sodass Sie saubere Echtzeit-Ergebnisse im JSON- oder HTML-Format erhalten, ohne blockiert zu werden.
  • Web Unlocker API: Umgeht komplexe Anti-Bot-Maßnahmen (wie CAPTCHAs, IP-Blocks und Fingerprinting), um Webdaten von jeder Webseite zu extrahieren. Sie fungiert als Vermittler, verwaltet Proxys, emuliert echte Benutzer und liefert saubere HTML-, JSON- und Markdown-Antworten.

Für jeden Dienst sehen Sie die OpenAPI 3.x-Spezifikation sowohl im YAML- als auch im JSON-Format sowie Beispiele für deren Testung im Swagger Editor.

Ausgehend von diesen Spezifikationen können Sie auf ähnliche Weise Web-Scraping-APIs und andere API-Endpunkte in OpenAPI-Spezifikationen für die KI-Integration konvertieren.

Hinweis: Einige Bright Data-Produkte haben dieselben API-Endpunkte und ändern ihr Verhalten nur basierend auf dem Request-Body. Da Sie in einem einzigen OpenAPI-Dokument nicht zwei völlig separate Spezifikationen für denselben Pfad und dieselbe Methode definieren können, benötigen Sie separate OpenAPI-Spezifikationen. Aus diesem Grund stellen wir zwei dedizierte OpenAPI-Spezifikationen für die SERP-API und die Web Unlocker-API bereit (da sie denselben Endpunkt haben).

Web Unlocker API OpenAPI-Spezifikation

Entdecken Sie die OpenAPI-Spezifikation für die Web Unlocker API von Bright Data.
Hinweis: Weitere Informationen finden Sie in den folgenden Dokumentationsseiten zu den verfügbaren Argumenten, Optionen, Authentifizierungsmethoden und mehr:

YAML-Spezifikation

Dies ist die OpenAPI-YAML-Spezifikation für die Bright Data Web Unlocker API:

openapi: 3.0.4
info:
  title: Bright Data Web Unlocker API
  version: 1.0.0
  description: |
    Mit der Bright Data Web Unlocker API können Sie Anti-Bot-Maßnahmen umgehen, Proxys verwalten und eine CAPTCHA-Lösung anbieten, um die Erfassung von Webdaten zu vereinfachen.
    [Web Unlocker API-Dokumentation](https://docs.brightdata.com/scraping-automation/web-unlocker/introduction)
  contact:
    name: Bright Data
    url: 
servers:
  - url: https://api.brightdata.com
tags:
  - name: Web Unlocker
    description: Operationen für die Interaktion mit der Bright Data Web Unlocker API.
Komponenten:
  Sicherheitsschemata:
    BearerAuth:
      Typ: http
      Schema: bearer
      bearerFormat: BRIGHT_DATA_API_KEY
Pfade:
  /request:
    post:
      operationId: sendWebUnlockerRequest
      Zusammenfassung: Senden einer Web Unlocker API-Anfrage
      Beschreibung: |
        Senden Sie eine Web Unlocker API-Anfrage unter Verwendung Ihrer Bright Data Web Unlocker API-Zone.  

        [Web Unlocker API `/request` Dokumentation](https://docs.brightdata.com/api-reference/rest-api/unlocker/unlock-website)
      Tags:
        - Web Unlocker
      Sicherheit:
        - BearerAuth: []
      requestBody:
        erforderlich: true
        Inhalt:
          application/json:
            Schema:
              Typ: Objekt
              erforderlich:
                - Zone
                - URL
                - Format
              Eigenschaften:
                Zone:
                  Typ: Zeichenfolge
                  Beschreibung: Der Name Ihrer Web Unlocker-Zone.
                URL:
                  Typ: Zeichenfolge
                  Beschreibung: Die URL der Zielwebsite, die entsperrt und abgerufen werden soll.
                  Beispiel: https://example.com/products
                format:
                  type: string
                  description: |
                    Antwortformat.  
                    Zulässige Werte:  
                    - `raw`: Gibt die Antwort sofort im Hauptteil zurück.  
                    - `json`: Gibt die Antwort als strukturiertes JSON-Objekt zurück.  
                  Standard: raw
                Methode:
                  Typ: Zeichenfolge
                  Beschreibung: HTTP-Methode, die beim Abrufen der Ziel-URL verwendet wird.
                  Beispiel: GET
                Land:
                  Typ: Zeichenfolge
                  Beschreibung: |
                    Ländercode für den Proxy-Standort (ISO 3166-1 Alpha-2-Format). 
                  Beispiel: us
                Datenformat:
                  Typ: Zeichenfolge
                  Beschreibung: |
                    Format der gescrapten Ausgabedaten.  
                    Zulässige Werte:
                    - `markdown`: Seiteninhalt in Markdown konvertiert.
                    - `screenshot`: Um ein PNG-Bild der gerenderten Seite zu erfassen.
                  enum:
                    - markdown
                    - screenshot
      Antworten:
        „200”:
          Beschreibung: Erfolgreiche Antwort mit Suchergebnissen.
        „400”:
          description: Ungültige Anfrage (fehlende Pflichtfelder oder ungültige Parameter).
        „401”:
          description: Nicht autorisiert (ungültiger oder fehlender Bright Data API-Schlüssel).

Hinweis:
Der Abschnitt „securitySchemes“ legt ein Sicherheitsschema fest, das die HTTP-Bearer-Authentifizierung verwendet. Im Einzelnen müssen Clients beim Aufruf der API einen BRIGHT_DATA_API_KEY als Bearer-Token im Authorization-Header senden.

Gleichzeitig verfügen die meisten KI-Plattformen bereits über integrierte Authentifizierungsmethoden und ignorieren dieses Spezifikationsfeld möglicherweise. Dennoch ist es sinnvoll, es aus Gründen der Klarheit und als Referenz in die OpenAPI-Spezifikation aufzunehmen.

JSON-Spezifikation

Nachfolgend finden Sie die JSON-OpenAPI-Spezifikation für die Web Unlocker API:

{
  "openapi": "3.0.4",
  "info": {
    "title": "Bright Data Web Unlocker API",
    "version": "1.0.0",
    "description": "Mit der Bright Data Unlocker API können Sie Anti-Bot-Maßnahmen umgehen, Proxys verwalten und eine CAPTCHA-Lösung anbieten, um die Erfassung von Webdaten zu vereinfachen.nn[Web Unlocker API-Dokumentation](https://docs.brightdata.com/scraping-automation/web-unlocker/introduction)n",
    "contact": {
      "name": "Bright Data",
      "url": ""
    }
  },
  "servers": [
    {
      "url": "https://api.brightdata.com"
    }
  ],
  "tags": [
    {
      "name": "Web Unlocker",
      "description": "Operationen für die Interaktion mit der Bright Data Web Unlocker API."
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "BRIGHT_DATA_API_KEY"
      }
    }
  },
  "paths": {
    "/request": {
      "post": {
        "operationId": "sendWebUnlockerRequest",
        "summary": "Senden einer Web Unlocker API-Anfrage",
        "description": "Senden Sie eine Web Unlocker API-Anfrage über Ihre Bright Data Web Unlocker API-Zone.  nn[Web Unlocker API `/request` Dokumentation](https://docs.brightdata.com/api-reference/rest-api/unlocker/unlock-website)n",
        "tags": [
          "Web Unlocker"
        ],
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "Zone",
                  "url",
                  "format"
                ],
                "properties": {
                  "zone": {
                    "type": "string",
                    "description": "Der Name Ihrer Web Unlocker-Zone."
                  },
                  "url": {
                    "type": "string",
                    "description": „Die URL der Zielwebsite, die entsperrt und abgerufen werden soll.”,
                    „example”: „https://example.com/products”
                  },
                  „format”: {
                    „type”: „string”,
                    „description”: „Antwortformat.  nZulässige Werte:  n- `raw`: Gibt die Antwort sofort im Hauptteil zurück.  n- `json`: Gibt die Antwort als strukturiertes JSON-Objekt zurück.  n“,
                    „default“: „raw“
                  },
                  „method“: {
                    „type“: „string“,
                    „description“: „HTTP-Methode, die beim Abrufen der Ziel-URL verwendet wird.“,
                    "example": "GET"
                  },
                  "country": {
                    "type": "string",
                    "description": "Ländercode für den Proxy-Standort (ISO 3166-1 Alpha-2-Format). n",
                    "example": "us"
                  },
                  "data_format": {
                    "type": "string",
                    "description": "Format der gescrapten Ausgabedaten.  nZulässige Werte:n- `markdown`: Seiteninhalt in Markdown konvertiert.n- `screenshot`: Um ein PNG-Bild der gerenderten Seite zu erfassen.n",
                    "enum": [
                      "markdown",
                      "screenshot"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Erfolgreiche Antwort mit Suchergebnissen."
          },
          "400": {
            "description": "Ungültige Anfrage (fehlende Pflichtfelder oder ungültige Parameter)."
          },
          "401": {
            "description": "Nicht autorisiert (ungültiger oder fehlender Bright Data API-Schlüssel)."
          }
        }
      }
    }
  }
}

Testen im Swagger Editor

Testen Sie die OpenAPI-Spezifikation, indem Sie sie in den Swagger Editor einfügen:
Testing the Bright Data Web Unlocker API specification in Swagger

SERP-API-OpenAPI-Spezifikation

Entdecken Sie die OpenAPI-Spezifikation für die SERP-API von Bright Data.

Hinweis: Weitere Informationen finden Sie in den folgenden Dokumentationsseiten zu Argumenten, Optionen, Authentifizierungsmethoden und mehr:

YAML-Spezifikation

Hier ist die OpenAPI-YAML-Spezifikation für die SERP-API:

openapi: 3.0.4
info:
  title: Bright Data SERP-API
  version: 1.0.0
  description: |
    Extrahieren Sie Suchmaschinenergebnisse mit der Bright Data SERP-API. Extrahieren Sie strukturierte Daten aus den wichtigsten Suchmaschinen, darunter Google, Bing, Yandex, DuckDuckGo und mehr.
Erhalten Sie organische Ergebnisse, bezahlte Anzeigen, lokale Einträge, Shopping-Ergebnisse und andere SERP-Funktionen.
    [SERP-API-Dokumentation](https://docs.brightdata.com/scraping-automation/serp-api/introduction)
  contact:
    name: Bright Data
    url: 
servers:
  - url: https://api.brightdata.com
tags:
  - name: SERP
    description: Vorgänge im Zusammenhang mit der Bright Data SERP-API.
Komponenten:
  Sicherheitsschemata:
    BearerAuth:
      Typ: http
      Schema: bearer
      bearerFormat: BRIGHT_DATA_API_KEY
Pfade:
  /request:
    post:
      operationId: sendSerpRequest
      Zusammenfassung: SERP-API-Anfrage senden
      Beschreibung: |
        Senden Sie eine SERP-API-Anfrage unter Verwendung Ihrer Bright Data SERP-API-Zone.  

        [SERP-API `/request`-Dokumentation](https://docs.brightdata.com/api-reference/rest-api/serp/scrape-serp)
      tags:
        - SERP
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - zone
                - url
                - format
              properties:
                zone:
                  type: string
                  description: Der Name Ihrer SERP-API-Zone.
                url:
                  type: string
                  description: Die URL der Suchmaschine, die abgefragt werden soll (z. B. `https://www.google.com/search?q=<search_query>`).
                  example: https://www.google.com/search?q=pizza&hl=en&gl=us
                format:
                  type: string
                  description: |
                    Antwortformat.  
                    Zulässige Werte:  
                    - `raw`: Gibt die Antwort sofort im Hauptteil zurück.  
                    - `json`: Gibt die Antwort als strukturiertes JSON-Objekt zurück.  
                  Standard: raw
                  Enum:
                    - raw
                    - json
                Land:
                  Typ: Zeichenfolge
                  Beschreibung: |
                    Ländercode für den Proxy-Standort (ISO 3166-1 Alpha-2-Format). 
Beispiel: us
data_format:
Typ: Zeichenfolge
Beschreibung: |
Format der SERP-Ausgabedaten.  
Zulässige Werte:
- `json`: Vollständig geparste JSON-Daten mit strukturierten SERP-Ergebnissen, einschließlich organischer, bezahlter, lokaler, Shopping- und Feature-Snippets.
                    - `markdown`: SERP-Inhalt, konvertiert in Markdown.  
enum:
- json
- markdown
Antworten:
„200”:
Beschreibung: Erfolgreiche Antwort mit Suchergebnissen.
„400”:
Beschreibung: Ungültige Anfrage (fehlende Pflichtfelder oder ungültige Parameter).
        „401”:
          Beschreibung: Nicht autorisiert (ungültiger oder fehlender Bright Data API-Schlüssel).

JSON-Spezifikation

Dies ist die JSON-OpenAPI-Spezifikation für die SERP-API:

{
  "openapi": "3.0.4",
  "info": {
    "title": "Bright Data SERP-API",
    "version": "1.0.0",
    "description": "Extrahieren Sie Suchmaschinenergebnisse mit der Bright Data SERP-API. Extrahieren Sie strukturierte Daten aus den wichtigsten Suchmaschinen, darunter Google, Bing, Yandex, DuckDuckGo und mehr.  nErhalten Sie organische Ergebnisse, bezahlte Anzeigen, lokale Einträge, Shopping-Ergebnisse und andere SERP-Funktionen.n[SERP-API-Dokumentation](https://docs.brightdata.com/scraping-automation/serp-api/introduction)n",
    "contact": {
      "name": "Bright Data",
      "url": ""
    }
  ],
  "servers": [
    {
      "url": "https://api.brightdata.com"
    }
  ],
  "tags": [
    {
      "name": "SERP",
      "description": "Operationen im Zusammenhang mit der Bright Data SERP-API."
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "BRIGHT_DATA_API_KEY"
      }
    }
  „paths”: {
    „/request”: {
      „post”: {
        „operationId”: „sendSerpRequest”,
        „summary”: „Eine SERP-API-Anfrage senden”,
        „description”: „Eine SERP-API-Anfrage über Ihre Bright Data SERP-API-Zone senden.  nn[SERP-API-Dokumentation „/request“](https://docs.brightdata.com/api-reference/rest-api/serp/scrape-serp)n“,
        „tags“: [
          „SERP“
        ],
        „security“: [
          {
            „BearerAuth“: []
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "Zone",
                  "url",
                  "format"
                ],
                "properties": {
                  "zone": {
                    "type": "string",
                    "description": "Der Name Ihrer SERP-API-Zone."
                  },
                  "url": {
                    "type": "string",
                    "description": "Die URL der Suchmaschine, die abgefragt werden soll (z. B. `https://www.google.com/search?q=<search_query>`).",
                    „example“: „https://www.google.com/search?q=pizza&hl=en&gl=us“
                  },
                  „format“: {
                    „type“: „string“,
                    „description“: „Antwortformat.  nZulässige Werte:  n- `raw`: Gibt die Antwort sofort im Hauptteil zurück.  n- `json`: Gibt die Antwort als strukturiertes JSON-Objekt zurück.  n",
                    "default": "raw",
                    "enum": [
                      "raw",
                      "json"
                    ]
                  },
                  "country": {
                    "type": "string",
                    "description": "Ländercode für den Proxy-Standort (ISO 3166-1 Alpha-2-Format). n",
                    "example": "us"
                  },
                  "data_format": {
                    "type": "string",
                    "description": "Format der SERP-Ausgabedaten.  nZulässige Werte:n- `json`: Vollständig geparste JSON-Daten mit strukturierten SERP-Ergebnissen, einschließlich organischer, bezahlter, lokaler, Shopping- und Feature-Snippets.n- `markdown`: SERP-Inhalt, konvertiert in Markdown.  n",
                    "enum": [
                      "json",
                      "markdown"
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Erfolgreiche Antwort mit Suchergebnissen."
          },
          "400": {
            "description": "Ungültige Anfrage (fehlende Pflichtfelder oder ungültige Parameter)."
          },
          "401": {
            "description": "Nicht autorisiert (ungültiger oder fehlender Bright Data API-Schlüssel)."
          }
        }
      }
    }
  }
}

Testen im Swagger Editor

Um diese Spezifikation zu testen, fügen Sie sie in den Online-Swagger-Editor ein:
Testing the Bright Data SERP API specification in Swagger

Testen der Bright Data OpenAPI-Spezifikationen für die Tool-Integration in Dify

Um zu überprüfen, ob die oben genannten OpenAPI-Spezifikationen für die Verbindung zu Bright Data-Diensten über die API funktionieren, werden wir sie in Dify testen.

Konkret testen wir die Bright Data SERP-API-OpenAPI-Spezifikation, aber Sie können diesen Leitfaden auch leicht an andere Web Unlocker API SERP-Spezifikationen anpassen.

Dify ist eine Open-Source-Entwicklungsplattform mit geringem Programmieraufwand, die die Erstellung, Bereitstellung und Verwaltung von KI-gestützten Anwendungen vereinfacht. Neben vielen anderen Funktionen können Sie damit benutzerdefinierte Tools mithilfe von OpenAPI-Spezifikationen definieren.

Diese Funktion ist nicht einzigartig für Dify. Im Gegenteil, viele andere Plattformen zur Erstellung von KI-Agenten, insbesondere Low-Code-/No-Code- oder unternehmensgerechte Lösungen, unterstützen ebenfalls die Tool-Integration über OpenAPI-Spezifikationen.

Entdecken Sie weitere Integrationen mit Bright Data über OpenAPI-Spezifikationen in den folgenden Anleitungen:

Testen wir nun die Bright Data OpenAPI-Spezifikationen in Dify!

Voraussetzungen

Um diesem Tutorial-Abschnitt folgen zu können, benötigen Sie:

Befolgen Sie die offizielle Anleitung, um einen Bright Data API-Schlüssel zu generieren. Bewahren Sie ihn an einem sicheren Ort auf, da wir ihn für die Authentifizierung der SERP-API-Tool-Aufrufe benötigen.

Befolgen Sie anschließend die Anweisungen in der Bright Data-Dokumentation, um eine SERP-API-Zone in Ihrem Konto einzurichten:
Note the SERP API zone called "serp_api” in your account
Von nun an gehen wir davon aus, dass Ihre SERP-API-Zone serp_api heißt. Passen Sie den Zonennamen in den Beispielen entsprechend an den Namen Ihrer Zone an.

Schritt 1: Neues benutzerdefiniertes Tool erstellen

Melden Sie sich bei Ihrem Dify Cloud-Konto an oder starten Sie Ihre lokale Instanz. Um ein neues benutzerdefiniertes Tool zu erstellen, wählen Sie zunächst die Option „Tools” im oberen Menü:
Selecting the “Tools” option

Gehen Sie auf der Seite „Tools“ zur Registerkarte „Benutzerdefiniert“:
Reaching the “Custom” tab

Klicken Sie auf der Registerkarte „Benutzerdefiniert“ auf die Karte „Benutzerdefiniertes Tool erstellen“:
Pressing the “Create Custom Tool” button

Das folgende Modal „Benutzerdefiniertes Tool erstellen“ wird angezeigt:
The  “Create Custom Tool” modal
Großartig! Hier fügen Sie Ihre Bright Data SERP-API-OpenAPI-Spezifikation ein.

Schritt 2: Definieren Sie das SERP-API-Tool mithilfe der OpenAPI-Spezifikation

Geben Sie im Modal „Benutzerdefiniertes Tool erstellen“ dem Tool einen Namen, z. B. „SERP-API“. Fügen Sie im Feld „Schema“ die YAML OpenAPI-Spezifikation für die Bright Data SERP-API ein.

Sie sollten nun etwa Folgendes sehen:
The populated custom tool creation modal
Beachten Sie, dass der Abschnitt „Verfügbare Tools“ automatisch auf der Grundlage der in der OpenAPI-Spezifikation angegebenen Definition ausgefüllt wird.

Wie bereits erwähnt, müssen Sie bei den meisten Plattformen die Authentifizierung über eine integrierte Methode definieren. Klicken Sie dazu in diesem Fall auf das Zahnradsymbol im Abschnitt „Authentication Method“ (Authentifizierungsmethode):
Clicking the gear icon in the “Authentication Method” section

Konfigurieren Sie die Authentifizierung wie folgt:

  • Authentifizierungstyp: „Header“
  • Typ: „Bearer“
  • Schlüssel: „Autorisierung“
  • Wert: Fügen Sie Ihren Bright Data API-Schlüssel ein

Configuring the authentication method
Dadurch wird die Authentifizierung über einen Authorization -Header eingerichtet, der wie folgt gesendet wird:

Bearer <IHR_BRIGHT_DATA_API_SCHLÜSSEL>

Dies ist genau die Authentifizierungsmethode, die von Bright Data APIs unterstützt wird.

Großartig! Das SERP-API-Tool wurde nun korrekt definiert und konfiguriert.

Schritt 3: Testen Sie das Tool

Suchen Sie im Abschnitt „Verfügbare Tools” die Zeile für den konfigurierten Endpunkt /request und klicken Sie auf die Schaltfläche „Testen”:

Pressing the “Test” button
Dadurch wird das Modal „sendSerpRequest testen“ geöffnet, in dem Sie Parameter und Werte anpassen können, um zu überprüfen, ob das konfigurierte Tool funktioniert.

Beginnen Sie beispielsweise mit dem Testen einer grundlegenden Antwort im JSON-Format. Das erwartete Ergebnis ist eine strukturierte JSON-Antwort, die die von Google gescrapte SERP-Seite im HTML-Format enthält (das Standarddatenformat der SERP-API):
Testing the SERP API tool

Scrollen Sie nach unten zum Abschnitt „Testergebnisse“, um die API-Antwort anzuzeigen. Sie werden sehen, dass das Body- Feld im JSON wie erwartet den HTML-Code der SERP-Seite enthält:
Note the HTML contained in the “body” field
Fantastisch! Dieses Ergebnis entspricht den Erwartungen.

Versuchen Sie nun, die Markdown-Version derselben Seite direkt im Antworttext zu erhalten:
Note the SERP result in Markdown
Beachten Sie, dass die Antwort diesmal aus reinem Text besteht (wegen format: raw) und die SERP-Daten im Markdown-Format enthält (wegen data_format: markdown) –bereit für die LLM-Erfassung.

Da Sie nun wissen, dass das Tool funktioniert (da es die zugrunde liegende API erfolgreich aufruft), können Sie es in jeden Dify-Workflow oder KI-Agenten integrieren.

Et voilà! Das über die OpenAPI-Spezifikation definierte Bright Data-Tool funktioniert einwandfrei.

Fazit

In diesem Artikel haben Sie erfahren, warum KI-Plattformen und -Bibliotheken die Verwendung von OpenAPI-Spezifikationen für die Tool-Definition ermöglichen und wie Bright Data diese Option unterstützt. Insbesondere haben Sie die OpenAPI-Spezifikationen für die Lösungen Web Unlocker und SERP-API von Bright Data kennengelernt.

Durch die Integration dieser beiden Tools können Sie komplexe KI-Agenten erstellen, die das Web durchsuchen und Webdaten für RAG, Deep Research und viele andere Aufgaben abrufen. Nutzen Sie die gesamte Palette der Bright Data API-Dienste für KI, um das volle Potenzial Ihrer Agenten auszuschöpfen!

Erstellen Sie noch heute ein kostenloses Bright Data-Konto und beginnen Sie mit der Integration unserer APIs für die Abfrage von Webdaten!