Skip to main content

IKnowledgeBox

@nuclia/core

@nuclia/core / IKnowledgeBox

Interface: IKnowledgeBox

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:99

Extends​

Extended by​

Properties​

allowed_ip_addresses?​

optional allowed_ip_addresses?: string[] | null

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:40

Inherited from​

IKnowledgeBoxBase.allowed_ip_addresses

allowed_origins?​

optional allowed_origins?: string[] | null

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:39

Inherited from​

IKnowledgeBoxBase.allowed_origins

created?​

optional created?: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:38

Inherited from​

IKnowledgeBoxBase.created

description?​

optional description?: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:36

Inherited from​

IKnowledgeBoxBase.description

enforce_security?​

optional enforce_security?: boolean

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:44

Inherited from​

IKnowledgeBoxBase.enforce_security

external_index_provider?​

optional external_index_provider?: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:45

Inherited from​

IKnowledgeBoxBase.external_index_provider

hidden_resources_enabled?​

optional hidden_resources_enabled?: boolean

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:42

Inherited from​

IKnowledgeBoxBase.hidden_resources_enabled

hidden_resources_hide_on_creation?​

optional hidden_resources_hide_on_creation?: boolean

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:43

Inherited from​

IKnowledgeBoxBase.hidden_resources_hide_on_creation

id​

id: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:32

Inherited from​

IKnowledgeBoxBase.id

search_configs?​

optional search_configs?: object

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:41

Index Signature​

[key: string]: any

Inherited from​

IKnowledgeBoxBase.search_configs

slug​

slug: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:33

Inherited from​

IKnowledgeBoxBase.slug

state?​

optional state?: KBStates

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:35

Inherited from​

IKnowledgeBoxBase.state

title​

title: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:34

Inherited from​

IKnowledgeBoxBase.title

zone​

zone: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:37

Inherited from​

IKnowledgeBoxBase.zone

Accessors​

fullpath​

Get Signature​

get fullpath(): string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:102

Returns​

string

path​

Get Signature​

get path(): string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:100

Returns​

string

Methods​

ask()​

Call Signature​

ask(query, context?, features?, options?): Observable<Answer | IErrorResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:122

Parameters​
query​

string

context?​

ContextEntry[]

features?​

Features[]

options?​

ChatOptions

Returns​

Observable<Answer | IErrorResponse>

Call Signature​

ask(query, context?, features?, options?, callback?): Observable<Answer | IErrorResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:128

Parameters​
query​

string

context?​

ContextEntry[]

features?​

Features[]

options?​

ChatOptions

callback?​

(answer) => void

Returns​

Observable<Answer | IErrorResponse>

askViaWS()​

askViaWS(agenticConfigId, question, keepOpen?, searchConfiguration?, groups?, chatHistory?): Observable<IErrorResponse | AragResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:136

Parameters​

agenticConfigId​

string

question​

string

keepOpen?​

boolean

searchConfiguration?​

string

groups?​

string[]

chatHistory?​

HistoryEntry[]

Returns​

Observable<IErrorResponse | AragResponse>

catalog()​

catalog(query, options?): Observable<IErrorResponse | Results>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:175

Parameters​

query​

string

options?​

CatalogOptions

Returns​

Observable<IErrorResponse | Results>

counters()​

counters(): Observable<Counters>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:186

Returns​

Observable<Counters>

createAgenticRAGPipeline()​

createAgenticRAGPipeline(steps): Pipeline

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:120

Parameters​

steps​

Steps

Returns​

Pipeline

feedback()​

