WritableKnowledgeBox

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

IWritableKnowledgeBox.ask

Inherited from

KnowledgeBox.ask

Defined in

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

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

IWritableKnowledgeBox.ask

Inherited from

KnowledgeBox.ask

Defined in

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

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

IWritableKnowledgeBox.batchUpload

Defined in

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

catalog()

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

Parameters

• query: string | CatalogQuery

• options?: CatalogOptions

Returns

Observable<Results | IErrorResponse>

Implementation of

IWritableKnowledgeBox.catalog

Inherited from

KnowledgeBox.catalog

Defined in

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

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

IWritableKnowledgeBox.counters

Inherited from

KnowledgeBox.counters

Defined in

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

createAgenticRAGPipeline()

createAgenticRAGPipeline(steps): Pipeline

Parameters

• steps: Steps

Returns

Pipeline

Implementation of

IWritableKnowledgeBox.createAgenticRAGPipeline

Inherited from

KnowledgeBox.createAgenticRAGPipeline

Defined in

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

createExtractStrategy()

createExtractStrategy(config): Observable<void>

Parameters

• config: ExtractConfig

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.createExtractStrategy

Defined in

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

createKey()

createKey(saId, expires): Observable<object>

Parameters

• saId: string

• expires: string

Returns

Observable<object>

token

token: string

Implementation of

IWritableKnowledgeBox.createKey

Defined in

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

createKeyForService()

createKeyForService(data, expires): Observable<object>

Parameters

• data: ServiceAccountCreation

• expires: string

Returns

Observable<object>

token

token: string

Implementation of

IWritableKnowledgeBox.createKeyForService

Defined in

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

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

IWritableKnowledgeBox.createLinkResource

Defined in

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

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>

Defined in

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

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

IWritableKnowledgeBox.createResource

Defined in

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

createSearchConfig()

createSearchConfig(id, config): Observable<void>

Parameters

• id: string

• config: SearchConfig

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.createSearchConfig

Defined in

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

createServiceAccount()

createServiceAccount(data): Observable<void>

Parameters

• data: ServiceAccountCreation

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.createServiceAccount

Defined in

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

createSplitStrategy()

createSplitStrategy(strategy): Observable<void>

Parameters

• strategy: SplitStrategy

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.createSplitStrategy

Defined in

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

delete()

delete(): Observable<void>

Deletes the Knowledge Box.

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.delete

Defined in

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

deleteAllSynonyms()

deleteAllSynonyms(): Observable<void>

Returns

Observable<void>

Deprecated

Implementation of

IWritableKnowledgeBox.deleteAllSynonyms

Defined in

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

deleteExtractStrategy()

deleteExtractStrategy(id): Observable<void>

Parameters

• id: string

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.deleteExtractStrategy

Defined in

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

deleteInvite()

deleteInvite(email): Observable<void>

Parameters

• email: string

Returns

Observable<void>

Defined in

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

deleteKey()

deleteKey(saId, saKeyId): Observable<void>

Parameters

• saId: string

• saKeyId: string

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.deleteKey

Defined in

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

deleteLabelSet()

deleteLabelSet(setId): Observable<void>

Deletes a label set.

Parameters

• setId: string

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.deleteLabelSet

Defined in

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

deleteSearchConfig()

deleteSearchConfig(id): Observable<void>

Parameters

• id: string

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.deleteSearchConfig

Defined in

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

deleteServiceAccount()

deleteServiceAccount(saId): Observable<void>

Parameters

• saId: string

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.deleteServiceAccount

Defined in

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

deleteSplitStrategy()

deleteSplitStrategy(id): Observable<void>

Parameters

• id: string

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.deleteSplitStrategy

Defined in

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

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

IWritableKnowledgeBox.feedback

Inherited from

KnowledgeBox.feedback

Defined in

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

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

IWritableKnowledgeBox.find

Inherited from

KnowledgeBox.find

Defined in

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

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

IWritableKnowledgeBox.generate

Inherited from

