Skip to main content

KnowledgeBaseFAQ

Stentor API Reference

Stentor API Reference / stentor-models/src / KnowledgeBaseFAQ

Interface: KnowledgeBaseFAQ

Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:94

An FAQ

Properties​

question​

question: string

Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:98

The question that is the closest match

questions?​

optional questions: string[]

Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:104

Optional, some FAQ based systems can return multiple questions that match to the same answer. This will be populated if they exist.

There most likely be a duplicate of the question field.

uri?​

optional uri: string

Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:108

URI, either the source or a location where more information can be found.

document​

document: string

Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:112

The answer to the FAQ

highlights?​

optional highlights: KnowledgeBaseHighlight[]

Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:116

Highlights within the FAQ document that are relevant to the user's original search.

attributes?​

optional attributes: object

Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:120

Additional attribute for the document. Keys and values are dependent on the underlying knowledge base.

Index Signature​

[key: string]: any

matchConfidence?​

optional matchConfidence: number

Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:124

Confidence of the match, number between 0-1 where the higher the number has a higher confidence.

handlerId?​

optional handlerId: string

Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:128

If provided, this references a handler