Skip to main content

RetrievalAgent

@nuclia/core

@nuclia/core / RetrievalAgent

Class: RetrievalAgent

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:45

Provides access to all the Retrieval Agent contents and services.

Extends​

Implements​

Constructors​

Constructor​

new RetrievalAgent(nuclia, account, data): RetrievalAgent

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

Parameters​

nuclia​

INuclia

account​

string

data​

IKnowledgeBoxBase | IKnowledgeBoxStandalone

Returns​

RetrievalAgent

Inherited from​

WritableKnowledgeBox.constructor

Properties​

accountId​

accountId: string

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

Inherited from​

WritableKnowledgeBox.accountId

admin?​

optional admin?: boolean

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

True if the current user is an administrator of the Knowledge Box.

Implementation of​

IRetrievalAgent.admin

Inherited from​

WritableKnowledgeBox.admin

allowed_ip_addresses?​

optional allowed_ip_addresses?: string[] | null

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

Implementation of​

IRetrievalAgent.allowed_ip_addresses

Inherited from​

WritableKnowledgeBox.allowed_ip_addresses

allowed_origins?​

optional allowed_origins?: string[] | null

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

Implementation of​

IRetrievalAgent.allowed_origins

Inherited from​

WritableKnowledgeBox.allowed_origins

contrib?​

optional contrib?: boolean

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

True if the current user is a contributor of the Knowledge Box.

Implementation of​

IRetrievalAgent.contrib

Inherited from​

WritableKnowledgeBox.contrib

created?​

optional created?: string

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

Implementation of​

IRetrievalAgent.created

Inherited from​

WritableKnowledgeBox.created

description?​

optional description?: string

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

Implementation of​

IRetrievalAgent.description

Inherited from​

WritableKnowledgeBox.description

enforce_security?​

optional enforce_security?: boolean

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

Implementation of​

IRetrievalAgent.enforce_security

Inherited from​

WritableKnowledgeBox.enforce_security

external_index_provider?​

optional external_index_provider?: string

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

Implementation of​

IRetrievalAgent.external_index_provider

Inherited from​

WritableKnowledgeBox.external_index_provider

hidden_resources_enabled?​

optional hidden_resources_enabled?: boolean

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

Implementation of​

IRetrievalAgent.hidden_resources_enabled

Inherited from​

WritableKnowledgeBox.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

Implementation of​

IRetrievalAgent.hidden_resources_hide_on_creation

Inherited from​

WritableKnowledgeBox.hidden_resources_hide_on_creation

id​

id: string

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

Implementation of​

IRetrievalAgent.id

Inherited from​

WritableKnowledgeBox.id

nuclia​

protected nuclia: INuclia

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

Inherited from​

WritableKnowledgeBox.nuclia

search_configs?​

optional search_configs?: object

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

Index Signature​

[key: string]: any

Implementation of​

IRetrievalAgent.search_configs

Inherited from​

WritableKnowledgeBox.search_configs

slug​

slug: string

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

Implementation of​

IRetrievalAgent.slug

Inherited from​

WritableKnowledgeBox.slug

state?​

optional state?: KBStates

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

Implementation of​

IRetrievalAgent.state

Inherited from​

WritableKnowledgeBox.state

title​

title: string

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

Implementation of​

IRetrievalAgent.title

Inherited from​

WritableKnowledgeBox.title

wsOpeningCount​

wsOpeningCount: number = 0

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:144

zone​

zone: string

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

Implementation of​

IRetrievalAgent.zone

Inherited from​

WritableKnowledgeBox.zone

Accessors​

activityMonitor​

Get Signature​

get activityMonitor(): ActivityMonitor

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

Returns​

ActivityMonitor

Implementation of​

IRetrievalAgent.activityMonitor

Inherited from​

WritableKnowledgeBox.activityMonitor

fullpath​

Get Signature​

get fullpath(): string

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:59

The Retrieval Agent fullpath on the regional API.

Returns​

string

Implementation of​

IRetrievalAgent.fullpath

Overrides​

WritableKnowledgeBox.fullpath

path​

Get Signature​

get path(): string

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:52

The Retrieval Agent path on the regional API.

Returns​

string

Implementation of​

IRetrievalAgent.path

Overrides​

WritableKnowledgeBox.path

syncManager​

Get Signature​

get syncManager(): ISyncManager

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

Returns​

ISyncManager

Implementation of​

IRetrievalAgent.syncManager

Inherited from​

WritableKnowledgeBox.syncManager

taskManager​

Get Signature​

get taskManager(): TaskManager

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

Entry point to task manager

Returns​

TaskManager

Implementation of​

IRetrievalAgent.taskManager

Inherited from​

WritableKnowledgeBox.taskManager

training​

Get Signature​

get training(): Training

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

Deprecated​
Returns​

Training

Inherited from​

WritableKnowledgeBox.training

Methods​

addContext()​

addContext(agent, workflowId?): Observable<{ id: string; }>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:427

Add a context agent to a workflow.

Parameters​

agent​

ContextAgentCreation

data representing the context agent to add

workflowId?​

string = 'default'

Returns​

Observable<{ id: string; }>

An observable providing the created agent id.

Implementation of​

IRetrievalAgent.addContext

addDriver()​

addDriver(driver): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:336

Add driver to the Retrieval Agent

Parameters​

driver​

DriverCreation

BraveDriver | CypherDriver | NucliaDBDriver | PerplexityDriver | TavilyDriver | SqlDriver | McpDriver

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.addDriver

addGeneration()​

addGeneration(agent, workflowId?): Observable<{ id: string; }>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:464

Add a generation agent to a workflow.

Parameters​

agent​

GenerationAgentCreation

data representing the generation agent to add.

workflowId?​

string = 'default'

Returns​

Observable<{ id: string; }>

An observable providing the created agent id.

Implementation of​

IRetrievalAgent.addGeneration

addPostprocess()​

addPostprocess(agent, workflowId?): Observable<{ id: string; }>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:501

