Integrationsleitfaden
Eine API ist nützlich, wenn Ihre Anwendung Aufgaben senden und Ergebnisse verarbeiten soll, ohne jeden Schritt von Hand zu wiederholen. Nutzen Sie diesen Leitfaden, um zu prüfen, wo Evolink in Ihren Workflow passen könnte, was Sie in der Dokumentation nachsehen sollten und wie Sie einen eng umrissenen Ablauf testen, bevor Sie Ihre Anwendung darauf aufbauen.
Beginnen Sie mit dem gewünschten Ergebnis. Entscheiden Sie dann, ob ein direkt nutzbares Tool oder ein wiederholbarer Anwendungsworkflow besser geeignet ist.
Eine Integration kann wiederkehrende Übergaben vermeiden. Sie kann aber weder einen nicht unterstützten Workflow verfügbar machen noch garantieren, dass jedes Ergebnis brauchbar ist.
Eine Funktion in einer Weboberfläche hat nicht unbedingt einen entsprechenden Endpunkt. Welche Aufrufe Ihre Anwendung ausführen kann, sollte die Evolink-Dokumentation klären – nicht ein Screenshot der Oberfläche.
Alternative
Listen Sie die benötigten Eingaben und Ausgaben auf und gleichen Sie jede davon mit der aktuellen Endpunktreferenz ab.
Generierte Inhalte können je nach Prompt, Ausgangsmaterial und ausgewähltem Modell variieren. Eine erfolgreiche Anfrage allein bedeutet nicht, dass das Ergebnis Ihren redaktionellen oder technischen Anforderungen entspricht.
Alternative
Prüfen Sie eine kleine Auswahl repräsentativer Ergebnisse und sehen Sie eine menschliche Freigabe vor, wenn Genauigkeit wichtig ist.
Ein produktiver Workflow muss weiterhin mit abgelehnten Eingaben, unterbrochenen Anfragen und Antworten umgehen können, die Ihre Anwendung nicht verarbeiten kann. Gehen Sie nicht davon aus, dass ein einzelnes Beispiel für einen reibungslosen Ablauf diese Fälle abdeckt.
Alternative
Testen Sie Fehlerantworten und legen Sie fest, wann Sie die Anfrage wiederholen, die Eingabe überarbeiten oder den Vorgang abbrechen.
Halten Sie den ersten Evolink-Test so klein, dass Sie sowohl die übermittelte Eingabe als auch das zurückgegebene Ergebnis prüfen können.
Wählen Sie eine einzelne, wiederholbare Aufgabe und halten Sie die erforderliche Eingabe, die erwartete Ausgabe und die Akzeptanzkriterien fest. Vermeiden Sie es, im ersten Test mehrere Inhaltstypen zu kombinieren.
Lesen Sie in der aktuellen API-Referenz nach, welches Anfrageformat, Antwortformat und Authentifizierungsverfahren gelten und welche Einschränkungen dokumentiert sind. Betrachten Sie Beispielcode als Ausgangspunkt, nicht als Spezifikation.
Senden Sie eine repräsentative Anfrage, halten Sie die Antwort fest und prüfen Sie, ob sich die Ausgabe im nächsten Schritt Ihres Workflows verwenden lässt. Wiederholen Sie den Vorgang mit einer ungültigen Eingabe, um zu sehen, wie ein Fehler gemeldet wird.
Entscheidend ist die Unterscheidung zwischen dem Material, das Sie übermitteln, und dem Ergebnis, das Ihr Workflow anschließend auswerten muss.
Eingabearbeitsbereich
Beispielausgabe
Für gelegentliche Aufgaben kann eine direkte Benutzeroberfläche einfacher sein. Eine API ist dann eine Prüfung wert, wenn eine Anwendung Eingaben und Ergebnisse zwischen wiederholbaren Schritten weitergeben muss.
Eine Aufgabe starten
Manueller Workflow
Eine Person gibt die Eingabe über eine Benutzeroberfläche ein.
API-Workflow
Eine Anwendung bereitet die Eingabe vor und sendet sie.
Wiederholbarkeit
Manueller Workflow
Die Person wiederholt dieselben Schritte.
API-Workflow
Die Anwendung kann ein definiertes Anfragemuster wiederverwenden.
Verarbeitung der Ergebnisse
Manueller Arbeitsablauf
Eine Person prüft das Ergebnis und leitet es weiter.
API-Arbeitsablauf
Der Code empfängt das Ergebnis zur Prüfung oder für einen weiteren Schritt.
Einrichtungsaufwand
Manueller Arbeitsablauf
Für eine einzelne Aufgabe ist nur wenig technische Einrichtung nötig.
API-Arbeitsablauf
Entwicklung und Tests sind erforderlich.
Fehlerbehandlung
Manueller Arbeitsablauf
Eine Person bemerkt Probleme während der Arbeit.
API-Arbeitsablauf
Die Anwendung benötigt eine ausdrückliche Fehlerbehandlung.
Bester Ausgangspunkt
Manueller Arbeitsablauf
Eine Aufgabe erkunden und einige Ergebnisse beurteilen.
API-Arbeitsablauf
Eine Aufgabe automatisieren, sobald ihre Eingaben und Prüfschritte klar sind.
Dies sind mögliche Arbeitsabläufe, die untersucht werden sollten – keine Behauptung, dass für jede genannte Funktion ein dokumentierter Evolink-Endpunkt existiert.
Ein Produzent sammelt kurze Szenenbeschreibungen und möchte jede davon auf einheitliche Weise zur Generierung einreichen.
Prüfen Sie den Video-Workflow und die verfügbaren Steuerungsmöglichkeiten, bevor Sie die Übergabe gestalten.
KI-VideogeneratorEine forschende Person muss zwischen dem Evolink-Tool als Ganzem und einem bestimmten Integrationsweg unterscheiden.
Ermitteln Sie, welche Aufgabe sich für einen Test eignet, bevor Sie Anwendungscode schreiben.
evolink KIEine entwickelnde Person sucht nach einer Beispielanfrage, muss aber wissen, ob sie der aktuellen Dokumentation entspricht.
Vergleichen Sie Beispiele mit den dokumentierten Anfragen und Antworten, bevor Sie sie anpassen.
evolink Beispiele GitHubTesten Sie eine repräsentative Eingabe, prüfen Sie das Ergebnis und entscheiden Sie, ob Evolink für den nächsten Schritt in Ihrem Prozess geeignet ist. Halten Sie den ersten Test eng begrenzt, damit fehlende Steuerungsmöglichkeiten oder unerwartete Ausgaben leicht zu erkennen sind.
Tool ausprobierenVergewissern Sie sich, dass die aktuelle Dokumentation die Aufgabe abdeckt, die Sie automatisieren möchten. Prüfen Sie die erforderlichen Eingaben, die zurückgegebenen Daten, die Authentifizierungsmethode und alle dokumentierten Nutzungsbeschränkungen, bevor Sie sich auf ein Anwendungsdesign festlegen.
Nicht immer. Eine direkte Benutzeroberfläche ist oft einfacher, um eine Aufgabe zu erkunden. Eine API ist nützlicher, wenn Ihre Anwendung eine wiederholbare Übergabe benötigt. Testen Sie zuerst den manuellen Workflow, wenn Sie noch nicht wissen, wie ein gutes Ergebnis aussieht.
Ein Beispiel kann den Aufbau einer Anfrage zeigen, deckt aber möglicherweise ungültige Eingaben oder unerwartete Antworten nicht ab. Vergleichen Sie es mit der aktuellen Dokumentation und testen Sie sowohl erfolgreiche als auch fehlgeschlagene Anfragen, bevor Sie sich darauf verlassen.
Prüfen Sie nicht nur, ob eine Anfrage abgeschlossen wird. Sehen Sie sich die zurückgegebenen Daten an, vergewissern Sie sich, dass Ihre Anwendung sie verwenden kann, und vergleichen Sie die Ausgabe mit den Akzeptanzkriterien, die Sie für die Aufgabe festgelegt haben.