キュレーションAPI

キュレーション・フィーチャーはベータ機能です。

キュレーションを使用して、特定の自然言語クエリに応答して返す正確なドキュメントを指定します。 キュレーションを使用すると、頻繁な質問や重要な質問を行った場合に、最も有用な文書が必ず返されるようになります。 キュレーションされたクエリ用の confidence_score は常に 1.00000 です。

このベータ機能はAPIからのみ利用可能で、ディスカバリー・クエリー言語を使用して指定されたクエリーではなく、自然言語によるクエリーにのみ適用される。 ベータ機能はSDKからはご利用いただけません。

キュレーションは最大1,000件まで定義できます。 詳細はAPIリファレンスの キュレーションの作成を参照。

この例は、API を使用してキュレーションを追加する方法を示しています。 同じまたは類似の natural_language_query で照会すると、document_id が document_id1234 の文書が返されます。

{
  "natural_language_query": "curations in watson discovery",
  "curated_results": [
     {
       "document_id": "document_id1234",
      "collection_id": "collection_id1234"
     }
   ]
 }

顧客によって送信された自然言語クエリは、キュレーションで指定されたクエリと完全に一致する必要があります。 実行時にユーザーによって送信されるクエリと、キュレーションAPIによって送信されインデックスに格納されるクエリの両方が、クエリ分析を受ける。 クエリーアナライザーは、テキストをレムマター化し、ストップワードを除去し、クエリー展開を追加する。

スニペットを含めることで、クエリに対するハードコードされたレスポンスを指定することもできる。 スニペットは、あなたが作成し、指定された自然言語クエリに対して関連ドキュメントが返されたときに返される応答です。

{
  "curations": [
    {
      "curation_id": "c1175536f509405bc68a9f76235fa7bbb6f9af2f",
      "natural_language_query": "What is a project",
      "curated_results": [
        {
          "collection_id": "47477591-b520-6039-0000-017ea213e837",
          "document_id": "web_crawl_123a2a56-8c26-5acb-9544-c4702ac899a4",
          "snippet": "A project is a convenient way to collect and manage the resources in your application. You can assign a project type and connect your data to the project by creating a collection."
        }
      ]
    }
  ]
}

passages.per_document が true の場合、passage_text フィールドには、検索で選ばれたオリジナルのパッセージではなく、指定したテキストスニペットがトップのパッセージとして返されます。 1つの文書に指定できるテキストスニペットは1つだけです。 passages.max_per_document が 1 より大きい場合、スニペットが最初に返され、その後に検索で選ばれた文章が続きます。 クエリーフィルターはキュレーションの結果に適用される。