KnowledgeBaseHighlight

Stentor API Reference

---

Stentor API Reference / stentor-models/src / KnowledgeBaseHighlight

Interface: KnowledgeBaseHighlight

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

Description of a highlighted word, which is relevant to the original knowledge base search.

Properties

beginOffset

beginOffset: number

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

Starting offset within the document

---

endOffset

endOffset: number

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

End location of the highlight within the document

---

topAnswer?

optional topAnswer: boolean

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

If the highlight is the top suggested answer for the entire search.

A document can contain the answer while the highlight pinpoints it's location within the document.

When this is true, it will show up as a suggested answer in the results.