エンリッチ ID

あるコレクション用に作成したカスタム・エンリッチメントを別のコレクションに適用する場合は、エンリッチメントの作成時に生成された固有 ID を知っておく必要があります。 API を使用して、カスタム・エンリッチメントが使用されているプロジェクトから エンリッチメントをリスト します。 返されるリストには、エンリッチ ID 情報が含まれます。

事前作成されたエンリッチメントの場合、固有 ID は変更されません。 以下の表に、事前作成された各エンリッチ・タイプに関連付けられた ID をリストし、エンリッチがサポートされるコレクション言語を示します。 コレクション言語がエンリッチによってサポートされていない限り、エンリッチをコレクションに適用することはできません。

サポートされるすべての言語について詳しくは、 言語サポート を参照してください。

API を使用したエンリッチメントの適用

APIを使用してエンリッチメントを適用するには、以下の手順に従います

1. エンドポイントのベース URL と、デプロイメント用のトークンまたはAPIキーを決定します。

   詳しくは、 API を使用したカスタム・アプリケーションの作成 を参照してください。

2. プロジェクトのプロジェクト ID を取得します。

   製品のユーザー・インターフェースから、 「統合とデプロイ」 > 「API 情報の表示」 ページに移動し、プロジェクト ID をコピーします。

3. エンリッチを適用する対象のコレクションの ID が分からない場合は、コレクションのリストを取得して見つけます。

   例：

   GET $authentication $url/v2/projects/$project_id/collections?version=2019-11-22
   

   collection_id が返されます。

4. GET 要求を送信して、適用されたエンリッチメントをリストするコレクションの構成を返します。

   例：

   GET $authentication $url/v2/projects/$project_id/collections/$collection_id?version=2019-11-22
   

   事前作成されたエンリッチメントのエンリッチメント ID については、 エンリッチメント ID を参照してください。

5. 適用するエンリッチメントを追加します。

   例えば、 「キーワード」 エンリッチメントを追加するには、エンリッチメント・リストにエンリッチメントを含めることができます。 まず、その ID を表から取得します。

   キーワード・エンリッチメント ID は 701db916-fc83-57ab-0000-000000000018 です。 コレクション内の文書の text フィールドの内容にキーワード・エンリッチメントを適用することを指定するには、以下のように JSON 形式で表現できます。

   {
       "enrichment_id" : "701db916-fc83-57ab-0000-000000000018",
       "fields" : [ "text" ]
   }
   

   指定したエンリッチメントによって、デフォルトのエンリッチメントが置き換えられます。 したがって、デフォルトのエンリッチを保持する場合は、コレクションに適用するエンリッチメントのリストにそのエンリッチメントを含めることを忘れないでください。 プロジェクト・タイプごとのデフォルトのエンリッチメントのリストについては、 プロジェクト・タイプごとのデフォルトのエンリッチメント を参照してください。

   例えば、 「エンティティー」 エンリッチメントを保持し、 「キーワード」 エンリッチメントを追加するには、要求本体に以下を指定します。

   "enrichments": [
     {
       "enrichment_id": "701db916-fc83-57ab-0000-00000000001e",
       "fields": [
         "text"
       ]
     },
     {
       "enrichment_id": "701db916-fc83-57ab-0000-000000000018",
       "fields": [
         "text"
       ]
     }
   ]
   

6. コレクションにエンリッチを適用するために、 update collection メソッドを使用して、更新された JSON 要求本文を送信します。

   例：

   POST $authentication -d '$requestBody' $url/v2/projects/$project_id/collections/$collection_id?version=2019-11-22