Bereitstellungsergebnisse abrufen

Job, generierte Sammlungen, übersprungene Aufgaben und teilweise fehlgeschlagene Vorgänge ansehen.

Rufe einen Bereitstellungsjob anhand der ID ab, die bei seiner Erstellung zurückgegeben wurde:

http
GET /v2/provisioning/jobs/:id
X-API-Key: YOUR_API_KEY

Job-Felder #

FeldBedeutung
id, organizationId, engineIdIdentität des Jobs sowie die Organisation und Engine, denen er zugeordnet ist.
statusMit Running, Completed oder Failed gekennzeichneter Zustand. Failed enthält message.
kindsErgebnisse der angeforderten Aufgaben für glossary, ruleset und brandVoice. Nicht angeforderte Typen können fehlen.
sourcesOptionale Fortschrittsanzeige oder optionaler Bericht zum Einlesen der Quellen.
websiteErste angegebene Website-URL; fehlt bei reiner Texteingabe.
createdAtZeitstempel der Erstellung im ISO-Format.
finishedAtZeitstempel des Abschlusses im ISO-Format; vorhanden, sobald die Verarbeitung beendet ist.

Zustände je Typ #

Sieh dir jeden angeforderten Typ an, auch wenn der übergeordnete Job den Zustand Completed hat:

kinds.<kind>._tagFelder und Bedeutung
PendingNoch in Bearbeitung. Das optionale Feld step hat den Wert reading, generating oder saving; startedAt gibt an, wann dieser Schritt begonnen hat.
DonesetId identifiziert die verknüpfte Sammlung; itemCount gibt die Anzahl der generierten Elemente an.
Skippedreason erklärt, warum der Typ unverändert geblieben ist.
Failedmessage erklärt, warum der Typ nicht befüllt werden konnte.

Dieser Ergebnisausschnitt zeigt beispielsweise ein generiertes Glossar und einen fehlgeschlagenen Regelsatz:

json
{
  "glossary": { "_tag": "Done", "setId": "YOUR_GLOSSARY_ID", "itemCount": 12 },
  "ruleset": { "_tag": "Failed", "message": "Could not generate rules from the supplied material." }
}

Jeder Typ wird unabhängig von den anderen gespeichert. Erfolgreich erstellte Vorgaben bleiben verfügbar, auch wenn ein anderer Typ fehlschlägt. Eine Ressource kann auch während der Generierung mit einer Engine verknüpft werden. Dadurch kann eine Befüllung, die nur für leere Typen vorgesehen ist, oder die Befüllung einer Markenstimme übersprungen werden.

Generierte Datensätze ansehen #

Öffne die Engine in Studio und rufe das verknüpfte Glossar, den Regelsatz oder die Markenstimme auf. Für Lesezugriffe über die API verwende:

  • GET /v2/glossaries/:id/terms für Glossareinträge.
  • GET /v2/rulesets/:id/rules für Regeln.
  • GET /v2/brand-voices/:id/variations für Varianten der Markenstimme.

Verwende die jeweils zugehörige setId und folge der Seitennavigation jeder Liste. Kontrolliere die Terminologie, die Anwendbarkeit je Sprache, nicht übersetzbare Namen und alle Annahmen, die das Modell hinzugefügt hat. Die Anzahl der Elemente gibt an, wie viele Datensätze erstellt wurden, nicht, ob sie korrekt sind.

Nutze bei einem fehlgeschlagenen Typ Wiederholungsversuche und Wiederherstellung. Behalte fertiggestellte Sammlungen bei, statt eine Ersatz-Engine zu erstellen und alle Aufgaben zu wiederholen.