Skip to main content

RetrievalAgent

@nuclia/core • Docs

@nuclia/core / RetrievalAgent

Class: RetrievalAgent

Provides access to all the Retrieval Agent contents and services.

Extends​

Implements​

Constructors​

new RetrievalAgent()​

new RetrievalAgent(nuclia, account, data): RetrievalAgent

Parameters​

• nuclia: INuclia

• account: string

• data: IKnowledgeBoxBase | IKnowledgeBoxStandalone

Returns​

RetrievalAgent

Inherited from​

WritableKnowledgeBox.constructor

Defined in​

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

Properties​

accountId​

accountId: string

Inherited from​

WritableKnowledgeBox.accountId

Defined in​

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

admin?​

optional admin: boolean

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

Implementation of​

IRetrievalAgent.admin

Inherited from​

WritableKnowledgeBox.admin

Defined in​

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

allowed_ip_addresses?​

optional allowed_ip_addresses: null | string[]

Implementation of​

IRetrievalAgent.allowed_ip_addresses

Inherited from​

WritableKnowledgeBox.allowed_ip_addresses

Defined in​

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

allowed_origins?​

optional allowed_origins: null | string[]

Implementation of​

IRetrievalAgent.allowed_origins

Inherited from​

WritableKnowledgeBox.allowed_origins

Defined in​

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

contrib?​

optional contrib: boolean

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

Implementation of​

IRetrievalAgent.contrib

Inherited from​

WritableKnowledgeBox.contrib

Defined in​

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

created?​

optional created: string

Implementation of​

IRetrievalAgent.created

Inherited from​

WritableKnowledgeBox.created

Defined in​

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

description?​

optional description: string

Implementation of​

IRetrievalAgent.description

Inherited from​

WritableKnowledgeBox.description

Defined in​

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

enforce_security?​

optional enforce_security: boolean

Implementation of​

IRetrievalAgent.enforce_security

Inherited from​

WritableKnowledgeBox.enforce_security

Defined in​

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

external_index_provider?​

optional external_index_provider: string

Implementation of​

IRetrievalAgent.external_index_provider

Inherited from​

WritableKnowledgeBox.external_index_provider

Defined in​

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

hidden_resources_enabled?​

optional hidden_resources_enabled: boolean

Implementation of​

IRetrievalAgent.hidden_resources_enabled

Inherited from​

WritableKnowledgeBox.hidden_resources_enabled

Defined in​

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

hidden_resources_hide_on_creation?​

optional hidden_resources_hide_on_creation: boolean

Implementation of​

IRetrievalAgent.hidden_resources_hide_on_creation

Inherited from​

WritableKnowledgeBox.hidden_resources_hide_on_creation

Defined in​

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

id​

id: string

Implementation of​

IRetrievalAgent.id

Inherited from​

WritableKnowledgeBox.id

Defined in​

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

nuclia​

protected nuclia: INuclia

Inherited from​

WritableKnowledgeBox.nuclia

Defined in​

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

search_configs?​

optional search_configs: object

Index Signature​

[key: string]: any

Implementation of​

IRetrievalAgent.search_configs

Inherited from​

WritableKnowledgeBox.search_configs

Defined in​

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

slug​

slug: string

Implementation of​

IRetrievalAgent.slug

Inherited from​

WritableKnowledgeBox.slug

Defined in​

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

state?​

optional state: KBStates

Implementation of​

IRetrievalAgent.state

Inherited from​

WritableKnowledgeBox.state

Defined in​

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

title​

title: string

Implementation of​

IRetrievalAgent.title

Inherited from​

WritableKnowledgeBox.title

Defined in​

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

wsOpeningCount​

wsOpeningCount: number = 0

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:143

zone​

zone: string

Implementation of​

IRetrievalAgent.zone

Inherited from​

WritableKnowledgeBox.zone

Defined in​

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

Accessors​

activityMonitor​

get activityMonitor(): ActivityMonitor

Returns​

ActivityMonitor

Implementation of​

IRetrievalAgent.activityMonitor

Inherited from​

WritableKnowledgeBox.activityMonitor

Defined in​

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

fullpath​

get fullpath(): string

The Retrieval Agent fullpath on the regional API.

Returns​

string

Implementation of​