Add a postprocess agent to a workflow.

Parameters​

agent​

PostprocessAgentCreation

data representing the postprocess agent to add

workflowId?​

string = 'default'

Returns​

Observable<{ id: string; }>

An observable providing the created agent id.

Implementation of​

IRetrievalAgent.addPostprocess

addPreprocess()​

addPreprocess(agent, workflowId?): Observable<{ id: string; }>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:390

Add a preprocess agent to a workflow.

Parameters​

agent​

PreprocessAgentCreation

data representing the preprocess agent to add

workflowId?​

string = 'default'

Returns​

Observable<{ id: string; }>

An observable providing the created agent id.

Implementation of​

IRetrievalAgent.addPreprocess

addVectorset()​

addVectorset(model): Observable<void>

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

Add an embedding model to the Knowledge box

Parameters​

model​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.addVectorset

Inherited from​

WritableKnowledgeBox.addVectorset

ask()​

Call Signature​

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

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

Retrieves a generative answer for the given query.

The generative answer is a text that is generated chunk by chunk by the language model. It is retrieved through a readable HTTP stream, so the chat() method returns an Observable emitting a value each time a new chunk is available. The incomplete attribute of the emitted value indicates if the asnwer is complete or not.

Example:

 nuclia.knowledgeBox
   .ask('where does the Little Prince live')
   .pipe(filter((answer) => !answer.incomplete))
   .subscribe((answer) => {
     console.log(answer.text);
   });
Parameters​
query​

string

context?​

ContextEntry[]

features?​

Features[]

options?​

ChatOptions

Returns​

Observable<Answer | IErrorResponse>

Implementation of​

IRetrievalAgent.ask

Inherited from​

WritableKnowledgeBox.ask

Call Signature​

ask(query, context?, features?, options?, callback?): Observable<null>

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

Retrieves a generative answer for the given query.

The generative answer is a text that is generated chunk by chunk by the language model. It is retrieved through a readable HTTP stream, so the chat() method returns an Observable emitting a value each time a new chunk is available. The incomplete attribute of the emitted value indicates if the asnwer is complete or not.

Example:

 nuclia.knowledgeBox
   .ask('where does the Little Prince live')
   .pipe(filter((answer) => !answer.incomplete))
   .subscribe((answer) => {
     console.log(answer.text);
   });
Parameters​
query​

string

context?​

ContextEntry[]

features?​

Features[]

options?​

ChatOptions

callback?​

(answer) => void

Returns​

Observable<null>

Implementation of​

IRetrievalAgent.ask

Inherited from​

WritableKnowledgeBox.ask

askViaWS()​

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

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

Asks a question using an agentic pipeline (Rephrase → SmartAgent → Summarize) over WebSocket.

Requires an agentic_config_id that has been created via createAgenticConfig(). Set keepOpen: true to keep the connection open for follow-up questions.

Parameters​

agenticConfigId​

string

question​

string

keepOpen?​

boolean = false

searchConfiguration?​

string

groups?​

string[]

chatHistory?​

HistoryEntry[]

Returns​

Observable<IErrorResponse | AragResponse>

Implementation of​

IRetrievalAgent.askViaWS

Inherited from​

WritableKnowledgeBox.askViaWS

batchUpload()​

batchUpload(files): Observable<UploadStatus>

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

Uploads a list of files to the Knowledge Box. It automatically creates a new resource for each file and uses the TUS protocol to upload the files.

Parameters​

files​

FileList | File[] | FileWithMetadata[]

Returns​

Observable<UploadStatus>

Implementation of​

IRetrievalAgent.batchUpload

Inherited from​

WritableKnowledgeBox.batchUpload

catalog()​

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

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

Parameters​

query​

string | CatalogQuery

options?​

CatalogOptions

Returns​

Observable<IErrorResponse | Results>

Implementation of​

IRetrievalAgent.catalog

Inherited from​

WritableKnowledgeBox.catalog

counters()​

counters(): Observable<Counters>

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

Returns totals for each kind of contents stored in the Knowledge Box (resources, fields, paragraphs, vectors)

Returns​

Observable<Counters>

Implementation of​

IRetrievalAgent.counters

Inherited from​

WritableKnowledgeBox.counters

createAgenticConfig()​

createAgenticConfig(id, config): Observable<void>

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

Parameters​

id​

string

config​

AgenticConfig

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createAgenticConfig

Inherited from​

WritableKnowledgeBox.createAgenticConfig

createAgenticRAGPipeline()​

createAgenticRAGPipeline(steps): Pipeline

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

Parameters​

steps​

Steps

Returns​

Pipeline

Inherited from​

WritableKnowledgeBox.createAgenticRAGPipeline

createAgenticSource()​

createAgenticSource(id, source): Observable<void>

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

Parameters​

id​

string

source​

AgenticSource

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createAgenticSource

Inherited from​

WritableKnowledgeBox.createAgenticSource

createExtractStrategy()​

createExtractStrategy(config): Observable<void>

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

Parameters​

config​

ExtractConfig

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createExtractStrategy

Inherited from​

WritableKnowledgeBox.createExtractStrategy

createKey()​

createKey(saId, expires): Observable<{ token: string; }>

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

Parameters​

saId​

string

expires​

string

Returns​

Observable<{ token: string; }>

Implementation of​

IRetrievalAgent.createKey

Inherited from​

WritableKnowledgeBox.createKey

createKeyForService()​

createKeyForService(data, expires): Observable<{ token: string; }>

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

Parameters​

data​

ServiceAccountCreation

expires​

string

Returns​

Observable<{ token: string; }>

Implementation of​

IRetrievalAgent.createKeyForService

Inherited from​

WritableKnowledgeBox.createKeyForService

createKVSchema()​

createKVSchema(schema): Observable<void>

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

Creates a new KV schema in the Knowledge Box.

Parameters​

schema​

KVSchema

Returns​

Observable<void>

Inherited from​

WritableKnowledgeBox.createKVSchema

