IBM Cloud Docs
馆藏 API

馆藏 API

“整理”功能是 Beta 功能。

使用策展来指定响应特定自然语言查询时要返回的确切文档。 整理可以保证常见或重要的问题始终返回最有价值的文档。 confidence_score 的策划查询始终是 1.00000

该测试版功能只能通过应用程序接口使用,并且只适用于自然语言查询,不适用于使用发现查询语言指定的查询。 SDK不提供Beta功能。

您最多可以定义1000个策展。 有关详细信息,请参阅 API 参考中的 创建策划

此示例显示了如何使用 API 添加整理。 使用相同或类似的 natural_language_query 进行查询时,将返回 document_iddocument_id1234 的文档。

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

客户提交的自然语言查询必须与策划中指定的查询完全匹配。 用户在运行时提交的查询和由策划应用程序接口提交并存储在索引中的查询都要经过查询分析。 查询分析器对文本进行词法处理,删除停顿词,并添加查询扩展。

您也可以选择指定对查询的硬编码回复,方法是加入一个代码段。 片段是由您编写的回复,当指定的自然语言查询返回相关文档时,会返回片段。

{
  "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_documenttrue,则您指定的文本片段将作为 passage_text 字段中的顶部段落返回,而不是搜索选择的原始段落。 每个文档只能指定一个文本片段。 如果 passages.max_per_document 大于 1,则首先返回片段,然后返回搜索选择的段落。 查询筛选器适用于整理结果。