IRetrievalAgent.fullpath

Overrides​

WritableKnowledgeBox.fullpath

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:58

path​

get path(): string

The Retrieval Agent path on the regional API.

Returns​

string

Implementation of​

IRetrievalAgent.path

Overrides​

WritableKnowledgeBox.path

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:51

syncManager​

get syncManager(): ISyncManager

Returns​

ISyncManager

Implementation of​

IRetrievalAgent.syncManager

Inherited from​

WritableKnowledgeBox.syncManager

Defined in​

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

taskManager​

get taskManager(): TaskManager

Entry point to task manager

Returns​

TaskManager

Implementation of​

IRetrievalAgent.taskManager

Inherited from​

WritableKnowledgeBox.taskManager

Defined in​

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

training​

get training(): Training

Deprecated​

Returns​

Training

Inherited from​

WritableKnowledgeBox.training

Defined in​

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

Methods​

addContext()​

addContext(agent, workflowId): Observable<object>

Add a context agent to a workflow.

Parameters​

• agent: ContextAgentCreation

data representing the context agent to add

• workflowId: string = 'default'

Returns​

Observable<object>

An observable providing the created agent id.

id​

id: string

Implementation of​

IRetrievalAgent.addContext

Defined in​

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

addDriver()​

addDriver(driver): Observable<void>

Add driver to the Retrieval Agent

Parameters​

• driver: DriverCreation

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

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.addDriver

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:354

addGeneration()​

addGeneration(agent, workflowId): Observable<object>

Add a generation agent to a workflow.

Parameters​

• agent: GenerationAgentCreation

data representing the generation agent to add.

• workflowId: string = 'default'

Returns​

Observable<object>

An observable providing the created agent id.

id​

id: string

Implementation of​

IRetrievalAgent.addGeneration

Defined in​

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

addPostprocess()​

addPostprocess(agent, workflowId): Observable<object>

Add a postprocess agent to a workflow.

Parameters​

• agent: PostprocessAgentCreation

data representing the postprocess agent to add

• workflowId: string = 'default'

Returns​

Observable<object>

An observable providing the created agent id.

id​

id: string

Implementation of​

IRetrievalAgent.addPostprocess

Defined in​

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

addPreprocess()​

addPreprocess(agent, workflowId): Observable<object>

Add a preprocess agent to a workflow.

Parameters​

• agent: PreprocessAgentCreation

data representing the preprocess agent to add

• workflowId: string = 'default'

Returns​

Observable<object>

An observable providing the created agent id.

id​

id: string

Implementation of​

IRetrievalAgent.addPreprocess

Defined in​

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

addVectorset()​

addVectorset(model): Observable<void>

Add an embedding model to the Knowledge box

Parameters​

• model: string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.addVectorset

Inherited from​

WritableKnowledgeBox.addVectorset

Defined in​

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

ask()​

ask(query, context, features, options)​

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

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

Defined in​

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

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

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

Parameters​

• query: string

• context?: ContextEntry[]

• features?: Features[]

• options?: ChatOptions

• callback?

Returns​

Observable<null>

Implementation of​

IRetrievalAgent.ask

Inherited from​

WritableKnowledgeBox.ask

Defined in​

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

batchUpload()​

batchUpload(files): Observable<UploadStatus>

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

Defined in​

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

catalog()​

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

Parameters​

• query: string | CatalogQuery

• options?: CatalogOptions

Returns​

Observable<Results | IErrorResponse>

Implementation of​

IRetrievalAgent.catalog

Inherited from​

WritableKnowledgeBox.catalog

Defined in​

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

counters()​

counters(): Observable<Counters>

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

Defined in​

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

createAgenticRAGPipeline()​

createAgenticRAGPipeline(steps): Pipeline

Parameters​

• steps: Steps

Returns​

Pipeline

Inherited from​

WritableKnowledgeBox.createAgenticRAGPipeline

Defined in​

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

createExtractStrategy()​

createExtractStrategy(config): Observable<void>

Parameters​

• config: ExtractConfig

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createExtractStrategy

Inherited from​

WritableKnowledgeBox.createExtractStrategy

Defined in​

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

createKey()​

createKey(saId, expires): Observable<object>

Parameters​

• saId: string

• expires: string

Returns​