createLinkResource()​

createLinkResource(link, metadata?, synchronous?, origin?, slug?): Observable<{ uuid: string; }>

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

Creates a new link resource in the Knowledge Box more easily than using createResource.

Example:

nuclia.db
  .getKnowledgeBox('my-account', 'my-kb')
  .pipe(
    switchMap((knowledgeBox) =>
      knowledgeBox.createLinkResource(
        {
          uri: 'https://en.wikipedia.org/wiki/Hedy_Lamarr',
        },
        { classifications: [{ labelset: 'Genius', label: 'Inventor' }] },
      ),
    ),
  )
  .subscribe(() => {
    console.log('resource created');
  });

Parameters​

LinkField

metadata?​

UserMetadata

synchronous?​

boolean = true

origin?​

Origin

slug?​

string

Returns​

Observable<{ uuid: string; }>

Implementation of​

IRetrievalAgent.createLinkResource

Inherited from​

WritableKnowledgeBox.createLinkResource

createOrUpdateResource()​

createOrUpdateResource(data, synchronous?): Observable<void | { uuid: string; }>

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

Creates a resource or updates it if it already exists

Parameters​

data​

ICreateResource

synchronous?​

boolean = true

Returns​

Observable<void | { uuid: string; }>

Inherited from​

WritableKnowledgeBox.createOrUpdateResource

createResource()​

createResource(resource, synchronous?): Observable<{ uuid: string; }>

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

Creates and indexes a new resource in the Knowledge Box.

Parameters​

resource​

ICreateResource

synchronous?​

boolean = true

Returns​

Observable<{ uuid: string; }>

Implementation of​

IRetrievalAgent.createResource

Inherited from​

WritableKnowledgeBox.createResource

createSearchConfig()​

createSearchConfig(id, config): Observable<void>

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

Parameters​

id​

string

config​

SearchConfig

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createSearchConfig

Inherited from​

WritableKnowledgeBox.createSearchConfig

createServiceAccount()​

createServiceAccount(data): Observable<void>

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

Parameters​

data​

ServiceAccountCreation

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createServiceAccount

Inherited from​

WritableKnowledgeBox.createServiceAccount

createSession()​

createSession(session): Observable<SessionCreationResponse>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:105

Create sessions on the retrieval agent

Parameters​

session​

SessionCreation

Returns​

Observable<SessionCreationResponse>

Implementation of​

IRetrievalAgent.createSession

createSplitStrategy()​

createSplitStrategy(strategy): Observable<void>

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

Parameters​

strategy​

SplitStrategy

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createSplitStrategy

Inherited from​

WritableKnowledgeBox.createSplitStrategy

createWorkflow()​

