データカタログと Vantage API

Vantage API を使用すると、データカタログをプログラムで管理できます。カタログの一覧表示、構造の確認、レコードの追加、変更後の再インデックス、レコードの削除を行えます。

データカタログの一覧表示と確認

利用可能なすべてのデータカタログを一覧表示します:
GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs

特定のデータカタログの詳細情報を取得します:

GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}

Skill の field とデータカタログの列のマッピングを取得します:

GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/{skillId}/catalogsMapping

JSON レコードを使用してデータカタログを更新するには、次のエンドポイントを使用します。

レコードを追加

records リソースに POST リクエストを送信します。

POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records

再インデックス

更新が完了したら、新しいデータを検索できるように、カタログを再インデックスします。

POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex

この再インデックスリクエストを実行しないと、検索では古いバージョンのデータカタログのデータが返されます。

再インデックスのステータスを確認

再インデックスリクエストから返された操作 ID を使用して、ステータスを確認します。

POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex/reindexOperationId/download

インデックス作成が完了すると、カタログを Document skills で使用できるようになります。

データカタログからすべてのレコードを削除します。

POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records/delete/download

Vantage API の完全なリファレンスについては、Swagger ドキュメントを参照してください。