KnowledgeBaseService
Stentor API Reference / stentor-models/src / KnowledgeBaseService
Interface: KnowledgeBaseService
Defined in: packages/stentor-models/src/Services/KnowledgeBaseService.ts:14
A knowledge base that can be queried
Methods
query()
query(
query,options?):Promise\<KnowledgeBaseResult>
Defined in: packages/stentor-models/src/Services/KnowledgeBaseService.ts:21
Query the knowledge base
Parameters
query
string
Query to search within the knowledge base, typically a user's question.
options?
controller?
AbortController
filters?
{[key: string]: string; }
Returns
Promise\<KnowledgeBaseResult>
Knowledge Base result with either FAQs, suggested, or documents.
faq()?
optionalfaq(query,options?):Promise\<KnowledgeBaseFAQResult>
Defined in: packages/stentor-models/src/Services/KnowledgeBaseService.ts:28
Search for matching FAQs
Parameters
query
string
options?
controller?
AbortController
Returns
Promise\<KnowledgeBaseFAQResult>
rag()?
optionalrag(query,options?):Promise\<KnowledgeBaseGenerated>
Defined in: packages/stentor-models/src/Services/KnowledgeBaseService.ts:35
Beta
Retrieval Augmented Generation Response
Parameters
query
string
options?
controller?
AbortController
temperature?
number
filters?
{[key: string]: string; }
Returns
Promise\<KnowledgeBaseGenerated>