Observable<object>

token​

token: string

Implementation of​

IRetrievalAgent.createKey

Inherited from​

WritableKnowledgeBox.createKey

Defined in​

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

createKeyForService()​

createKeyForService(data, expires): Observable<object>

Parameters​

• data: ServiceAccountCreation

• expires: string

Returns​

Observable<object>

token​

token: string

Implementation of​

IRetrievalAgent.createKeyForService

Inherited from​

WritableKnowledgeBox.createKeyForService

Defined in​

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

createKVSchema()​

createKVSchema(schema): Observable<void>

Creates a new KV schema in the Knowledge Box.

Parameters​

• schema: KVSchema

Returns​

Observable<void>

Inherited from​

WritableKnowledgeBox.createKVSchema

Defined in​

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

createLinkResource()​

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

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​

• link: LinkField

• metadata?: UserMetadata

• synchronous?: boolean = true

• origin?: Origin

• slug?: string

Returns​

Observable<object>

uuid​

uuid: string

Implementation of​

IRetrievalAgent.createLinkResource

Inherited from​

WritableKnowledgeBox.createLinkResource

Defined in​

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

createOrUpdateResource()​

createOrUpdateResource(data, synchronous): Observable<void | object>

Creates a resource or updates it if it already exists

Parameters​

• data: ICreateResource

• synchronous: boolean = true

Returns​

Observable<void | object>

Inherited from​

WritableKnowledgeBox.createOrUpdateResource

Defined in​

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

createResource()​

createResource(resource, synchronous): Observable<object>

Creates and indexes a new resource in the Knowledge Box.

Parameters​

• resource: ICreateResource

• synchronous: boolean = true

Returns​

Observable<object>

uuid​

uuid: string

Implementation of​

IRetrievalAgent.createResource

Inherited from​

WritableKnowledgeBox.createResource

Defined in​

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

createSearchConfig()​

createSearchConfig(id, config): Observable<void>

Parameters​

• id: string

• config: SearchConfig

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createSearchConfig

Inherited from​

WritableKnowledgeBox.createSearchConfig

Defined in​

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

createServiceAccount()​

createServiceAccount(data): Observable<void>

Parameters​

• data: ServiceAccountCreation

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createServiceAccount

Inherited from​

WritableKnowledgeBox.createServiceAccount

Defined in​

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

createSession()​

createSession(session): Observable<SessionCreationResponse>

Create sessions on the retrieval agent

Parameters​

• session: SessionCreation

Returns​

Observable<SessionCreationResponse>

Implementation of​

IRetrievalAgent.createSession

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:104

createSplitStrategy()​

createSplitStrategy(strategy): Observable<void>

Parameters​

• strategy: SplitStrategy

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createSplitStrategy

Inherited from​

WritableKnowledgeBox.createSplitStrategy

Defined in​

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

createWorkflow()​

createWorkflow(data): Observable<void>

Create a new workflow

Parameters​

• data: Workflow

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.createWorkflow

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:611

delete()​

delete(): Observable<void>

Deletes the Knowledge Box.

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.delete

Inherited from​

WritableKnowledgeBox.delete

Defined in​

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

deleteContext()​

deleteContext(agentId, workflowId): Observable<void>

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:463

deleteDriver()​

deleteDriver(driverId): Observable<void>

Delete driver

Parameters​

• driverId: string

Identifier of the driver to delete

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteDriver

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:370

deleteExtractStrategy()​

deleteExtractStrategy(id): Observable<void>

Parameters​

• id: string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteExtractStrategy

Inherited from​

WritableKnowledgeBox.deleteExtractStrategy

Defined in​

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

deleteGeneration()​

deleteGeneration(agentId, workflowId): Observable<void>

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:500

deleteInvite()​

deleteInvite(email): Observable<void>

Parameters​

• email: string

Returns​

Observable<void>

Inherited from​

WritableKnowledgeBox.deleteInvite

Defined in​

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

deleteKey()​

deleteKey(saId, saKeyId): Observable<void>

Parameters​

• saId: string

• saKeyId: string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteKey

Inherited from​

WritableKnowledgeBox.deleteKey

Defined in​

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

deleteKVSchema()​

deleteKVSchema(id): Observable<void>

Deletes a KV schema from the Knowledge Box.

