上一主题: 知识管理 通用方法下一主题: 搜索


faq

以下参数适用于 faq 方法:

参数

类型

描述

SID

整型

标识从登录检索的会话。

categoryIds

字符串

标识用于执行 faq 的类别 ID。使用 1 表示“根”类别。

注意:支持多个 ID,如“1, 2, 3”。

resultSize

整型

标识需要检索详细信息的文档数。对于其它文档,仅返回其 ID。随后可使用 getDocumentsByIDs() 方法访问这些文档的详细信息。默认值为 10。

propertyList

字符串

标识需要从中检索信息的以逗号分隔的数据库字段列表。无论 propertyList 参数如何设置,总会返回以下字段:

  • id
  • DOC_TYPE_ID
  • BU_RESULT

sortBy

字符串

标识需要用于排序结果的数据库字段。不支持多个排序字段。默认值为 BU_RESULT,表示按 faq 等级对其进行排序。将 ID 作为次要排序依据时,总是对结果进行排序。

降序

布尔值

标识可用于以降序排序结果的指示器。

whereClause

字符串

使用此添加自己的“SQL where 子句”过滤搜索结果。

maxDocIds

整型

标识要返回的文档标识的最大数量(默认值为 100)。

例如,如果您指定 resultSize 为 10 且 maxDocIds 为 50,如果数据库中存在 100 个匹配文档,那么将检索到 10 个文档的详细信息并有 40 个文档仅返回 ID。剩下的 50 个根本无法返回。

描述

用于执行 faq 搜索。根据传递的类别 ID 检索文档。返回驻留在此类别或任何子类别中的任何文档。要提高性能,这些方法只可以检索一组用户定义的由 resultSize 参数控制的文档的详细信息。其余文档仅返回 ID。使用此方法,例如,您可以设置页面调度机制,其中用户可以单击“顶部”、“上一页”、“下一页”和“底部”链接。当需要检索下一组信息时,您可以使用 getDocumentsByIDs() 方法。将最多返回 100 个 ID。

返回

<UDSObjectList> 节点包含以下部分:

本章“<UDSObject> 节点描述”部分中的 <UDSObject> 节点。对于此方法找到的前 n 个文档,存在一个具有所有指定属性的 <UDSObject> 节点,其中 n 等于 resultSize 参数。

例如,如果 resultSize 参数为 10,maxDocIDs 参数为 50,并且方法找到 100 个文档,则在第一个 <UDSObject> 部分中存在 10 个具有 <Attributes> 节点的 <UDSObject>,它们具有 propertyList 参数的详细属性信息;在其余的部分中存在 40 个仅具有 ID <Attributes> 的 <UDSObject> 节点。如果要检索编号为 11-20 的文档的 ID <AttrName> 详细信息,您需要调用 getDocumentsByIDs() 方法并将这些 ID 从 <AttrValue> 传递给它。