Skip to main content

KnowledgeBaseDependency

Stentor API Reference

Stentor API Reference / stentor-models/src / KnowledgeBaseDependency

Interface: KnowledgeBaseDependency

Defined in: packages/stentor-models/src/Knowledgebase/KnowledgeBaseConfig.ts:38

Extends​

Properties​

matchIntentId?​

optional matchIntentId: string

Defined in: packages/stentor-models/src/Knowledgebase/KnowledgeBaseConfig.ts:10

Either the intentId or regex to determine which requests to call the KnowledgeBaseService. If not provided it defaults to "^.*$", which is a regex that will match on all requests.

Inherited from​

KnowledgeBaseConfig.matchIntentId

matchChannel?​

optional matchChannel: string

Defined in: packages/stentor-models/src/Knowledgebase/KnowledgeBaseConfig.ts:16

Either exact name of the channel or a regex to determine which channel to call the KnowledgeBaseService.

If this matches, all requests from this channel go to the KnowledgeBaseService regardless if matchIntentId is set.

Inherited from​

KnowledgeBaseConfig.matchChannel

setIntentId?​

optional setIntentId: string

Defined in: packages/stentor-models/src/Knowledgebase/KnowledgeBaseConfig.ts:22

If provided, it will override the intentId on the original request if the knowledgebase results are preferred.

It will also update the request type to be that of an Intent Request.

Inherited from​

KnowledgeBaseConfig.setIntentId

mergeResults?​

optional mergeResults: boolean

Defined in: packages/stentor-models/src/Knowledgebase/KnowledgeBaseConfig.ts:29

Beta

If set to true then when knowledge base results already exist, they will be merged instead of the default behavior of being overwritten.

  • This field and behavior of the field is subject to change.

Inherited from​

KnowledgeBaseConfig.mergeResults

service​

service: KnowledgeBaseService

Defined in: packages/stentor-models/src/Knowledgebase/KnowledgeBaseConfig.ts:39