Parameters​

• id: string

Returns​

Observable<void>

Inherited from​

WritableKnowledgeBox.deleteKVSchema

Defined in​

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

deleteLabelSet()​

deleteLabelSet(setId): Observable<void>

Deletes a label set.

Parameters​

• setId: string

Returns​

Observable<void>

Inherited from​

WritableKnowledgeBox.deleteLabelSet

Defined in​

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

deletePostprocess()​

deletePostprocess(agentId, workflowId): Observable<void>

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:537

deletePreprocess()​

deletePreprocess(agentId, workflowId): Observable<void>

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:426

deleteSearchConfig()​

deleteSearchConfig(id): Observable<void>

Parameters​

• id: string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteSearchConfig

Inherited from​

WritableKnowledgeBox.deleteSearchConfig

Defined in​

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

deleteServiceAccount()​

deleteServiceAccount(saId): Observable<void>

Parameters​

• saId: string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteServiceAccount

Inherited from​

WritableKnowledgeBox.deleteServiceAccount

Defined in​

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

deleteSplitStrategy()​

deleteSplitStrategy(id): Observable<void>

Parameters​

• id: string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteSplitStrategy

Inherited from​

WritableKnowledgeBox.deleteSplitStrategy

Defined in​

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

deleteWorkflow()​

deleteWorkflow(workflowId): Observable<void>

Delete a workflow

Parameters​

• workflowId: string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.deleteWorkflow

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:625

export()​

export(options): Observable<void>

Request the export of a Retrieval Agent.

Parameters​

• options: ExportOptions

Export options

Returns​

Observable<void>

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:559

feedback()​

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

Parameters​

• answerId: string

• good: boolean

• feedback: string = ''

• text_block_id?: string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.feedback

Inherited from​

WritableKnowledgeBox.feedback

Defined in​

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

find()​

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

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

Defined in​

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

generate()​

generate(question, context): Observable<object>

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<object>

answer​

answer: string

cannotAnswer​

cannotAnswer: boolean

Implementation of​

IRetrievalAgent.generate

Inherited from​

WritableKnowledgeBox.generate

Defined in​

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

generateJSON()​

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

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<object>

answer​

answer: object

success​

success: boolean

Implementation of​

IRetrievalAgent.generateJSON

Inherited from​

WritableKnowledgeBox.generateJSON

Defined in​

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

generateRandomQuestionAboutResource()​

generateRandomQuestionAboutResource(resource): Observable<string>

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

Defined in​

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

getAgentTempToken()​

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

Parameters​

• agent_session: string

• ttl?: number

Returns​

Observable<string>

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:322

getConfiguration()​

getConfiguration(): Observable<object>

Returns​

Observable<object>

Implementation of​

IRetrievalAgent.getConfiguration

Inherited from​

WritableKnowledgeBox.getConfiguration

Defined in​

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

getContext()​

getContext(workflowId): Observable<ContextAgent[]>

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:435

getDownload()​

getDownload(requestId): Observable<DownloadStatus>

Get the status of a download

Parameters​

• requestId: string

Returns​

Observable<DownloadStatus>

Implementation of​

IRetrievalAgent.getDownload

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:597

getDownloads()​

getDownloads(): Observable<DownloadStatus[]>

Get the status of all downloads

Returns​

Observable<DownloadStatus[]>

Implementation of​

IRetrievalAgent.getDownloads

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:589

getDrivers()​

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

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:341

getEntities()​

getEntities(): Observable<Entities>

Returns all the NER families defined in the Knowledge Box.

Returns​

Observable<Entities>

Inherited from​

WritableKnowledgeBox.getEntities

Defined in​

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

getEntitiesGroup()​

getEntitiesGroup(groupId): Observable<EntitiesGroup>

Returns the NER family with the given id.

Parameters​

• groupId: string

Returns​

Observable<EntitiesGroup>

Inherited from​

WritableKnowledgeBox.getEntitiesGroup

Defined in​

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

getExtractStrategies()​

getExtractStrategies(): Observable<ExtractStrategies>

Returns​

Observable<ExtractStrategies>

Implementation of​

IRetrievalAgent.getExtractStrategies

Inherited from​

WritableKnowledgeBox.getExtractStrategies