KnowledgeBox.generate

Defined in

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

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

IWritableKnowledgeBox.generateJSON

Inherited from

KnowledgeBox.generateJSON

Defined in

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

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>

Implementation of

IWritableKnowledgeBox.generateRandomQuestionAboutResource

Inherited from

KnowledgeBox.generateRandomQuestionAboutResource

Defined in

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

getConfiguration()

getConfiguration(): Observable<object>

Returns

Observable<object>

Implementation of

IWritableKnowledgeBox.getConfiguration

Inherited from

KnowledgeBox.getConfiguration

Defined in

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

getEntities()

getEntities(): Observable<Entities>

Returns all the NER families defined in the Knowledge Box.

Returns

Observable<Entities>

Implementation of

IWritableKnowledgeBox.getEntities

Inherited from

KnowledgeBox.getEntities

Defined in

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

getEntitiesGroup()

getEntitiesGroup(groupId): Observable<EntitiesGroup>

Returns the NER family with the given id.

Parameters

• groupId: string

Returns

Observable<EntitiesGroup>

Implementation of

IWritableKnowledgeBox.getEntitiesGroup

Inherited from

KnowledgeBox.getEntitiesGroup

Defined in

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

getExtractStrategies()

getExtractStrategies(): Observable<ExtractStrategies>

Returns

Observable<ExtractStrategies>

Implementation of

IWritableKnowledgeBox.getExtractStrategies

Inherited from

KnowledgeBox.getExtractStrategies

Defined in

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

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

IWritableKnowledgeBox.getFacets

Inherited from

KnowledgeBox.getFacets

Defined in

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

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

IWritableKnowledgeBox.getFullResource

Inherited from

KnowledgeBox.getFullResource

Defined in

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

getFullResourceBySlug()

getFullResourceBySlug(slug): Observable<Resource>

Parameters

• slug: string

Returns

Observable<Resource>

Implementation of

IWritableKnowledgeBox.getFullResourceBySlug

Inherited from

KnowledgeBox.getFullResourceBySlug

Defined in

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

getGenerativeProviders()

getGenerativeProviders(): Observable<GenerativeProviders>

Returns

Observable<GenerativeProviders>

Implementation of

IWritableKnowledgeBox.getGenerativeProviders

Inherited from

KnowledgeBox.getGenerativeProviders

Defined in

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

getInvites()

getInvites(): Observable<KbInvite[]>

Returns

Observable<KbInvite[]>

Inherited from

KnowledgeBox.getInvites

Defined in

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

getKbEndpointAndZone()

protected getKbEndpointAndZone(): object

Returns

object

endpoint

endpoint: string

zone

zone: undefined | string

Defined in

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

getLabels()

getLabels(): Observable<LabelSets>

Returns all the labels defined in the Knowledge Box.

Returns

Observable<LabelSets>

Implementation of

IWritableKnowledgeBox.getLabels

Inherited from

KnowledgeBox.getLabels

Defined in

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

getLearningSchema()

getLearningSchema(): Observable<LearningConfigurations>

Returns

Observable<LearningConfigurations>

Implementation of

IWritableKnowledgeBox.getLearningSchema

Inherited from

KnowledgeBox.getLearningSchema

Defined in

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

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

IWritableKnowledgeBox.getResource

Inherited from

KnowledgeBox.getResource

Defined in

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

getResourceBySlug()

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

Parameters

• slug: string

• show: ResourceProperties[] = ...

• extracted: ExtractedDataTypes[] = []

Returns

Observable<Resource>

Implementation of

IWritableKnowledgeBox.getResourceBySlug

Inherited from

KnowledgeBox.getResourceBySlug

Defined in

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

getResourceFromData()

getResourceFromData(data): Resource

Parameters

• data: IResource

Returns

Resource

Inherited from

KnowledgeBox.getResourceFromData

Defined in

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

getSearchConfig()

getSearchConfig(id): Observable<SearchConfig>

Parameters

• id: string

Returns

Observable<SearchConfig>

