WorkIQKnowledgeSourceParams interface
指定WorkIQ知识源的运行时参数
属性
| kind | 判别值。 |
继承属性
| always |
指示此知识源应绕过源选择,并始终在检索时进行查询。 |
| enable |
指示在检索时是否应启用该知识源的图像服务。 当为真时,在导入过程中提取的图像会传递给下游模型。 |
| fail |
表示如果从该知识源的检索遇到错误,整个检索请求应当失败。 默认值为 false。 |
| include |
指示是否应为从此源检索的数据包含引用。 |
| include |
指示引用是否应在其有效负载中包含检索期间获得的结构化数据。 |
| knowledge |
参数应用到的索引的名称。 |
| max |
限制从该知识源返回的最大文档数量。 |
| never |
表示该知识源应从请求的候选集中排除,且检索时绝不查询。 该排除是请求本地的,不会修改知识库成员资格。 不能在同一知识源上与 alwaysQuerySource 合并使用。 |
| reranker |
所有检索到的文档必须满足重新排序器阈值才能包含在响应中。 |
| results |
覆盖知识源存储的结果,仅处理此检索调用。 省略时,存储的知识源值适用。 |
属性详细信息
kind
判别值。
kind: "workIQ"
属性值
"workIQ"
继承属性详细信息
alwaysQuerySource
指示此知识源应绕过源选择,并始终在检索时进行查询。
alwaysQuerySource?: boolean
属性值
boolean
继承自 KnowledgeSourceParams.alwaysQuerySource
enableImageServing
指示在检索时是否应启用该知识源的图像服务。 当为真时,在导入过程中提取的图像会传递给下游模型。
enableImageServing?: boolean
属性值
boolean
继承自 KnowledgeSourceParams.enableImageServing
failOnError
表示如果从该知识源的检索遇到错误,整个检索请求应当失败。 默认值为 false。
failOnError?: boolean
属性值
boolean
继承自 KnowledgeSourceParams.failOnError
includeReferences
指示是否应为从此源检索的数据包含引用。
includeReferences?: boolean
属性值
boolean
继承自 KnowledgeSourceParams.include参考文献
includeReferenceSourceData
指示引用是否应在其有效负载中包含检索期间获得的结构化数据。
includeReferenceSourceData?: boolean
属性值
boolean
继承自 KnowledgeSourceParams.includeReferenceSourceData
knowledgeSourceName
参数应用到的索引的名称。
knowledgeSourceName: string
属性值
string
继承自 KnowledgeSourceParams.knowledgeSourceName
maxOutputDocuments
限制从该知识源返回的最大文档数量。
maxOutputDocuments?: number
属性值
number
继承自 KnowledgeSourceParams.maxOutputDocuments
neverQuerySource
表示该知识源应从请求的候选集中排除,且检索时绝不查询。 该排除是请求本地的,不会修改知识库成员资格。 不能在同一知识源上与 alwaysQuerySource 合并使用。
neverQuerySource?: boolean
属性值
boolean
继承自 KnowledgeSourceParams.neverQuerySource
rerankerThreshold
所有检索到的文档必须满足重新排序器阈值才能包含在响应中。
rerankerThreshold?: number
属性值
number
继承自 KnowledgeSourceParams.rerankerThreshold
resultsProcessing
覆盖知识源存储的结果,仅处理此检索调用。 省略时,存储的知识源值适用。
resultsProcessing?: string
属性值
string
继承自 KnowledgeSourceParams.results处理