Defined in​

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

getFacets()​

getFacets(facets): Observable<FacetsResult>

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

Defined in​

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

getFullResource()​

getFullResource(uuid): Observable<Resource>

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

Defined in​

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

getFullResourceBySlug()​

getFullResourceBySlug(slug): Observable<Resource>

Parameters​

• slug: string

Returns​

Observable<Resource>

Implementation of​

IRetrievalAgent.getFullResourceBySlug

Inherited from​

WritableKnowledgeBox.getFullResourceBySlug

Defined in​

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

getFullSchemas()​

getFullSchemas(): Observable<JSONSchema4>

Returns​

Observable<JSONSchema4>

Deprecated​

Use getSchemas

Implementation of​

IRetrievalAgent.getFullSchemas

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:551

getGeneration()​

getGeneration(workflowId): Observable<GenerationAgent[]>

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:472

getGenerativeProviders()​

getGenerativeProviders(): Observable<GenerativeProviders>

Returns​

Observable<GenerativeProviders>

Implementation of​

IRetrievalAgent.getGenerativeProviders

Inherited from​

WritableKnowledgeBox.getGenerativeProviders

Defined in​

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

getInvites()​

getInvites(): Observable<KbInvite[]>

Returns​

Observable<KbInvite[]>

Inherited from​

WritableKnowledgeBox.getInvites

Defined in​

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

getKbEndpointAndZone()​

protected getKbEndpointAndZone(): object

Returns​

object

endpoint​

endpoint: string

zone​

zone: undefined | string

Inherited from​

WritableKnowledgeBox.getKbEndpointAndZone

Defined in​

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

getKVSchema()​

getKVSchema(id): Observable<KVSchema>

Returns the KV schema with the given id.

Parameters​

• id: string

Returns​

Observable<KVSchema>

Inherited from​

WritableKnowledgeBox.getKVSchema

Defined in​

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

getKVSchemas()​

getKVSchemas(): Observable<KBKVSchemas>

Returns all the KV schemas defined in the Knowledge Box.

Returns​

Observable<KBKVSchemas>

Inherited from​

WritableKnowledgeBox.getKVSchemas

Defined in​

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

getLabels()​

getLabels(): Observable<LabelSets>

Returns all the labels defined in the Knowledge Box.

Returns​

Observable<LabelSets>

Inherited from​

WritableKnowledgeBox.getLabels

Defined in​

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

getLearningSchema()​

getLearningSchema(): Observable<LearningConfigurations>

Returns​

Observable<LearningConfigurations>

Implementation of​

IRetrievalAgent.getLearningSchema

Inherited from​

WritableKnowledgeBox.getLearningSchema

Defined in​

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

getPostprocess()​

getPostprocess(workflowId): Observable<PostprocessAgent[]>

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:509

getPreprocess()​

getPreprocess(workflowId): Observable<PreprocessAgent[]>

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:398

getResource()​

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

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

Defined in​

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

getResourceBySlug()​

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

Parameters​

• slug: string

• show: ResourceProperties[] = ...

• extracted: ExtractedDataTypes[] = []

Returns​

Observable<Resource>

Implementation of​

IRetrievalAgent.getResourceBySlug

Inherited from​

WritableKnowledgeBox.getResourceBySlug

Defined in​

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

getResourceFromData()​

getResourceFromData(data): Resource

Parameters​

• data: IResource

Returns​

Resource

Inherited from​

WritableKnowledgeBox.getResourceFromData

Defined in​

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

getRules()​

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

Get the list of rules of a workflow

Parameters​

• workflowId: string = 'default'

Returns​

Observable<(string | Rule)[]>

Implementation of​

IRetrievalAgent.getRules

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:378

getSchemas()​

getSchemas(): Observable<ARAGSchemas>

Get the agents and drivers schemas

Returns​

Observable<ARAGSchemas>

Implementation of​

IRetrievalAgent.getSchemas

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:544

getSearchConfig()​

getSearchConfig(id): Observable<SearchConfig>

Parameters​

• id: string

Returns​

Observable<SearchConfig>

Implementation of​

IRetrievalAgent.getSearchConfig

Inherited from​

WritableKnowledgeBox.getSearchConfig

Defined in​

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

getSearchConfigs()​

