メインコンテンツへスキップ
Vantage API を通じてデータ カタログを次のように使用できます。
  • 利用可能なすべてのデータ カタログの一覧を取得するには、catalogs リソースに GET リクエストを送信します。
    GET https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs
    
  • データ カタログの詳細情報を取得するには、catalogs/ リソースに GET リクエストを送信します。
    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
    

Vantage API を使用したデータ カタログの更新

JSON 形式のデータでデータ カタログを更新するには、次の手順を実行します。
  1. データ カタログにレコードを追加するには、次のように records リソースに POST リクエストを送信します。
    POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records
    
  2. データ カタログの更新が完了したら、新しく追加したデータを検索可能にするため、再インデックスが必要です。これを行うには、次のように catalogs/ リソースに POST リクエストを送信します。
    POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex
    
    重要: 上記のリクエストを送信しない場合、検索結果は古いバージョンのデータ カタログに基づいて返されます。
  3. インデックス作成の進行状況(ステータス)を確認するには、次のリクエストを送信します。
    POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/reindex/reindexOperationId/download
    
データ カタログにデータが投入され、再インデックスが完了すると、Skill をドキュメントに適用できます。 すべてのレコードを削除するには、次のリクエストを送信します。
POST https://your-instance.vantage.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/records/delete/download
Vantage API の詳細については、Swagger ドキュメントを参照してください。