IWritableKnowledgeBox

@nuclia/core • Docs

---

@nuclia/core / IWritableKnowledgeBox

Interface: IWritableKnowledgeBox

Extends

• IKnowledgeBox

Properties

activityMonitor?

optional activityMonitor: ActivityMonitor

Defined in

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

---

admin?

optional admin: boolean

Defined in

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

---

allowed_ip_addresses?

optional allowed_ip_addresses: null | string[]

Inherited from

IKnowledgeBox.allowed_ip_addresses

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:30

---

allowed_origins?

optional allowed_origins: null | string[]

Inherited from

IKnowledgeBox.allowed_origins

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:29

---

contrib?

optional contrib: boolean

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:198

---

created?

optional created: string

Inherited from

IKnowledgeBox.created

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:28

---

description?

optional description: string

Inherited from

IKnowledgeBox.description

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:26

---

enforce_security?

optional enforce_security: boolean

Inherited from

IKnowledgeBox.enforce_security

Defined in

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

---

external_index_provider?

optional external_index_provider: string

Inherited from

IKnowledgeBox.external_index_provider

Defined in

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

---

hidden_resources_enabled?

optional hidden_resources_enabled: boolean

Inherited from

IKnowledgeBox.hidden_resources_enabled

Defined in

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

---

hidden_resources_hide_on_creation?

optional hidden_resources_hide_on_creation: boolean

Inherited from

IKnowledgeBox.hidden_resources_hide_on_creation

Defined in

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

---

id

id: string

Inherited from

IKnowledgeBox.id

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:22

---

search_configs?

optional search_configs: object

Index Signature

[key: string]: any

Inherited from

IKnowledgeBox.search_configs

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:31

---

slug

slug: string

Inherited from

IKnowledgeBox.slug

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:23

---

state?

optional state: KBStates

Inherited from

IKnowledgeBox.state

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:25

---

syncManager

syncManager: SyncManager

Defined in

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

---

taskManager

taskManager: TaskManager

Defined in

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

---

title

title: string

Inherited from

IKnowledgeBox.title

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:24

---

zone

zone: string

Inherited from

IKnowledgeBox.zone

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:27

Accessors

fullpath

get fullpath(): string

Returns

string

Inherited from

IKnowledgeBox.fullpath

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:92

---

path

get path(): string

Returns

string

Inherited from

IKnowledgeBox.path

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:90

Methods

addVectorset()

addVectorset(model): Observable<void>

Parameters

• model: string

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:260

---

ask()

ask(query, context, features, options)

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

Parameters

• query: string

• context?: ContextEntry[]

• features?: Features[]

• options?: ChatOptions

Returns

Observable<Answer | IErrorResponse>

Inherited from

IKnowledgeBox.ask

Defined in

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

ask(query, context, features, options, callback)

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

Parameters

• query: string

• context?: ContextEntry[]

• features?: Features[]

• options?: ChatOptions

• callback?

Returns

Observable<Answer | IErrorResponse>

Inherited from

IKnowledgeBox.ask

Defined in

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

---

batchUpload()

batchUpload(files): Observable<UploadStatus>

Parameters

• files: FileList | File[] | FileWithMetadata[]

Returns

Observable<UploadStatus>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:240

---

catalog()

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

Parameters

• query: string

• options?: CatalogOptions

Returns

Observable<Results | IErrorResponse>

Inherited from

IKnowledgeBox.catalog

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:158

---

counters()

counters(): Observable<Counters>

Returns

Observable<Counters>

Inherited from

IKnowledgeBox.counters

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:164

---

createAgenticRAGPipeline()

createAgenticRAGPipeline(steps): Pipeline

Parameters

• steps: Steps

Returns

Pipeline

Inherited from

IKnowledgeBox.createAgenticRAGPipeline

Defined in

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

---

createExtractStrategy()

createExtractStrategy(config): Observable<void>

Parameters

• config: ExtractConfig

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:264

---

createKey()

createKey(serviceAccountId, expires): Observable<object>

Parameters

