IWritableKnowledgeBox
@nuclia/core / IWritableKnowledgeBox
Interface: IWritableKnowledgeBox
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:224
Extends
Properties
activityMonitor?
optionalactivityMonitor?:ActivityMonitor
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:227
admin?
optionaladmin?:boolean
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:225
allowed_ip_addresses?
optionalallowed_ip_addresses?:string[] |null
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:40
Inherited from
IKnowledgeBox.allowed_ip_addresses
allowed_origins?
optionalallowed_origins?:string[] |null
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:39
Inherited from
contrib?
optionalcontrib?:boolean
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:226
created?
optionalcreated?:string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:38
Inherited from
description?
optionaldescription?:string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:36
Inherited from
enforce_security?
optionalenforce_security?:boolean
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:44
Inherited from
IKnowledgeBox.enforce_security
external_index_provider?
optionalexternal_index_provider?:string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:45
Inherited from
IKnowledgeBox.external_index_provider
hidden_resources_enabled?
optionalhidden_resources_enabled?:boolean
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:42
Inherited from
IKnowledgeBox.hidden_resources_enabled
hidden_resources_hide_on_creation?
optionalhidden_resources_hide_on_creation?:boolean
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:43
Inherited from
IKnowledgeBox.hidden_resources_hide_on_creation
id
id:
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:32
Inherited from
search_configs?
optionalsearch_configs?:object
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:41
Index Signature
[key: string]: any
Inherited from
slug
slug:
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:33
Inherited from
state?
optionalstate?:KBStates
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:35
Inherited from
syncManager
syncManager:
SyncManager
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:229
taskManager
taskManager:
TaskManager
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:228
title
title:
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:34
Inherited from
zone
zone:
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:37
Inherited from
Accessors
fullpath
Get Signature
get fullpath():
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:102
Returns
string
Inherited from
path
Get Signature
get path():
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:100
Returns
string
Inherited from
Methods
addVectorset()
addVectorset(
model):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:277
Parameters
model
string
Returns
Observable<void>
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?
features?
Features[]
options?
Returns
Observable<Answer | IErrorResponse>
Inherited from
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?
features?
Features[]
options?
callback?
(answer) => void
Returns
Observable<Answer | IErrorResponse>
Inherited from
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?
Returns
Observable<IErrorResponse | AragResponse>
Inherited from
batchUpload()
batchUpload(
files):Observable<UploadStatus>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:257
Parameters
files
FileList | File[] | FileWithMetadata[]
Returns
Observable<UploadStatus>
catalog()
catalog(
query,options?):Observable<IErrorResponse|Results>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:175
Parameters
query
string
options?
Returns
Observable<IErrorResponse | Results>
Inherited from
counters()
counters():
Observable<Counters>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:186
Returns
Observable<Counters>
Inherited from
createAgenticConfig()
createAgenticConfig(
id,config):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:295
Parameters
id
string
config
Returns
Observable<void>
createAgenticRAGPipeline()
createAgenticRAGPipeline(
steps):Pipeline
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:120
Parameters
steps
Returns
Inherited from
IKnowledgeBox.createAgenticRAGPipeline
createAgenticSource()
createAgenticSource(
id,source):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:301
Parameters
id
string
source
Returns
Observable<void>
createExtractStrategy()
createExtractStrategy(
config):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:281
Parameters
config
Returns
Observable<void>
createKey()
createKey(
serviceAccountId,expires):Observable<{token:string; }>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:267
Parameters
serviceAccountId
string
expires
string
Returns
Observable<{ token: string; }>
createKeyForService()
createKeyForService(
data,expires):Observable<{token:string; }>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:265
Parameters
data
expires
string
Returns
Observable<{ token: string; }>
createLinkResource()
createLinkResource(
link,metadata?,synchronous?,origin?):Observable<{uuid:string; }>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:243
Parameters
link
metadata?
synchronous?
boolean
origin?
Returns
Observable<{ uuid: string; }>
createResource()
createResource(
resource,synchronous):Observable<{uuid:string; }>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:241
Parameters
resource
synchronous
boolean
Returns
Observable<{ uuid: string; }>
createSearchConfig()
createSearchConfig(
id,config):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:289
Parameters
id
string
config
Returns
Observable<void>
createServiceAccount()
createServiceAccount(
data):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:261
Parameters
data
Returns
Observable<void>
createSplitStrategy()
createSplitStrategy(
strategy):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:285
Parameters
strategy
Returns
Observable<void>
delete()
delete():
Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:235
Returns
Observable<void>
deleteAgenticConfig()
deleteAgenticConfig(
id):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:299
Parameters
id
string
Returns
Observable<void>
deleteAgenticSource()
deleteAgenticSource(
id):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:305
Parameters
id
string
Returns
Observable<void>
deleteExtractStrategy()
deleteExtractStrategy(
id):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:283
Parameters
id
string
Returns
Observable<void>
deleteKey()
deleteKey(
serviceAccountId,serviceAccountKeyId):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:269
Parameters
serviceAccountId
string
serviceAccountKeyId
string
Returns
Observable<void>
deleteLabelSet()
deleteLabelSet(
setId):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:239
Parameters
setId
string
Returns
Observable<void>
deleteProcessingHook()
deleteProcessingHook():
Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:309
Returns
Observable<void>
deleteSearchConfig()
deleteSearchConfig(
id):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:293
Parameters
id
string
Returns
Observable<void>
deleteServiceAccount()
deleteServiceAccount(
serviceAccountId):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:263
Parameters
serviceAccountId
string
Returns
Observable<void>
deleteSplitStrategy()
deleteSplitStrategy(
id):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:287
Parameters
id
string
Returns
Observable<void>
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>
Inherited from
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?
Returns
Observable<FindResults | IErrorResponse>
Inherited from
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; }>
Inherited from
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; }>
Inherited from
generateRandomQuestionAboutResource()
generateRandomQuestionAboutResource(
resource):Observable<string>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:173
Parameters
resource
Returns
Observable<string>
Inherited from
IKnowledgeBox.generateRandomQuestionAboutResource
getAgenticConfig()
getAgenticConfig(
id):Observable<AgenticConfig>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:216
Parameters
id
string
Returns
Observable<AgenticConfig>
Inherited from
IKnowledgeBox.getAgenticConfig
getAgenticSource()
getAgenticSource(
id):Observable<AgenticSource>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:218
Parameters
id
string
Returns
Observable<AgenticSource>
Inherited from
IKnowledgeBox.getAgenticSource
getConfiguration()
getConfiguration():
Observable<{[id:string]:any; }>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:193
Returns
Observable<{[id: string]: any; }>
Inherited from
IKnowledgeBox.getConfiguration
getEntities()
getEntities():
Observable<Entities>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:104
Returns
Observable<Entities>
Inherited from
getEntitiesGroup()
getEntitiesGroup(
groupId):Observable<EntitiesGroup>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:106
Parameters
groupId
string
Returns
Observable<EntitiesGroup>
Inherited from
IKnowledgeBox.getEntitiesGroup
getExtractStrategies()
getExtractStrategies():
Observable<ExtractStrategies>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:211
Returns
Observable<ExtractStrategies>
Inherited from
IKnowledgeBox.getExtractStrategies
getFacets()
getFacets(
facets):Observable<FacetsResult>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:108
Parameters
facets
string[]
Returns
Observable<FacetsResult>
Inherited from
getFullResource()
getFullResource(
uuid):Observable<IResource>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:114
Parameters
uuid
string
Returns
Observable<IResource>
Inherited from
getFullResourceBySlug()
getFullResourceBySlug(
slug):Observable<IResource>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:118
Parameters
slug
string
Returns
Observable<IResource>
Inherited from
IKnowledgeBox.getFullResourceBySlug
getGenerativeProviders()
getGenerativeProviders():
Observable<GenerativeProviders>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:195
Returns
Observable<GenerativeProviders>
Inherited from
IKnowledgeBox.getGenerativeProviders
getLabels()
getLabels():
Observable<LabelSets>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:110
Returns
Observable<LabelSets>
Inherited from
getLearningSchema()
getLearningSchema():
Observable<LearningConfigurations>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:194
Returns
Observable<LearningConfigurations>
Inherited from
IKnowledgeBox.getLearningSchema
getProcessingHook()
getProcessingHook():
Observable<ProcessingHook|undefined>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:221
Returns
Observable<ProcessingHook | undefined>
Inherited from
IKnowledgeBox.getProcessingHook
getResource()
getResource(
uuid,show?,extracted?):Observable<IResource>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:112
Parameters
uuid
string
show?
extracted?
Returns
Observable<IResource>
Inherited from
getResourceBySlug()
getResourceBySlug(
slug,show?,extracted?):Observable<IResource>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:116
Parameters
slug
string
show?
extracted?
Returns
Observable<IResource>
Inherited from
IKnowledgeBox.getResourceBySlug
getSearchConfig()
getSearchConfig(
id):Observable<SearchConfig>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:209
Parameters
id
string
Returns
Observable<SearchConfig>
Inherited from
getSearchConfigs()
getSearchConfigs():
Observable<SearchConfigs>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:215
Returns
Observable<SearchConfigs>
Inherited from
IKnowledgeBox.getSearchConfigs
getServiceAccounts()
getServiceAccounts():
Observable<ServiceAccount[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:259
Returns
Observable<ServiceAccount[]>
getSplitStrategies()
getSplitStrategies():
Observable<SplitStrategies>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:213
Returns
Observable<SplitStrategies>
Inherited from
IKnowledgeBox.getSplitStrategies
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>
Inherited from
getUsers()
getUsers(
accountSlug):Observable<FullKbUser[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:197
Parameters
accountSlug
string
Returns
Observable<FullKbUser[]>
Inherited from
inviteToKb()
inviteToKb(
data):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:275
Parameters
data
Returns
Observable<void>
listAgenticConfigs()
listAgenticConfigs():
Observable<AgenticConfigs>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:217
Returns
Observable<AgenticConfigs>
Inherited from
IKnowledgeBox.listAgenticConfigs
listAgenticSources()
listAgenticSources():
Observable<AgenticSources>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:219
Returns
Observable<AgenticSources>
Inherited from
IKnowledgeBox.listAgenticSources
listenToAllNotifications()
listenToAllNotifications():
Observable<NotificationMessage[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:199
Returns
Observable<NotificationMessage[]>
Inherited from
IKnowledgeBox.listenToAllNotifications
listenToProcessingNotifications()
listenToProcessingNotifications():
Observable<ResourceBaseNotification[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:200
Returns
Observable<ResourceBaseNotification[]>
Inherited from
IKnowledgeBox.listenToProcessingNotifications
listenToResourceOperationNotifications()
listenToResourceOperationNotifications():
Observable<ResourceOperationNotification[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:201
Returns
Observable<ResourceOperationNotification[]>
Inherited from
IKnowledgeBox.listenToResourceOperationNotifications
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>
Inherited from
modify()
modify(
data):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:231
Parameters
data
Partial<IKnowledgeBox>
Returns
Observable<void>
predictAnswer()
predictAnswer(
question,options?):Observable<Answer|IErrorResponse>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:161
Parameters
question
string
options?
Returns
Observable<Answer | IErrorResponse>
Inherited from
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[]; }>
Inherited from
IKnowledgeBox.processingStatus
publish()
publish(
published):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:233
Parameters
published
boolean
Returns
Observable<void>
removeVectorset()
removeVectorset(
model):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:279
Parameters
model
string
Returns
Observable<void>
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>
Inherited from
search()
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?
Returns
Observable<IErrorResponse | Results>
Inherited from
setConfiguration()
setConfiguration(
config):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:271
Parameters
config
Returns
Observable<void>
setLabelSet()
setLabelSet(
setId,labelSet):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:237
Parameters
setId
string
labelSet
Returns
Observable<void>
stopListeningToNotifications()
stopListeningToNotifications():
void
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:202
Returns
void
Inherited from
IKnowledgeBox.stopListeningToNotifications
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?
options?
Returns
Observable<IErrorResponse | Suggestions>
Inherited from
summarize()
summarize(
ressourceIds):Observable<string>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:157
Parameters
ressourceIds
string[]
Returns
Observable<string>
Inherited from
tokens()
tokens(
text):Observable<SentenceToken[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:159
Parameters
text
string
Returns
Observable<SentenceToken[]>
Inherited from
updateAgenticConfig()
updateAgenticConfig(
id,config):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:297
Parameters
id
string
config
Returns
Observable<void>
updateAgenticSource()
updateAgenticSource(
id,source):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:303
Parameters
id
string
source
Returns
Observable<void>
updateProcessingHook()
updateProcessingHook(
data):Observable<ProcessingHook>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:307
Parameters
data
Returns
Observable<ProcessingHook>
updateSearchConfig()
updateSearchConfig(
id,config):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:291
Parameters
id
string
config
Returns
Observable<void>
updateUsers()
updateUsers(
data):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:273
Parameters
data
Returns
Observable<void>
upload()
Call Signature
upload(
file,TUS?,metadata?):Observable<UploadResponse>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:250
Parameters
file
File | FileWithMetadata
TUS?
boolean
metadata?
Returns
Observable<UploadResponse>
Call Signature
upload(
buffer,TUS?,metadata?):Observable<UploadResponse>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:251
Parameters
buffer
ArrayBuffer
TUS?
boolean
metadata?
Returns
Observable<UploadResponse>
Call Signature
upload(
data,TUS?,metadata?):Observable<UploadResponse>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:252
Parameters
data
File | FileWithMetadata | ArrayBuffer
TUS?
boolean
metadata?
Returns
Observable<UploadResponse>