Implementation of

IWritableKnowledgeBox.getSearchConfig

Inherited from

KnowledgeBox.getSearchConfig

Defined in

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

getSearchConfigs()

getSearchConfigs(): Observable<SearchConfigs>

Returns

Observable<SearchConfigs>

Implementation of

IWritableKnowledgeBox.getSearchConfigs

Inherited from

KnowledgeBox.getSearchConfigs

Defined in

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

getServiceAccounts()

getServiceAccounts(): Observable<ServiceAccount[]>

Returns

Observable<ServiceAccount[]>

Implementation of

IWritableKnowledgeBox.getServiceAccounts

Defined in

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

getSplitStrategies()

getSplitStrategies(): Observable<SplitStrategies>

Returns

Observable<SplitStrategies>

Implementation of

IWritableKnowledgeBox.getSplitStrategies

Inherited from

KnowledgeBox.getSplitStrategies

Defined in

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

getSynonyms()

getSynonyms(): Observable<Synonyms>

Returns

Observable<Synonyms>

Implementation of

IWritableKnowledgeBox.getSynonyms

Inherited from

KnowledgeBox.getSynonyms

Defined in

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

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

IWritableKnowledgeBox.getTempToken

Inherited from

KnowledgeBox.getTempToken

Defined in

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

getUsers()

getUsers(): Observable<FullKbUser[]>

Returns

Observable<FullKbUser[]>

Implementation of

IWritableKnowledgeBox.getUsers

Inherited from

KnowledgeBox.getUsers

Defined in

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

hasResource()

hasResource(slug): Observable<boolean>

Checks if a resource exists for the given slug.

Parameters

• slug: string

Returns

Observable<boolean>

Defined in

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

inviteToKb()

inviteToKb(data): Observable<void>

Invite a user to the Knowledge Box

Parameters

• data: InviteKbData

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.inviteToKb

Defined in

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

listenToAllNotifications()

listenToAllNotifications(): Observable<NotificationMessage[]>

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

Returns

Observable<NotificationMessage[]>

Implementation of

IWritableKnowledgeBox.listenToAllNotifications

Inherited from

KnowledgeBox.listenToAllNotifications

Defined in

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

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

IWritableKnowledgeBox.listenToProcessingNotifications

Inherited from

KnowledgeBox.listenToProcessingNotifications

Defined in

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

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

IWritableKnowledgeBox.listenToResourceOperationNotifications

Inherited from

KnowledgeBox.listenToResourceOperationNotifications

Defined in

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

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

IWritableKnowledgeBox.listResources

Inherited from

KnowledgeBox.listResources

Defined in

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

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

IWritableKnowledgeBox.modify

Defined in

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

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

IWritableKnowledgeBox.predictAnswer

Inherited from

KnowledgeBox.predictAnswer

Defined in

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

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

IWritableKnowledgeBox.processingStatus

Inherited from

KnowledgeBox.processingStatus

Defined in

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

publish()

publish(published): Observable<void>

Publishes or unpublishes the Knowledge Box.

Parameters

• published: boolean

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.publish

Defined in

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

removeVectorset()

removeVectorset(model): Observable<void>

Remove an embedding model from the Knowledge box

Parameters

• model: string

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.removeVectorset

Defined in

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

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

IWritableKnowledgeBox.rephrase

Inherited from

KnowledgeBox.rephrase

Defined in

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

search()

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

IWritableKnowledgeBox.search

Inherited from

KnowledgeBox.search

Defined in

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

setConfiguration()

setConfiguration(config): Observable<void>

Parameters

• config

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.setConfiguration

Defined in

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

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>

Implementation of

IWritableKnowledgeBox.setLabelSet

Defined in

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

setSynonyms()

setSynonyms(synonyms): Observable<void>

Parameters

• synonyms: Synonyms

Returns

Observable<void>

Deprecated

Implementation of

IWritableKnowledgeBox.setSynonyms

Defined in

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

stopListeningToNotifications()

stopListeningToNotifications(): void