• serviceAccountId: string

• expires: string

Returns

Observable<object>

token

token: string

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:250

---

createKeyForService()

createKeyForService(data, expires): Observable<object>

Parameters

• data: ServiceAccountCreation

• expires: string

Returns

Observable<object>

token

token: string

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:248

---

createLinkResource()

createLinkResource(link, metadata?, synchronous?, origin?): Observable<object>

Parameters

• link: LinkField

• metadata?: UserMetadata

• synchronous?: boolean

• origin?: Origin

Returns

Observable<object>

uuid

uuid: string

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:226

---

createResource()

createResource(resource, synchronous): Observable<object>

Parameters

• resource: IResource

• synchronous: boolean

Returns

Observable<object>

uuid

uuid: string

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:224

---

createSearchConfig()

createSearchConfig(id, config): Observable<void>

Parameters

• id: string

• config: SearchConfig

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:272

---

createServiceAccount()

createServiceAccount(data): Observable<void>

Parameters

• data: ServiceAccountCreation

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:244

---

createSplitStrategy()

createSplitStrategy(strategy): Observable<void>

Parameters

• strategy: SplitStrategy

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:268

---

delete()

delete(): Observable<void>

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:207

---

deleteAllSynonyms()

deleteAllSynonyms(): Observable<void>

Returns

Observable<void>

Deprecated

Will be removed in version 1.18.0

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:222

---

deleteExtractStrategy()

deleteExtractStrategy(id): Observable<void>

Parameters

• id: string

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:266

---

deleteKey()

deleteKey(serviceAccountId, serviceAccountKeyId): Observable<void>

Parameters

• serviceAccountId: string

• serviceAccountKeyId: string

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:252

---

deleteLabelSet()

deleteLabelSet(setId): Observable<void>

Parameters

• setId: string

Returns

Observable<void>

Defined in

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

---

deleteSearchConfig()

deleteSearchConfig(id): Observable<void>

Parameters

• id: string

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:276

---

deleteServiceAccount()

deleteServiceAccount(serviceAccountId): Observable<void>

Parameters

• serviceAccountId: string

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:246

---

deleteSplitStrategy()

deleteSplitStrategy(id): Observable<void>

Parameters

• id: string

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:270

---

feedback()

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

Parameters

• answerId: string

• good: boolean

• feedback?: string

• text_block_id?: string

Returns

Observable<void>

Inherited from

IKnowledgeBox.feedback

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:162

---

find()

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

Parameters

• query: string

• features?: Features[]

• options?: SearchOptions

Returns

Observable<FindResults | IErrorResponse>

Inherited from

IKnowledgeBox.find

Defined in

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

---

generate()

generate(question, context): Observable<object>

Parameters

• question: string

• context: string[]

Returns

Observable<object>

answer

answer: string

cannotAnswer

cannotAnswer: boolean

Inherited from

IKnowledgeBox.generate

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:146

---

generateJSON()

generateJSON(question, json_schema, context): Observable<object>

Parameters

• question: string

• json_schema: object

• context: string[]

Returns

Observable<object>

answer

answer: object

success

success: boolean

Inherited from

IKnowledgeBox.generateJSON

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:148

---

generateRandomQuestionAboutResource()

generateRandomQuestionAboutResource(resource): Observable<string>

Parameters

• resource: Resource

Returns

Observable<string>

Inherited from

IKnowledgeBox.generateRandomQuestionAboutResource

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:156

---

getConfiguration()

getConfiguration(): Observable<object>

Returns

Observable<object>

Inherited from

IKnowledgeBox.getConfiguration

Defined in

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

---

getEntities()

getEntities(): Observable<Entities>

Returns

Observable<Entities>

Inherited from

IKnowledgeBox.getEntities

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:94

---

getEntitiesGroup()

getEntitiesGroup(groupId): Observable<EntitiesGroup>

Parameters

• groupId: string

Returns

Observable<EntitiesGroup>

Inherited from

IKnowledgeBox.getEntitiesGroup

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:96

---

getExtractStrategies()