createWorkflow(data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:593

Create a new workflow

Parameters​

data​

Workflow

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createWorkflow

delete()​

delete(): Observable<void>

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

Deletes the Knowledge Box.

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.delete

Inherited from​

WritableKnowledgeBox.delete

deleteAgenticConfig()​

deleteAgenticConfig(id): Observable<void>

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

Parameters​

id​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteAgenticConfig

Inherited from​

WritableKnowledgeBox.deleteAgenticConfig

deleteAgenticSource()​

deleteAgenticSource(id): Observable<void>

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

Parameters​

id​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteAgenticSource

Inherited from​

WritableKnowledgeBox.deleteAgenticSource

deleteContext()​

deleteContext(agentId, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:445

Delete a context agent from a workflow.

Parameters​

agentId​

string

Identifier of the agent to delete.

workflowId?​

string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteContext

deleteDriver()​

deleteDriver(driverId): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:352

Delete driver

Parameters​

driverId​

string

Identifier of the driver to delete

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteDriver

deleteExtractStrategy()​

deleteExtractStrategy(id): Observable<void>

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

Parameters​

id​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteExtractStrategy

Inherited from​

WritableKnowledgeBox.deleteExtractStrategy

deleteGeneration()​

deleteGeneration(agentId, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:482

Delete a generation agent from a workflow.

Parameters​

agentId​

string

Identifier of the agent to delete

workflowId?​

string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteGeneration

deleteInvite()​

deleteInvite(email): Observable<void>

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

Parameters​

email​

string

Returns​

Observable<void>

Inherited from​

WritableKnowledgeBox.deleteInvite

deleteKey()​

deleteKey(saId, saKeyId): Observable<void>

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

Parameters​

saId​

string

saKeyId​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteKey

Inherited from​

WritableKnowledgeBox.deleteKey

deleteKVSchema()​

deleteKVSchema(id): Observable<void>

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

Deletes a KV schema from the Knowledge Box.

Parameters​

id​

string

Returns​

Observable<void>

Inherited from​

WritableKnowledgeBox.deleteKVSchema

deleteLabelSet()​

deleteLabelSet(setId): Observable<void>

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

Deletes a label set.

Parameters​

setId​

string

Returns​

Observable<void>

Inherited from​

WritableKnowledgeBox.deleteLabelSet

deletePostprocess()​

deletePostprocess(agentId, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:519

Delete a postprocess agent from a workflow.

Parameters​

agentId​

string

Identifier of the agent to delete

workflowId?​

string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deletePostprocess

deletePreprocess()​

deletePreprocess(agentId, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:408

Delete a preprocess agent from a workflow.

Parameters​

agentId​

string

Identifier of the preprocess agent to delete

workflowId?​

string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deletePreprocess

deleteProcessingHook()​

deleteProcessingHook(): Observable<void>

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

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteProcessingHook

Inherited from​

WritableKnowledgeBox.deleteProcessingHook

deleteSearchConfig()​

deleteSearchConfig(id): Observable<void>

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

Parameters​

id​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteSearchConfig

Inherited from​

WritableKnowledgeBox.deleteSearchConfig

deleteServiceAccount()​

deleteServiceAccount(saId): Observable<void>

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

Parameters​

saId​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteServiceAccount

Inherited from​

WritableKnowledgeBox.deleteServiceAccount

deleteSplitStrategy()​

deleteSplitStrategy(id): Observable<void>

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

Parameters​

id​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteSplitStrategy

Inherited from​

WritableKnowledgeBox.deleteSplitStrategy

deleteWorkflow()​

deleteWorkflow(workflowId): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:607

Delete a workflow

Parameters​

workflowId​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteWorkflow

export()​

export(options): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:541

Request the export of a Retrieval Agent.

Parameters​

options​

ExportOptions

Export options

Returns​

Observable<void>

feedback()​

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

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

Parameters​

answerId​

string

good​

boolean

feedback?​

string = ''

text_block_id?​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.feedback

Inherited from​

WritableKnowledgeBox.feedback

find()​

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

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

Performs a find operation in the Knowledge Box, which is the recommended way to search for results.

Example:

nuclia.knowledgeBox
  .find('where does the Little Prince live')
  .subscribe((searchResult) => {
    console.log('search result', searchResult);
  });

Parameters​

query​

string

features?​

Features[] = []

options?​

SearchOptions

Returns​

Observable<FindResults | IErrorResponse>

Implementation of​

IRetrievalAgent.find

Inherited from​

WritableKnowledgeBox.find

generate()​

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

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

Performs a question answering operation based on a given context.

Example:

nuclia.knowledgeBox
  .generate('Who is Eric from Toronto?', [
    'Eric is a taxi driver',
    'Eric was born in France',
    'Eric lives in Toronto',
  ]))
  .subscribe(({ answer }) => {
    console.log('answer', answer);
  });

Parameters​

question​

string

context?​

string[] = []

Returns​

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

Implementation of​

IRetrievalAgent.generate

Inherited from​

WritableKnowledgeBox.generate

generateJSON()​

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

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

Performs a question answering operation using a JSON schema.

Example:

nuclia.knowledgeBox
  .generateJSON(
    'Who is Eric from Toronto?',
    {
      name: 'info',
      parameters: {
        properties: {
          location: {
            title: 'Location',
            description: 'The location of the person',
            type: 'string',
          },
          name: {
            title: 'Name',
            description: 'The name of the person',
            type: 'string',
          },
        },
        required: ['name', 'location'],
      },
    },
    [
      'Eric is a taxi driver',
      'Eric was born in France',
      'Eric lives in Toronto',
    ],
  )).subscribe((answer) => {
    console.log('location', answer.answer.location);
  });

Parameters​

question​

string

json_schema​

object

context?​

string[] = []

Returns​

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

Implementation of​

IRetrievalAgent.generateJSON

Inherited from​

WritableKnowledgeBox.generateJSON

generateRandomQuestionAboutResource()​

generateRandomQuestionAboutResource(resource): Observable<string>

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

Generates a random question about the given resource. It picks an entities relation from the extracted metadata and generates a question about it. It returns an empty string if no question can be generated. Example:

 nuclia.knowledgeBox
 .getResource('09a94719a6444c5a9689394f6ed9baf6', [ResourceProperties.EXTRACTED], [ExtractedDataTypes.METADATA])
 .pipe(
   switchMap((resource) => knowledgeBox.generateRandomQuestionAboutResource(resource)),
 )
 .subscribe((question) => {
   console.log('question', question);
 });

Parameters​

resource​

Resource

Returns​

Observable<string>

Inherited from​

WritableKnowledgeBox.generateRandomQuestionAboutResource

getAgenticConfig()​

getAgenticConfig(id): Observable<AgenticConfig>

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

Parameters​

id​

string

Returns​

Observable<AgenticConfig>

Implementation of​

IRetrievalAgent.getAgenticConfig

Inherited from​

WritableKnowledgeBox.getAgenticConfig

getAgenticConfigsSchema()​

getAgenticConfigsSchema(): Observable<LearningConfigurationSchema>

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

Returns​

Observable<LearningConfigurationSchema>

Inherited from​

WritableKnowledgeBox.getAgenticConfigsSchema

getAgenticSource()​

getAgenticSource(id): Observable<AgenticSource>

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

Parameters​

id​

string

Returns​

Observable<AgenticSource>

Implementation of​

IRetrievalAgent.getAgenticSource

Inherited from​

WritableKnowledgeBox.getAgenticSource

getAgentTempToken()​

getAgentTempToken(agent_session, ttl?): Observable<string>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:304

Parameters​

agent_session​

string

ttl?​

number

Returns​

Observable<string>

getConfiguration()​

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

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

Returns​

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

Implementation of​

IRetrievalAgent.getConfiguration

Inherited from​

WritableKnowledgeBox.getConfiguration

getContext()​

getContext(workflowId?): Observable<ContextAgent[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:417

Get the list of context agents from a workflow.

Parameters​

workflowId?​

string = 'default'

Returns​

Observable<ContextAgent[]>

The list of context agents

Implementation of​

IRetrievalAgent.getContext

getDownload()​

getDownload(requestId): Observable<DownloadStatus>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:579

Get the status of a download

Parameters​

requestId​

string

Returns​

Observable<DownloadStatus>

Implementation of​

IRetrievalAgent.getDownload

getDownloads()​

getDownloads(): Observable<DownloadStatus[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:571

Get the status of all downloads

Returns​

Observable<DownloadStatus[]>

Implementation of​

IRetrievalAgent.getDownloads

getDrivers()​

getDrivers(provider?): Observable<Driver[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:323

Get the list of drivers of the Retrieval Agent

Parameters​

provider?​

ProviderType

Optional parameter allowing to filter the drivers to get only the ones corresponding to the given provider type

Returns​

Observable<Driver[]>

Implementation of​

IRetrievalAgent.getDrivers

getEntities()​

getEntities(): Observable<Entities>

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

Returns all the NER families defined in the Knowledge Box.

Returns​

Observable<Entities>

Inherited from​

WritableKnowledgeBox.getEntities

getEntitiesGroup()​

getEntitiesGroup(groupId): Observable<EntitiesGroup>

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

Returns the NER family with the given id.

Parameters​

groupId​

string

Returns​

Observable<EntitiesGroup>

Inherited from​

WritableKnowledgeBox.getEntitiesGroup

getExtractStrategies()​

getExtractStrategies(): Observable<ExtractStrategies>

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

Returns​

Observable<ExtractStrategies>

Implementation of​

IRetrievalAgent.getExtractStrategies

Inherited from​

WritableKnowledgeBox.getExtractStrategies

getFacets()​

getFacets(facets): Observable<FacetsResult>

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

Get the total amount of matches in the Knowledge Box for specific criteria (facets) passed in argument

Parameters​

facets​

string[]

List of facets to request

Returns​

Observable<FacetsResult>

An observable containing an object where each key is a string and maps to an object containing values and their corresponding counts.

Implementation of​

IRetrievalAgent.getFacets

Inherited from​

WritableKnowledgeBox.getFacets

getFullResource()​

getFullResource(uuid): Observable<Resource>

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

Retrieves a resource from the Knowledge Box with all its attached metadata and content.

Parameters​

uuid​

string

Returns​

Observable<Resource>

Implementation of​

IRetrievalAgent.getFullResource

Inherited from​

WritableKnowledgeBox.getFullResource

getFullResourceBySlug()​

getFullResourceBySlug(slug): Observable<Resource>

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

Parameters​

slug​

string

Returns​

Observable<Resource>

Implementation of​

IRetrievalAgent.getFullResourceBySlug

Inherited from​

WritableKnowledgeBox.getFullResourceBySlug

getFullSchemas()​

getFullSchemas(): Observable<JSONSchema4>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:533

Returns​

Observable<JSONSchema4>

Deprecated​

Use getSchemas

Implementation of​

IRetrievalAgent.getFullSchemas

getGeneration()​

getGeneration(workflowId?): Observable<GenerationAgent[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:454

Get the list of generation agents from a workflow.

Parameters​

workflowId?​

string = 'default'

Returns​

Observable<GenerationAgent[]>

The list of generation agents

Implementation of​

IRetrievalAgent.getGeneration

getGenerativeProviders()​

getGenerativeProviders(): Observable<GenerativeProviders>

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

Returns​

Observable<GenerativeProviders>

Implementation of​

IRetrievalAgent.getGenerativeProviders

Inherited from​

WritableKnowledgeBox.getGenerativeProviders

getInvites()​

getInvites(): Observable<KbInvite[]>

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

Returns​

Observable<KbInvite[]>

Inherited from​

WritableKnowledgeBox.getInvites

getKbEndpointAndZone()​

protected getKbEndpointAndZone(): object

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

Returns​

object

endpoint​

endpoint: string

zone​

zone: string | undefined

Inherited from​

WritableKnowledgeBox.getKbEndpointAndZone

getKVSchema()​

getKVSchema(id): Observable<KVSchema>

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

Returns the KV schema with the given id.

Parameters​

id​

string

Returns​

Observable<KVSchema>

Inherited from​

WritableKnowledgeBox.getKVSchema

getKVSchemas()​

getKVSchemas(): Observable<KBKVSchemas>

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

Returns all the KV schemas defined in the Knowledge Box.

Returns​

Observable<KBKVSchemas>

Inherited from​

WritableKnowledgeBox.getKVSchemas

getLabels()​

getLabels(): Observable<LabelSets>

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

Returns all the labels defined in the Knowledge Box.

Returns​

Observable<LabelSets>

Inherited from​

WritableKnowledgeBox.getLabels

getLearningSchema()​

getLearningSchema(): Observable<LearningConfigurations>

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

Returns​

Observable<LearningConfigurations>

Implementation of​

IRetrievalAgent.getLearningSchema

Inherited from​

WritableKnowledgeBox.getLearningSchema

getPostprocess()​

getPostprocess(workflowId?): Observable<PostprocessAgent[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:491

Get the list of postprocess agents from a workflow.

Parameters​

workflowId?​

string = 'default'

Returns​

Observable<PostprocessAgent[]>

The list of postprocess agents

Implementation of​

IRetrievalAgent.getPostprocess

getPreprocess()​

getPreprocess(workflowId?): Observable<PreprocessAgent[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:380

Get the list of preprocess agents from a workflow.

Parameters​

workflowId?​

string = 'default'

Returns​

Observable<PreprocessAgent[]>

the list of preprocess agents

Implementation of​

IRetrievalAgent.getPreprocess

getProcessingHook()​

getProcessingHook(): Observable<ProcessingHook | undefined>

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

Returns​

Observable<ProcessingHook | undefined>

Implementation of​

IRetrievalAgent.getProcessingHook

Inherited from​

WritableKnowledgeBox.getProcessingHook

getResource()​

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

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

Retrieves a resource from the Knowledge Box.

  • show defines which properties are returned. Default retrieves only the basic metadata.
  • extracted defines which extracted data are returned. It is ignored if ResourceProperties.EXTRACTED is not in the returned properties. Default is an empty array.

Example:

nuclia.db
  .getKnowledgeBox()
  .pipe(switchMap((knowledgeBox) => knowledgeBox.getResource('09a94719a6444c5a9689394f6ed9baf6')))
  .subscribe((resource) => {
    console.log('resource', resource);
  });

Parameters​

uuid​

string

show?​

ResourceProperties[] = ...

extracted?​

ExtractedDataTypes[] = []

Returns​

Observable<Resource>

Implementation of​

IRetrievalAgent.getResource

Inherited from​

WritableKnowledgeBox.getResource

getResourceBySlug()​

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

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

Parameters​

slug​

string

show?​

ResourceProperties[] = ...

extracted?​

ExtractedDataTypes[] = []

Returns​

Observable<Resource>

Implementation of​

IRetrievalAgent.getResourceBySlug

Inherited from​

WritableKnowledgeBox.getResourceBySlug

getResourceFromData()​

getResourceFromData(data): Resource

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

Parameters​

data​

IResource

Returns​

Resource

Inherited from​

WritableKnowledgeBox.getResourceFromData

getRules()​

getRules(workflowId?): Observable<(string | Rule)[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:360

Get the list of rules of a workflow

Parameters​

workflowId?​

string = 'default'

Returns​

Observable<(string | Rule)[]>

Implementation of​

IRetrievalAgent.getRules

getSchemas()​

getSchemas(): Observable<ARAGSchemas>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:526

Get the agents and drivers schemas

Returns​

Observable<ARAGSchemas>

Implementation of​

IRetrievalAgent.getSchemas

getSearchConfig()​

getSearchConfig(id): Observable<SearchConfig>

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

Parameters​

id​

string

Returns​

Observable<SearchConfig>

Implementation of​

IRetrievalAgent.getSearchConfig

Inherited from​

WritableKnowledgeBox.getSearchConfig

getSearchConfigs()​

getSearchConfigs(): Observable<SearchConfigs>

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

Returns​

Observable<SearchConfigs>

Implementation of​

IRetrievalAgent.getSearchConfigs

Inherited from​

WritableKnowledgeBox.getSearchConfigs

getServiceAccounts()​

getServiceAccounts(): Observable<ServiceAccount[]>

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

Returns​

Observable<ServiceAccount[]>

Implementation of​

IRetrievalAgent.getServiceAccounts

Inherited from​

WritableKnowledgeBox.getServiceAccounts

getSession()​

getSession(sessionId): Observable<IResource>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:76

Retrieves a session from the Retrieval Agent.

Example:

nuclia.db
  .getRetrievalAgent()
  .pipe(switchMap((agent) => agent.getSession('09a94719a6444c5a9689394f6ed9baf6')))
  .subscribe((session) => {
    console.log('session', session);
  });

Parameters​

sessionId​

string

Returns​

Observable<IResource>

Implementation of​

IRetrievalAgent.getSession

getSplitStrategies()​

getSplitStrategies(): Observable<SplitStrategies>

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

Returns​

Observable<SplitStrategies>

Implementation of​

IRetrievalAgent.getSplitStrategies

Inherited from​

WritableKnowledgeBox.getSplitStrategies

getTempToken()​

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

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

Returns an ephemeral token. Requires account id and zone to be set in the Nuclia options (except when working with a local NucliaDB instance).

This is useful when displaying a clickable link to a file in a private Knowledge Box (the token will authorize the request even though there are no authentication headers).

Example:

const downloadLink = `${nuclia.rest.getFullpath(filePath)}?eph-token=${nuclia.knowledgeBox.getTempToken()}`;

Parameters​

payload?​

any

Optional payload to provide extra data for the token generation

ignoreExpiration?​

boolean = false

Optional By default, a temp token is valid for 5min and the same token returned if this method is called several times during this time. Passing ignoreExpiration flag to true will ignore this expiration delay and will always return a new token.

Returns​

Observable<string>

Implementation of​

IRetrievalAgent.getTempToken

Inherited from​

WritableKnowledgeBox.getTempToken

getUsers()​

getUsers(): Observable<FullKbUser[]>

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

Returns​

Observable<FullKbUser[]>

Implementation of​

IRetrievalAgent.getUsers

Inherited from​

WritableKnowledgeBox.getUsers

getWorkflows()​

getWorkflows(): Observable<Workflow[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:586

Get the list of workflows

Returns​

Observable<Workflow[]>

Implementation of​

IRetrievalAgent.getWorkflows

hasResource()​

hasResource(slug): Observable<boolean>

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

Checks if a resource exists for the given slug.

Parameters​

slug​

string

Returns​

Observable<boolean>

Inherited from​

WritableKnowledgeBox.hasResource

import()​

import(options): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:549

Import a Retrieval Agent.

Parameters​

options​

ImportOptions

Import options

Returns​

Observable<void>

interact()​

interact(sessionId, question, workflowId?, method?, headers?, options?): Observable<IErrorResponse | AragResponse>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:109

Parameters​

sessionId​

string

question​

string

workflowId?​

string = 'default'

method?​

"POST" | "WS"

headers?​
options?​

InteractionOptions

Returns​

Observable<IErrorResponse | AragResponse>

Implementation of​

IRetrievalAgent.interact

inviteToAgent()​

inviteToAgent(data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:315

Invite a user to the Retrieval Agent.

Parameters​

data​

InviteKbData

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.inviteToAgent

inviteToKb()​

inviteToKb(data): Observable<void>

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

Invite a user to the Knowledge Box

Parameters​

data​

InviteKbData

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.inviteToKb

Inherited from​

WritableKnowledgeBox.inviteToKb

listAgenticConfigs()​

listAgenticConfigs(): Observable<AgenticConfigs>

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

Returns​

Observable<AgenticConfigs>

Implementation of​

IRetrievalAgent.listAgenticConfigs

Inherited from​

WritableKnowledgeBox.listAgenticConfigs

listAgenticSources()​

listAgenticSources(): Observable<AgenticSources>

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

Returns​

Observable<AgenticSources>

Implementation of​

IRetrievalAgent.listAgenticSources

Inherited from​

WritableKnowledgeBox.listAgenticSources

listenToAllNotifications()​

listenToAllNotifications(): Observable<NotificationMessage[]>

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

Start listening to all the notifications sent by the Knowledge Box.

Returns​

Observable<NotificationMessage[]>

Implementation of​

IRetrievalAgent.listenToAllNotifications

Inherited from​

WritableKnowledgeBox.listenToAllNotifications

listenToProcessingNotifications()​

listenToProcessingNotifications(): Observable<ResourceBaseNotification[]>

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

Start listening to the Knowledge Box notifications, and returns the list of notifications for resources which have processing completed (either successfully or not). Notifications are sent anytime processing is completed, and processing is done anytime the resource is created or modified (like when a summary is added to the resource for example).

Returns​

Observable<ResourceBaseNotification[]>

Implementation of​

IRetrievalAgent.listenToProcessingNotifications

Inherited from​

WritableKnowledgeBox.listenToProcessingNotifications

listenToResourceOperationNotifications()​

listenToResourceOperationNotifications(): Observable<ResourceOperationNotification[]>

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

Start listening to the Knowledge Box notifications, and returns the list of notifications corresponding to the different operations affecting the resources: created, modified, deleted. The notification contains the resource id, title, a timestamp and a flag indicating if the operation was successful or not.

Returns​

Observable<ResourceOperationNotification[]>

Implementation of​

IRetrievalAgent.listenToResourceOperationNotifications

Inherited from​

WritableKnowledgeBox.listenToResourceOperationNotifications

listResources()​

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

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

Lists all the resources stored in the Knowledge Box.

Parameters​

page?​

number

size?​

number

Returns​

Observable<ResourceList>

Implementation of​

IRetrievalAgent.listResources

Inherited from​

WritableKnowledgeBox.listResources

listSessions()​

listSessions(page?, size?): Observable<SessionList>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:85

List all the sessions stored in the Retrieval Agent.

Parameters​

page?​

number

Page index (0 by default)

size?​

number

Page size

Returns​

Observable<SessionList>

Paginated sessions list

Implementation of​

IRetrievalAgent.listSessions

modify()​

modify(data): Observable<void>

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

Modifies the Knowledge Box properties.

Example:

nuclia.db.getKnowledgeBox("my-account", "my-kb").pipe(
  switchMap((knowledgeBox) => knowledgeBox.modify({title: "My new title"}),
).subscribe(() => {
  console.log("knowledge box modified");
});

Parameters​

data​

Partial<IKnowledgeBox>

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.modify

Inherited from​

WritableKnowledgeBox.modify

patchContext()​

patchContext(agent, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:436

Edit an existing context agent.

Parameters​

agent​

ContextAgent

Modified context agent to be saved

workflowId?​

string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchContext

patchDriver()​

patchDriver(driver): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:344

Edit driver

Parameters​

driver​

Driver

BraveDriver | CypherDriver | NucliaDBDriver | PerplexityDriver | TavilyDriver | SqlDriver | McpDriver

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchDriver

patchGeneration()​

patchGeneration(agent, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:473

Edit an existing generation agent.

Parameters​

agent​

GenerationAgent

Modified generation agent to be saved

workflowId?​

string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchGeneration

patchPostprocess()​

patchPostprocess(agent, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:510

Edit an existing postprocess agent.

Parameters​

agent​

PostprocessAgent

Modified postprocess agent to be saved

workflowId?​

string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchPostprocess

patchPreprocess()​

patchPreprocess(agent, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:399

Edit an existing preprocess agent.

Parameters​

agent​

PreprocessAgent

Modified preprocess agent to be saved.

workflowId?​

string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchPreprocess

patchWorkflow()​

patchWorkflow(workflowId, data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:600

Edit an existing workflow

Parameters​

workflowId​

string

data​

Omit<Workflow, "id">

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchWorkflow

predictAnswer()​

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

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

Performs a question answering operation

Example:

nuclia.knowledgeBox
  .predictAnswer('Who is Eric from Toronto?'))
  .subscribe((answer) => {
    if (answer.type !== 'error') {
      console.log('answer', answer.text);
    }
  });

Parameters​

question​

string

options?​

PredictAnswerOptions

synchronous?​

boolean = true

Returns​

Observable<Answer | IErrorResponse>

Implementation of​

IRetrievalAgent.predictAnswer

Inherited from​

WritableKnowledgeBox.predictAnswer

processingStatus()​

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

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

Parameters​

cursor?​

string

scheduled?​

boolean

limit?​

number

Returns​

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

Implementation of​

IRetrievalAgent.processingStatus

Inherited from​

WritableKnowledgeBox.processingStatus

publish()​

publish(published): Observable<void>

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

Publishes or unpublishes the Knowledge Box.

Parameters​

published​

boolean

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.publish

Inherited from​

WritableKnowledgeBox.publish

removeVectorset()​

removeVectorset(model): Observable<void>

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

Remove an embedding model from the Knowledge box

Parameters​

model​

string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.removeVectorset

Inherited from​

WritableKnowledgeBox.removeVectorset

rephrase()​

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

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

Performs a question rephrasing operation. It returns a rephrased question that can be used as input for the generate() method. Example:

nuclia.knowledgeBox
.rephrase('Eric lives Toronto')
.subscribe((rephrased) => {
  console.log('rephrased', rephrased); // Where does Eric live?
});

Parameters​

question​

string

user_context?​

string[]

rephrase_prompt?​

string

Returns​

Observable<string>

Implementation of​

IRetrievalAgent.rephrase

Inherited from​

WritableKnowledgeBox.rephrase

requestActivityDownload()​

requestActivityDownload(options): Observable<DownloadStatus>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:562

Request the download of activity data

Parameters​

options​

DownloadOptions

Download options

Returns​

Observable<DownloadStatus>

Implementation of​

IRetrievalAgent.requestActivityDownload

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

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

Performs a search operation in the knowledge box.

It is similar to find() but the results are not nested.

Example:

nuclia.knowledgeBox
  .search('where does the Little Prince live', [Search.Features.KEYWORD])
  .subscribe((searchResult) => {
    console.log('search result', searchResult);
  });

Parameters​

query​

string

features?​

Features[] = []

options?​

SearchOptions

Returns​

Observable<IErrorResponse | Results>

Implementation of​

IRetrievalAgent.search

Inherited from​

WritableKnowledgeBox.search

sendMessage()​

sendMessage(sessionId, requestId, message): void

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:133

Parameters​

sessionId​

string

requestId​

string

message​

any

Returns​

void

setConfiguration()​

setConfiguration(config): Observable<void>

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

Parameters​

config​

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.setConfiguration

Inherited from​

WritableKnowledgeBox.setConfiguration

setLabelSet()​

setLabelSet(setId, labelSet): Observable<void>

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

Creates or updates a label set.

Example:

nuclia.db
  .getKnowledgeBox('my-account', 'my-kb')
  .pipe(
    switchMap((knowledgeBox) =>
      knowledgeBox.setLabelSet('status', {
        title: 'Status',
        color: '#ff0000',
        labels: [{ title: 'Major' }, { title: 'Minor' }, { title: 'Critical' }],
      }),
    ),
  )
  .subscribe(() => {
    console.log('label set set');
  });

Parameters​

setId​

string

labelSet​

LabelSet

Returns​

Observable<void>

Inherited from​

WritableKnowledgeBox.setLabelSet

setRules()​

setRules(rules, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:371

Set the list of rules of a workflow

Parameters​

rules​

string[]

List of rules to set

workflowId?​

string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.setRules

stopInteraction()​

stopInteraction(sessionId): void

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:125

Parameters​

sessionId​

string

Returns​

void

Implementation of​

IRetrievalAgent.stopInteraction

stopListeningToNotifications()​

stopListeningToNotifications(): void

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

Stop listening the notifications sent by the Knowledge Box.

Returns​

void

Implementation of​

IRetrievalAgent.stopListeningToNotifications

Inherited from​

WritableKnowledgeBox.stopListeningToNotifications

suggest()​

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

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

Suggests paragraphs based on the given query.

Parameters​

query​

string

inTitleOnly?​

boolean = false

features?​

SuggestionFeatures[] = []

options?​

SuggestOptions

Returns​

Observable<IErrorResponse | Suggestions>

Implementation of​

IRetrievalAgent.suggest

Inherited from​

WritableKnowledgeBox.suggest

summarize()​

summarize(ressourceIds, user_prompt?, generative_model?): Observable<string>

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

Summarize resources.

It reads the resources text content and return a global summary about them and one summery per resource.

The optional user_prompt parameter allows you to specify a text that will be used to generate the summary, and must use the {text} placeholder to indicate where the resource text should be inserted (example: 'Make a one-line summary of the following text: {text}').

Example:

nuclia.knowledgeBox
  .summarize(['09a94719a6444c5a9689394f6ed9baf6'])
  .subscribe((summary) => {
    console.log('Summary', summary);
  });

Parameters​

ressourceIds​

string[]

user_prompt?​

string

generative_model?​

string

Returns​

Observable<string>

Implementation of​

IRetrievalAgent.summarize

Inherited from​

WritableKnowledgeBox.summarize

tokens()​

tokens(text): Observable<SentenceToken[]>

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

Performs a tokenization of the given text.

Example:

nuclia.knowledgeBox
  .tokens('Does James Joyce live in Dublin?')
  .subscribe((tokens) => {
    console.log('tokens', tokens);
  });

Parameters​

text​

string

Returns​

Observable<SentenceToken[]>

Implementation of​

IRetrievalAgent.tokens

Inherited from​

WritableKnowledgeBox.tokens

updateAgenticConfig()​

updateAgenticConfig(id, config): Observable<void>

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

Parameters​

id​

string

config​

AgenticConfig

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.updateAgenticConfig

Inherited from​

WritableKnowledgeBox.updateAgenticConfig

updateAgenticSource()​

updateAgenticSource(id, source): Observable<void>

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

Parameters​

id​

string

source​

AgenticSource

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.updateAgenticSource

Inherited from​

WritableKnowledgeBox.updateAgenticSource

updateKVSchema()​

updateKVSchema(id, update): Observable<void>

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

Updates an existing KV schema. Only description and fields can be changed; id is immutable.

Parameters​

id​

string

update​

UpdateKVSchema

Returns​

Observable<void>

Inherited from​

WritableKnowledgeBox.updateKVSchema

updateProcessingHook()​

updateProcessingHook(data): Observable<ProcessingHook>

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

Parameters​

data​

ProcessingHook

Returns​

Observable<ProcessingHook>

Implementation of​

IRetrievalAgent.updateProcessingHook

Inherited from​

WritableKnowledgeBox.updateProcessingHook

updateSearchConfig()​

updateSearchConfig(id, config): Observable<void>

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

Parameters​

id​

string

config​

SearchConfig

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.updateSearchConfig

Inherited from​

WritableKnowledgeBox.updateSearchConfig

updateUsers()​

updateUsers(data): Observable<void>

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

Update the list of users of the Knowledge Box, providing the list of users (id and role) to add and/or update, and the list of user ids to delete.

Parameters​

data​

KbUserPayload

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.updateUsers

Inherited from​

WritableKnowledgeBox.updateUsers

upload()​

Call Signature​

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

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

Uploads a file to the Knowledge Box and automatically creates a new resource to store the file. The resource path is returned in the resource property of the UploadResult (and field provides the path to the FileField).

Example:

nuclia.db
  .getKnowledgeBox('my-account', 'my-kb')
  .pipe(switchMap((knowledgeBox) => knowledgeBox.upload(fileInputElement.files[0])))
  .subscribe(() => {
    console.log('file uploaded');
  });
Parameters​
file​

File | FileWithMetadata

TUS?​

boolean

metadata?​

FileMetadata

Returns​

Observable<UploadResponse>

Implementation of​

IRetrievalAgent.upload

Inherited from​

WritableKnowledgeBox.upload

Call Signature​

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

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

Uploads a file to the Knowledge Box and automatically creates a new resource to store the file. The resource path is returned in the resource property of the UploadResult (and field provides the path to the FileField).

Example:

nuclia.db
  .getKnowledgeBox('my-account', 'my-kb')
  .pipe(switchMap((knowledgeBox) => knowledgeBox.upload(fileInputElement.files[0])))
  .subscribe(() => {
    console.log('file uploaded');
  });
Parameters​
buffer​

ArrayBuffer

TUS?​

boolean

metadata?​

FileMetadata

Returns​

Observable<UploadResponse>

Implementation of​

IRetrievalAgent.upload

Inherited from​

WritableKnowledgeBox.upload