feedback(answerId, good, feedback?, text_block_id?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:184

Parameters​

answerId​

string

good​

boolean

feedback?​

string

text_block_id?​

string

Returns​

Observable<void>

find()​

find(query, features?, options?): Observable<FindResults | IErrorResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:145

Parameters​

query​

string

features?​

Features[]

options?​

SearchOptions

Returns​

Observable<FindResults | IErrorResponse>

generate()​

generate(question, context): Observable<{ answer: string; cannotAnswer: boolean; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:163

Parameters​

question​

string

context​

string[]

Returns​

Observable<{ answer: string; cannotAnswer: boolean; }>

generateJSON()​

generateJSON(question, json_schema, context): Observable<{ answer: object; success: boolean; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:165

Parameters​

question​

string

json_schema​

object

context​

string[]

Returns​

Observable<{ answer: object; success: boolean; }>

generateRandomQuestionAboutResource()​

generateRandomQuestionAboutResource(resource): Observable<string>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:173

Parameters​

resource​

Resource

Returns​

Observable<string>

getAgenticConfig()​

getAgenticConfig(id): Observable<AgenticConfig>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:216

Parameters​

id​

string

Returns​

Observable<AgenticConfig>

getAgenticSource()​

getAgenticSource(id): Observable<AgenticSource>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:218

Parameters​

id​

string

Returns​

Observable<AgenticSource>

getConfiguration()​

getConfiguration(): Observable<{[id: string]: any; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:193

Returns​

Observable<{[id: string]: any; }>

getEntities()​

getEntities(): Observable<Entities>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:104

Returns​

Observable<Entities>

getEntitiesGroup()​

getEntitiesGroup(groupId): Observable<EntitiesGroup>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:106

Parameters​

groupId​

string

Returns​

Observable<EntitiesGroup>

getExtractStrategies()​

getExtractStrategies(): Observable<ExtractStrategies>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:211

Returns​

Observable<ExtractStrategies>

getFacets()​

getFacets(facets): Observable<FacetsResult>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:108

Parameters​

facets​

string[]

Returns​

Observable<FacetsResult>

getFullResource()​

getFullResource(uuid): Observable<IResource>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:114

Parameters​

uuid​

string

Returns​

Observable<IResource>

getFullResourceBySlug()​

getFullResourceBySlug(slug): Observable<IResource>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:118

Parameters​

slug​

string

Returns​

Observable<IResource>

getGenerativeProviders()​

getGenerativeProviders(): Observable<GenerativeProviders>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:195

Returns​

Observable<GenerativeProviders>

getLabels()​

getLabels(): Observable<LabelSets>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:110

Returns​

Observable<LabelSets>

getLearningSchema()​

getLearningSchema(): Observable<LearningConfigurations>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:194

Returns​

Observable<LearningConfigurations>

getProcessingHook()​

getProcessingHook(): Observable<ProcessingHook | undefined>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:221

Returns​

Observable<ProcessingHook | undefined>

getResource()​

getResource(uuid, show?, extracted?): Observable<IResource>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:112

Parameters​

uuid​

string

show?​

ResourceProperties[]

extracted?​

ExtractedDataTypes[]

Returns​

Observable<IResource>

getResourceBySlug()​

getResourceBySlug(slug, show?, extracted?): Observable<IResource>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:116

Parameters​

slug​

string

show?​

ResourceProperties[]

extracted?​

ExtractedDataTypes[]

Returns​

Observable<IResource>

getSearchConfig()​

getSearchConfig(id): Observable<SearchConfig>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:209

Parameters​

id​

string

Returns​

Observable<SearchConfig>

getSearchConfigs()​

getSearchConfigs(): Observable<SearchConfigs>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:215

Returns​

Observable<SearchConfigs>

getSplitStrategies()​

getSplitStrategies(): Observable<SplitStrategies>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:213

Returns​

Observable<SplitStrategies>

getTempToken()​

getTempToken(payload?, ignoreExpiration?): Observable<string>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:191

Parameters​

payload?​

any

ignoreExpiration?​

boolean

Returns​

Observable<string>

getUsers()​

getUsers(accountSlug): Observable<FullKbUser[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:197

Parameters​

accountSlug​

string

Returns​

Observable<FullKbUser[]>

listAgenticConfigs()​

listAgenticConfigs(): Observable<AgenticConfigs>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:217

Returns​

Observable<AgenticConfigs>

listAgenticSources()​

listAgenticSources(): Observable<AgenticSources>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:219

Returns​

Observable<AgenticSources>

listenToAllNotifications()​

listenToAllNotifications(): Observable<NotificationMessage[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:199

Returns​

Observable<NotificationMessage[]>

listenToProcessingNotifications()​

listenToProcessingNotifications(): Observable<ResourceBaseNotification[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:200

Returns​

Observable<ResourceBaseNotification[]>

listenToResourceOperationNotifications()​

listenToResourceOperationNotifications(): Observable<ResourceOperationNotification[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:201

Returns​

Observable<ResourceOperationNotification[]>

listResources()​

listResources(page?, size?): Observable<ResourceList>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:188

Parameters​

page?​

number

size?​

number

Returns​

Observable<ResourceList>

predictAnswer()​

predictAnswer(question, options?): Observable<Answer | IErrorResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:161

Parameters​

question​

string

options?​

PredictAnswerOptions

Returns​

Observable<Answer | IErrorResponse>

processingStatus()​

processingStatus(cursor?, scheduled?, limit?): Observable<{ cursor: string; results: ProcessingStatus[]; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:204

Parameters​

cursor?​

string

scheduled?​

boolean

limit?​

number

Returns​

Observable<{ cursor: string; results: ProcessingStatus[]; }>

rephrase()​

rephrase(question, user_context?, rephrase_prompt?): Observable<string>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:171

Parameters​

question​

string

user_context?​

string[]

rephrase_prompt?​

string

Returns​

Observable<string>

search(query, features?, options?): Observable<IErrorResponse | Results>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:151

Parameters​

query​

string

features?​

Features[]

options?​

SearchOptions

Returns​

Observable<IErrorResponse | Results>

stopListeningToNotifications()​

stopListeningToNotifications(): void

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:202

Returns​

void

suggest()​

suggest(query, inTitleOnly?, features?, options?): Observable<IErrorResponse | Suggestions>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:177

Parameters​

query​

string

inTitleOnly?​

boolean

features?​

SuggestionFeatures[]

options?​

SuggestOptions

Returns​

Observable<IErrorResponse | Suggestions>

summarize()​

summarize(ressourceIds): Observable<string>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:157

Parameters​

ressourceIds​

string[]

Returns​

Observable<string>

tokens()​

tokens(text): Observable<SentenceToken[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:159

Parameters​

text​

string

Returns​

Observable<SentenceToken[]>