getExtractStrategies(): Observable<ExtractStrategies>

Returns

Observable<ExtractStrategies>

Inherited from

IKnowledgeBox.getExtractStrategies

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:189

---

getFacets()

getFacets(facets): Observable<FacetsResult>

Parameters

• facets: string[]

Returns

Observable<FacetsResult>

Inherited from

IKnowledgeBox.getFacets

Defined in

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

---

getFullResource()

getFullResource(uuid): Observable<IResource>

Parameters

• uuid: string

Returns

Observable<IResource>

Inherited from

IKnowledgeBox.getFullResource

Defined in

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

---

getFullResourceBySlug()

getFullResourceBySlug(slug): Observable<IResource>

Parameters

• slug: string

Returns

Observable<IResource>

Inherited from

IKnowledgeBox.getFullResourceBySlug

Defined in

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

---

getGenerativeProviders()

getGenerativeProviders(): Observable<GenerativeProviders>

Returns

Observable<GenerativeProviders>

Inherited from

IKnowledgeBox.getGenerativeProviders

Defined in

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

---

getLabels()

getLabels(): Observable<LabelSets>

Returns

Observable<LabelSets>

Inherited from

IKnowledgeBox.getLabels

Defined in

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

---

getLearningSchema()

getLearningSchema(): Observable<LearningConfigurations>

Returns

Observable<LearningConfigurations>

Inherited from

IKnowledgeBox.getLearningSchema

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:172

---

getResource()

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

Parameters

• uuid: string

• show?: ResourceProperties[]

• extracted?: ExtractedDataTypes[]

Returns

Observable<IResource>

Inherited from

IKnowledgeBox.getResource

Defined in

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

---

getResourceBySlug()

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

Parameters

• slug: string

• show?: ResourceProperties[]

• extracted?: ExtractedDataTypes[]

Returns

Observable<IResource>

Inherited from

IKnowledgeBox.getResourceBySlug

Defined in

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

---

getSearchConfig()

getSearchConfig(id): Observable<SearchConfig>

Parameters

• id: string

Returns

Observable<SearchConfig>

Inherited from

IKnowledgeBox.getSearchConfig

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:187

---

getSearchConfigs()

getSearchConfigs(): Observable<SearchConfigs>

Returns

Observable<SearchConfigs>

Inherited from

IKnowledgeBox.getSearchConfigs

Defined in

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

---

getServiceAccounts()

getServiceAccounts(): Observable<ServiceAccount[]>

Returns

Observable<ServiceAccount[]>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:242

---

getSplitStrategies()

getSplitStrategies(): Observable<SplitStrategies>

Returns

Observable<SplitStrategies>

Inherited from

IKnowledgeBox.getSplitStrategies

Defined in

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

---

getSynonyms()

getSynonyms(): Observable<Synonyms>

Returns

Observable<Synonyms>

Inherited from

IKnowledgeBox.getSynonyms

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:98

---

getTempToken()

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

Parameters

• payload?: any

• ignoreExpiration?: boolean

Returns

Observable<string>

Inherited from

IKnowledgeBox.getTempToken

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:169

---

getUsers()

getUsers(accountSlug): Observable<FullKbUser[]>

Parameters

• accountSlug: string

Returns

Observable<FullKbUser[]>

Inherited from

IKnowledgeBox.getUsers

Defined in

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

---

inviteToKb()

inviteToKb(data): Observable<void>

Parameters

• data: InviteKbData

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:258

---

listenToAllNotifications()

listenToAllNotifications(): Observable<NotificationMessage[]>

Returns

Observable<NotificationMessage[]>

Inherited from

IKnowledgeBox.listenToAllNotifications

Defined in

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

---

listenToProcessingNotifications()

listenToProcessingNotifications(): Observable<ResourceBaseNotification[]>

Returns

Observable<ResourceBaseNotification[]>

Inherited from

IKnowledgeBox.listenToProcessingNotifications

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:178

---

listenToResourceOperationNotifications()