getSearchConfigs(): Observable<SearchConfigs>

Returns​

Observable<SearchConfigs>

Implementation of​

IRetrievalAgent.getSearchConfigs

Inherited from​

WritableKnowledgeBox.getSearchConfigs

Defined in​

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

getServiceAccounts()​

getServiceAccounts(): Observable<ServiceAccount[]>

Returns​

Observable<ServiceAccount[]>

Implementation of​

IRetrievalAgent.getServiceAccounts

Inherited from​

WritableKnowledgeBox.getServiceAccounts

Defined in​

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

getSession()​

getSession(sessionId): Observable<IResource>

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:75

getSplitStrategies()​

getSplitStrategies(): Observable<SplitStrategies>

Returns​

Observable<SplitStrategies>

Implementation of​

IRetrievalAgent.getSplitStrategies

Inherited from​

WritableKnowledgeBox.getSplitStrategies

Defined in​

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

getTempToken()​

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

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

Defined in​

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

getUsers()​

getUsers(): Observable<FullKbUser[]>

Returns​

Observable<FullKbUser[]>

Implementation of​

IRetrievalAgent.getUsers

Inherited from​

WritableKnowledgeBox.getUsers

Defined in​

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

getWorkflows()​

getWorkflows(): Observable<Workflow[]>

Get the list of workflows

Returns​

Observable<Workflow[]>

Implementation of​

IRetrievalAgent.getWorkflows

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:604

hasResource()​

hasResource(slug): Observable<boolean>

Checks if a resource exists for the given slug.

Parameters​

• slug: string

Returns​

Observable<boolean>

Inherited from​

WritableKnowledgeBox.hasResource

Defined in​

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

import()​

import(options): Observable<void>

Import a Retrieval Agent.

Parameters​

• options: ImportOptions

Import options

Returns​

Observable<void>

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:567

interact()​

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

Parameters​

• sessionId: string

• question: string

• workflowId: string = 'default'

• method: "POST" | "WS" = 'WS'

• headers?

• options?: InteractionOptions

Returns​

Observable<IErrorResponse | AragResponse>

Implementation of​

IRetrievalAgent.interact

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:108

inviteToAgent()​

inviteToAgent(data): Observable<void>

Invite a user to the Retrieval Agent.

Parameters​

• data: InviteKbData

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.inviteToAgent

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:333

inviteToKb()​

inviteToKb(data): Observable<void>

Invite a user to the Knowledge Box

Parameters​

• data: InviteKbData

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.inviteToKb

Inherited from​

WritableKnowledgeBox.inviteToKb

Defined in​

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

listenToAllNotifications()​

listenToAllNotifications(): Observable<NotificationMessage[]>

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

Returns​

Observable<NotificationMessage[]>

Implementation of​

IRetrievalAgent.listenToAllNotifications

Inherited from​

WritableKnowledgeBox.listenToAllNotifications

Defined in​

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

listenToProcessingNotifications()​

listenToProcessingNotifications(): Observable<ResourceBaseNotification[]>

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

Defined in​

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

listenToResourceOperationNotifications()​

listenToResourceOperationNotifications(): Observable<ResourceOperationNotification[]>

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

Defined in​

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

listResources()​

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

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

Defined in​

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

listSessions()​

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

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:84

modify()​

modify(data): Observable<void>

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

Defined in​

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

patchContext()​

patchContext(agent, workflowId): Observable<void>

Edit an existing context agent.

Parameters​

• agent: ContextAgent

Modified context agent to be saved

• workflowId: string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchContext

Defined in​

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

patchDriver()​

patchDriver(driver): Observable<void>

Edit driver

Parameters​

• driver: Driver

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

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchDriver

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:362

patchGeneration()​

patchGeneration(agent, workflowId): Observable<void>

Edit an existing generation agent.

Parameters​

• agent: GenerationAgent

Modified generation agent to be saved

• workflowId: string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchGeneration

Defined in​

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

patchPostprocess()​

patchPostprocess(agent, workflowId): Observable<void>

Edit an existing postprocess agent.

Parameters​

• agent: PostprocessAgent

Modified postprocess agent to be saved

• workflowId: string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchPostprocess

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:528

patchPreprocess()​

patchPreprocess(agent, workflowId): Observable<void>

