Zum Hauptinhalt springen
Sie können Datenkataloge über die Vantage-API wie folgt nutzen:
  • Um eine Liste aller verfügbaren Datenkataloge abzurufen, senden Sie eine GET-Anfrage an die Ressource catalogs wie folgt:
    GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs
    
  • Um detaillierte Informationen zu einem Datenkatalog abzurufen, senden Sie eine GET-Anfrage an die Ressource catalogs/ wie folgt:
    GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}
    
  • Um Werte anzuzeigen, die sowohl in den Spalten des Datenkatalogs als auch in den Skill-Feldern identisch sind, senden Sie die folgende Anfrage:
    GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/{skillId}/catalogsMapping
    

Aktualisieren von Datenkatalogen mit der Vantage-API

Um einen Datenkatalog mit Daten im JSON-Format zu aktualisieren, gehen Sie wie folgt vor:
  1. Um einen Datensatz zu einem Datenkatalog hinzuzufügen, senden Sie eine POST-Anfrage an die Ressource records wie folgt:
    POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records
    
  2. Nachdem Sie einen Datenkatalog aktualisiert haben, muss er neu indexiert werden, damit die neu hinzugefügten Daten durchsuchbar sind. Senden Sie dazu eine POST-Anfrage an die Ressource catalogs/ wie folgt:
    POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex
    
    Wichtig! Wenn Sie die oben genannte Anfrage nicht senden, liefern Ihre Suchvorgänge Daten aus der veralteten Version des Datenkatalogs.
  3. Um den Status des Indexierungsvorgangs zu prüfen, senden Sie die folgende Anfrage:
    POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex/reindexOperationId/download
    
Sobald der Datenkatalog befüllt und indexiert wurde, kann der Skill auf Dokumente angewendet werden. Um alle Datensätze zu löschen, senden Sie die folgende Anfrage:
POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records/delete/download
Weitere Informationen zur Vantage-API finden Sie in der Swagger-Dokumentation.