listenToResourceOperationNotifications(): Observable<ResourceOperationNotification[]>

Returns

Observable<ResourceOperationNotification[]>

Inherited from

IKnowledgeBox.listenToResourceOperationNotifications

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:179

---

listResources()

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

Parameters

• page?: number

• size?: number

Returns

Observable<ResourceList>

Inherited from

IKnowledgeBox.listResources

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:166

---

modify()

modify(data): Observable<void>

Parameters

• data: Partial<IKnowledgeBox>

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:203

---

predictAnswer()

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

Parameters

• question: string

• options?: PredictAnswerOptions

Returns

Observable<Answer | IErrorResponse>

Inherited from

IKnowledgeBox.predictAnswer

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:144

---

processingStatus()

processingStatus(cursor?, scheduled?, limit?): Observable<object>

Parameters

• cursor?: string

• scheduled?: boolean

• limit?: number

Returns

Observable<object>

cursor

cursor: string

results

results: ProcessingStatus[]

Inherited from

IKnowledgeBox.processingStatus

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:182

---

publish()

publish(published): Observable<void>

Parameters

• published: boolean

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:205

---

removeVectorset()

removeVectorset(model): Observable<void>

Parameters

• model: string

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:262

---

rephrase()

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

Parameters

• question: string

• user_context?: string[]

• rephrase_prompt?: string

Returns

Observable<string>

Inherited from

IKnowledgeBox.rephrase

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:154

---

search()

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

Parameters

• query: string

• features?: Features[]

• options?: SearchOptions

Returns

Observable<Results | IErrorResponse>

Inherited from

IKnowledgeBox.search

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:134

---

setConfiguration()

setConfiguration(config): Observable<void>

Parameters

• config

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:254

---

setLabelSet()

setLabelSet(setId, labelSet): Observable<void>

Parameters

• setId: string

• labelSet: LabelSet

Returns

Observable<void>

Defined in

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

---

setSynonyms()

setSynonyms(synonyms): Observable<void>

Parameters

• synonyms: Synonyms

Returns

Observable<void>

Deprecated

Will be removed in version 1.18.0

Defined in

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

---

stopListeningToNotifications()

stopListeningToNotifications(): void

Returns

void

Inherited from

IKnowledgeBox.stopListeningToNotifications

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:180

---

suggest()

suggest(query): Observable<Suggestions | IErrorResponse>

Parameters

• query: string

Returns

Observable<Suggestions | IErrorResponse>

Inherited from

IKnowledgeBox.suggest

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:160

---

summarize()

summarize(ressourceIds): Observable<string>

Parameters

• ressourceIds: string[]

Returns

Observable<string>

Inherited from

IKnowledgeBox.summarize

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:140

---

tokens()

tokens(text): Observable<SentenceToken[]>

Parameters

• text: string

Returns

Observable<SentenceToken[]>

Inherited from

IKnowledgeBox.tokens

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:142

---

updateSearchConfig()

updateSearchConfig(id, config): Observable<void>

Parameters

• id: string

• config: SearchConfig

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:274

---

updateUsers()

updateUsers(data): Observable<void>

Parameters

• data: KbUserPayload

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:256

---

upload()

upload(file, TUS, metadata)

upload(file, TUS?, metadata?): Observable<UploadResponse>

Parameters

• file: File | FileWithMetadata

• TUS?: boolean

• metadata?: FileMetadata

Returns

Observable<UploadResponse>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:233

upload(buffer, TUS, metadata)

upload(buffer, TUS?, metadata?): Observable<UploadResponse>

Parameters

• buffer: ArrayBuffer

• TUS?: boolean

• metadata?: FileMetadata

Returns

Observable<UploadResponse>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:234

upload(data, TUS, metadata)

upload(data, TUS?, metadata?): Observable<UploadResponse>

Parameters

• data: ArrayBuffer | File | FileWithMetadata

• TUS?: boolean

• metadata?: FileMetadata

Returns

Observable<UploadResponse>

Defined in

libs/sdk-core/src/lib/db/kb/kb.models.ts:235