Edit an existing preprocess agent.

Parameters​

• agent: PreprocessAgent

Modified preprocess agent to be saved.

• workflowId: string = 'default'

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchPreprocess

Defined in​

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

patchWorkflow()​

patchWorkflow(workflowId, data): Observable<void>

Edit an existing workflow

Parameters​

• workflowId: string

• data: Omit<Workflow, "id">

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.patchWorkflow

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:618

predictAnswer()​

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

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

Defined in​

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

processingStatus()​

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

Parameters​

• cursor?: string

• scheduled?: boolean

• limit?: number

Returns​

Observable<object>

cursor​

cursor: string

results​

results: ProcessingStatus[]

Implementation of​

IRetrievalAgent.processingStatus

Inherited from​

WritableKnowledgeBox.processingStatus

Defined in​

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

publish()​

publish(published): Observable<void>

Publishes or unpublishes the Knowledge Box.

Parameters​

• published: boolean

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.publish

Inherited from​

WritableKnowledgeBox.publish

Defined in​

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

removeVectorset()​

removeVectorset(model): Observable<void>

Remove an embedding model from the Knowledge box

Parameters​

• model: string

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.removeVectorset

Inherited from​

WritableKnowledgeBox.removeVectorset

Defined in​

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

rephrase()​

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

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

Defined in​

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

requestActivityDownload()​

requestActivityDownload(options): Observable<DownloadStatus>

Request the download of activity data

Parameters​

• options: DownloadOptions

Download options

Returns​

Observable<DownloadStatus>

Implementation of​

IRetrievalAgent.requestActivityDownload

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:580

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

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<Results | IErrorResponse>

Implementation of​

IRetrievalAgent.search

Inherited from​

WritableKnowledgeBox.search

Defined in​

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

sendMessage()​

sendMessage(sessionId, requestId, message): void

Parameters​

• sessionId: string

• requestId: string

• message: any

Returns​

void

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:132

setConfiguration()​

setConfiguration(config): Observable<void>

Parameters​

• config

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.setConfiguration

Inherited from​

WritableKnowledgeBox.setConfiguration

Defined in​

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

setLabelSet()​

setLabelSet(setId, labelSet): Observable<void>

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

Defined in​

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

setRules()​

setRules(rules, workflowId): Observable<void>

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

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:389

stopInteraction()​

stopInteraction(sessionId): void

Parameters​

• sessionId: string

Returns​

void

Implementation of​

IRetrievalAgent.stopInteraction

Defined in​

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.ts:124

stopListeningToNotifications()​

stopListeningToNotifications(): void

Stop listening the notifications sent by the Knowledge Box.

Returns​

void

Implementation of​

IRetrievalAgent.stopListeningToNotifications

Inherited from​

WritableKnowledgeBox.stopListeningToNotifications

Defined in​

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

suggest()​

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

Suggests paragraphs based on the given query.

Parameters​

• query: string

• inTitleOnly: boolean = false

• features: SuggestionFeatures[] = []

• options?: SuggestOptions

Returns​

Observable<Suggestions | IErrorResponse>

Implementation of​

IRetrievalAgent.suggest

Inherited from​

WritableKnowledgeBox.suggest

Defined in​

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

summarize()​

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

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

Defined in​

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

tokens()​

tokens(text): Observable<SentenceToken[]>

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

Defined in​

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

updateKVSchema()​

updateKVSchema(id, update): Observable<void>

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

Defined in​

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

updateSearchConfig()​

updateSearchConfig(id, config): Observable<void>

Parameters​

• id: string

• config: SearchConfig

Returns​

Observable<void>

Implementation of​

IRetrievalAgent.updateSearchConfig

Inherited from​

WritableKnowledgeBox.updateSearchConfig

Defined in​

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

updateUsers()​

updateUsers(data): Observable<void>

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

Defined in​

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

upload()​

upload(file, TUS, metadata)​

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

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

Defined in​

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

upload(buffer, TUS, metadata)​

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

Parameters​

• buffer: ArrayBuffer

• TUS?: boolean

• metadata?: FileMetadata

Returns​

Observable<UploadResponse>

Implementation of​

IRetrievalAgent.upload

Inherited from​

WritableKnowledgeBox.upload

Defined in​

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