Stop listening the notifications sent by the Knowledge Box.

Returns

void

Implementation of

IWritableKnowledgeBox.stopListeningToNotifications

Inherited from

KnowledgeBox.stopListeningToNotifications

Defined in

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

suggest()

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

Suggests paragraphs based on the given query.

Parameters

• query: string

• inTitleOnly: boolean = false

• features: SuggestionFeatures[] = []

Returns

Observable<Suggestions | IErrorResponse>

Implementation of

IWritableKnowledgeBox.suggest

Inherited from

KnowledgeBox.suggest

Defined in

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

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

IWritableKnowledgeBox.summarize

Inherited from

KnowledgeBox.summarize

Defined in

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

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

IWritableKnowledgeBox.tokens

Inherited from

KnowledgeBox.tokens

Defined in

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

updateSearchConfig()

updateSearchConfig(id, config): Observable<void>

Parameters

• id: string

• config: SearchConfig

Returns

Observable<void>

Implementation of

IWritableKnowledgeBox.updateSearchConfig

Defined in

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

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

IWritableKnowledgeBox.updateUsers

Defined in

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

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

IWritableKnowledgeBox.upload

Defined in

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

upload(buffer, TUS, metadata)

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

Parameters

• buffer: ArrayBuffer

• TUS?: boolean

• metadata?: FileMetadata

Returns

Observable<UploadResponse>

Implementation of

IWritableKnowledgeBox.upload

Defined in

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

Class: WritableKnowledgeBox

Extends​

Extended by​

Implements​

Constructors​

new WritableKnowledgeBox()​

Parameters​

Returns​

Inherited from​

Defined in​

Properties​

accountId​

Inherited from​

Defined in​

admin?​

Implementation of​

Defined in​

allowed_ip_addresses?​

Implementation of​

Inherited from​

Defined in​

allowed_origins?​

Implementation of​

Inherited from​

Defined in​

contrib?​

Implementation of​

Defined in​

created?​

Implementation of​

Inherited from​

Defined in​

description?​

Implementation of​

Inherited from​

Defined in​

enforce_security?​

Implementation of​

Inherited from​

Defined in​

external_index_provider?​

Implementation of​

Inherited from​

Defined in​

hidden_resources_enabled?​

Implementation of​

Inherited from​

Defined in​

hidden_resources_hide_on_creation?​

Implementation of​

Inherited from​

Defined in​

id​

Implementation of​

Inherited from​

Defined in​

nuclia​

Inherited from​

Defined in​

search_configs?​

Index Signature​

Implementation of​

Inherited from​

Defined in​

slug​

Implementation of​

Inherited from​

Defined in​

state?​

Implementation of​

Inherited from​

Defined in​

title​

Implementation of​

Inherited from​

Defined in​

zone​

Implementation of​

Inherited from​

Defined in​

Extends

Extended by

Implements

Constructors

new WritableKnowledgeBox()

Parameters

Returns

Inherited from

Defined in

Properties

accountId

Inherited from

Defined in

admin?

Implementation of

Defined in

allowed_ip_addresses?

Implementation of

Inherited from

Defined in

allowed_origins?

Implementation of

Inherited from

Defined in

contrib?

Implementation of

Defined in

created?

Implementation of

Inherited from

Defined in

description?

Implementation of

Inherited from

Defined in

enforce_security?

Implementation of

Inherited from

Defined in

external_index_provider?

Implementation of

Inherited from

Defined in

hidden_resources_enabled?

Implementation of

Inherited from

Defined in

hidden_resources_hide_on_creation?

Implementation of

Inherited from

Defined in

id

Implementation of

Inherited from

Defined in

nuclia

Inherited from

Defined in

search_configs?

Index Signature

Implementation of

Inherited from

Defined in

slug

Implementation of

Inherited from

Defined in

state?

Implementation of

Inherited from

Defined in

title

Implementation of

Inherited from

Defined in

zone

Implementation of

Inherited from

Defined in

Accessors