KnowledgeBaseSuggested
Stentor API Reference / stentor-models/src / KnowledgeBaseSuggested
Interface: KnowledgeBaseSuggested
Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:80
A suggested answer with high confidence.
Extends
Properties
title?
optionaltitle:string
Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:56
The title of the document
Inherited from
uri?
optionaluri:string
Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:61
Optional URI that is the source of the document. It can be a URI for a website or a URI within an internal system (like AWS S3 for example).
Inherited from
document
document:
string
Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:66
The document text. This isn't necessarily the entire source document found at the optional URI, it typically is more focused within where the answer may be.
Inherited from
KnowledgeBaseDocument.document
highlights?
optionalhighlights:KnowledgeBaseHighlight[]
Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:70
Notable highlights within the document that can help the user scan and find their answer.
Inherited from
KnowledgeBaseDocument.highlights
attributes?
optionalattributes:object
Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:74
Additional attribute for the document. Keys and values are dependent on the underlying knowledgebase.
Index Signature
[key: string]: any
Inherited from
KnowledgeBaseDocument.attributes
topAnswer?
optionaltopAnswer:string
Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:84
The snippet that is the exact answer the user is looking for within a larger document.
matchConfidence?
optionalmatchConfidence:number
Defined in: packages/stentor-models/src/Request/KnowledgeBase.ts:88
Confidence of the match, number between 0-1 where the higher the number has a higher confidence.