Resource

@nuclia/core • Docs

---

@nuclia/core / Resource

Class: Resource

Extends ReadableResource and implements all the write operations.

Extends

• ReadableResource

Extended by

• Session

Implements

• IResource

Constructors

new Resource()

new Resource(nuclia, kb, data): Resource

Parameters

• nuclia: INuclia

• kb: string

• data: IResource

Returns

Resource

Overrides

ReadableResource.constructor

Defined in

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

Properties

computedmetadata?

optional computedmetadata: ComputedMetadata

Implementation of

IResource.computedmetadata

Inherited from

ReadableResource.computedmetadata

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:10

---

created?

optional created: string

Implementation of

IResource.created

Inherited from

ReadableResource.created

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:14

---

data

data: ResourceData = {}

Implementation of

IResource.data

Inherited from

ReadableResource.data

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:45

---

extra?

optional extra: ExtraMetadata

Implementation of

IResource.extra

Inherited from

ReadableResource.extra

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:11

---

fieldmetadata?

optional fieldmetadata: UserFieldMetadata[]

Implementation of

IResource.fieldmetadata

Inherited from

ReadableResource.fieldmetadata

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:9

---

hidden?

optional hidden: boolean

Implementation of

IResource.hidden

Inherited from

ReadableResource.hidden

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:20

---

icon?

optional icon: string

Implementation of

IResource.icon

Inherited from

ReadableResource.icon

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:6

---

id

id: string

Implementation of

IResource.id

Inherited from

ReadableResource.id

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:2

---

kb

kb: string

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:183

---

last_account_seq?

optional last_account_seq: number

Implementation of

IResource.last_account_seq

Inherited from

ReadableResource.last_account_seq

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:18

---

last_seqid?

optional last_seqid: number

Implementation of

IResource.last_seqid

Inherited from

ReadableResource.last_seqid

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:17

---

metadata?

optional metadata: Metadata

Implementation of

IResource.metadata

Inherited from

ReadableResource.metadata

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:7

---

modified?

optional modified: string

Implementation of

IResource.modified

Inherited from

ReadableResource.modified

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:15

---

origin?

optional origin: Origin

Implementation of

IResource.origin

Inherited from

ReadableResource.origin

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:12

---

queue?

optional queue: "private" | "shared"

Implementation of

IResource.queue

Inherited from

ReadableResource.queue

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:19

---

relations?

optional relations: null | Relation[]

Implementation of

IResource.relations

Inherited from

ReadableResource.relations

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:21

---

security?

optional security: Security

Implementation of

IResource.security

Inherited from

ReadableResource.security

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:13

---

slug?

optional slug: string

Implementation of

IResource.slug

Inherited from

ReadableResource.slug

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:3

---

summary?

optional summary: string

Implementation of

IResource.summary

Inherited from

ReadableResource.summary

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:5

---

thumbnail?

optional thumbnail: string

Implementation of

IResource.thumbnail

Inherited from

ReadableResource.thumbnail

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:16

---

title?

optional title: string

Implementation of

IResource.title

Inherited from

ReadableResource.title

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:4

---

usermetadata?

optional usermetadata: UserMetadata

Implementation of

IResource.usermetadata

Inherited from

ReadableResource.usermetadata

Defined in

libs/sdk-core/src/lib/db/resource/resource.models.ts:8

---

uuid

uuid: string

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:184

Accessors

kbPath

get kbPath(): string

Returns

string

Defined in

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

---

path

get path(): string

Returns

string

Defined in

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

Methods

appendMessages()

appendMessages(field, messages): Observable<void>

Appends messages to a conversation field

Parameters

• field: string

• messages: Message[]

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:305

---

ask()

ask(query, context, features, options)

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

Retrieves a generative answer for the given query based on the results of a search operation performed on the resource.

Parameters

• query: string

• context?: ContextEntry[]

• features?: Features[]

• options?: ChatOptions

Returns

Observable<Answer | IErrorResponse>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:372

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>

Defined in

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

---

askToResource()

askToResource(query, context, features, options)

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

Retrieves a generative answer for the given query using the entire resource as context (the resource's text might be shorten if too large).

Parameters

• query: string

• context?: ContextEntry[]

• features?: Features[]

• options?: ChatOptions

Returns

Observable<Answer | IErrorResponse>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:404

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

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

Parameters

• query: string

• context?: ContextEntry[]

• features?: Features[]

• options?: ChatOptions

• callback?

Returns

Observable<null>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:410

---

batchUpload()

batchUpload(files): Observable<UploadStatus>

Uploads a list of files in the resource. It automatically creates a new field for each file (named according to the filename). It uses the TUS protocol to upload the files.

Parameters

• files: FileList | File[]

Returns

Observable<UploadStatus>

Defined in

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

---

delete()

delete(synchronous): Observable<void>

Deletes the resource.

Parameters

• synchronous: boolean = true

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:228

---

deleteField()

deleteField(type, field, synchronous): Observable<void>

Deletes the field with the given type and id.

Parameters

• type: FIELD_TYPE

• field: string

• synchronous: boolean = false

Returns

Observable<void>

Defined in

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

---

find()

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

Performs a find operation in the resource.

Parameters

• query: string

• features: ResourceFeatures[] = []

• options?: SearchOptions

Returns

Observable<FindResults | IErrorResponse>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:353

---

getClassifications()

getClassifications(): Classification[]

Returns

Classification[]

Inherited from

ReadableResource.getClassifications

Defined in

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

---

getExtractedSummaries()

getExtractedSummaries(): string[]

Returns the summaries generated by Nuclia for every resource fields.

Returns

string[]

Inherited from

ReadableResource.getExtractedSummaries

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:71

---

getExtractedTexts()

getExtractedTexts(): ExtractedText[]

Returns the texts generated by Nuclia for every resource fields.

Returns

ExtractedText[]

Inherited from

ReadableResource.getExtractedTexts

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:78

---

getField()

getField(type, field, show, extracted, page): Observable<ResourceField>

Parameters

• type: FIELD_TYPE

• field: string

• show: ResourceFieldProperties[] = ...

• extracted: ExtractedDataTypes[] = ...

• page: undefined | number | "last" = undefined

Returns

Observable<ResourceField>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:239

---

getFieldData()

getFieldData<T>(type, fieldId): undefined | T

Type Parameters

• T = IFieldData

Parameters

• type: keyof ResourceData

• fieldId: string

Returns

undefined | T

Inherited from

ReadableResource.getFieldData

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:65

---

getFields()

getFields<T>(types): T[]

Type Parameters

• T = IFieldData

Parameters

• types: keyof ResourceData[] = ...

Returns

T[]

Inherited from

ReadableResource.getFields

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:56

---

getFiles()

getFiles(): CloudLink[]

Returns the files contained in the resource.

Returns

CloudLink[]

Inherited from

ReadableResource.getFiles

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:85

---

getNamedEntities()

getNamedEntities(): object

Returns the entities extracted from the resource.

Returns

object

Inherited from

ReadableResource.getNamedEntities

Defined in

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

---

getParagraphText()

getParagraphText(fieldType, fieldId, paragraph, split?): string

Parameters

• fieldType: FIELD_TYPE

• fieldId: string

• paragraph: Paragraph

• split?: string

Returns

string

Inherited from

ReadableResource.getParagraphText

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:161

---

getPositionedNamedEntities()

getPositionedNamedEntities(fieldType, fieldId): PositionedNER[]

Parameters

• fieldType: keyof ResourceData

• fieldId: string

Returns

PositionedNER[]

Inherited from

ReadableResource.getPositionedNamedEntities

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:137

---

getSentenceText()

getSentenceText(fieldType, fieldId, sentence, split?): string

Parameters

• fieldType: FIELD_TYPE

• fieldId: string

• sentence: Sentence

• split?: string

Returns

string

Inherited from

ReadableResource.getSentenceText

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:165

---

getThumbnails()

getThumbnails(): CloudLink[]

Returns the thumbnails generated by Nuclia for every resource fields.

Returns

CloudLink[]

Inherited from

ReadableResource.getThumbnails

Defined in

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

---

getThumbnailsUrl()

getThumbnailsUrl(): Observable<string[]>

Returns the thumbnails generated by Nuclia for every resource fields as blob: URLs.

Returns

Observable<string[]>

Defined in

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

---

modify()

modify(data, synchronous): Observable<void>

Modifies the resource attributes.

Example:

nuclia.db
  .getKnowledgeBox('my-account', 'my-kb')
  .pipe(
    switchMap((knowledgeBox) => knowledgeBox.getResource('my-resource')),
    switchMap((resource) => resource.modify({ description: 'new description' })),
  )
  .subscribe(() => {
    console.log('resource modified');
  });

Parameters

• data: Partial<ICreateResource>

• synchronous: boolean = true

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:221

---

reprocess()

reprocess(): Observable<void>

Triggers a resource reprocessing.

Returns

Observable<void>

Defined in

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

---

runTasks()

runTasks(agent_ids?): Observable<TaskResults>

Run tasks on the resource and return the results (the results are not stored within the resource).

Parameters

• agent_ids?: string[]

Returns

Observable<TaskResults>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:437

---

search()

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

Performs a search operation in the resource (similar as find() but results are not nested).

Parameters

• query: string

• features: ResourceFeatures[] = []

• options?: SearchOptions

Returns

Observable<Results | IErrorResponse>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:344

---

setField()

setField(type, field, data): Observable<void>

Adds or updates a field in the resource.

Example:

nuclia.db
  .getKnowledgeBox('my-account', 'my-kb')
  .pipe(
    switchMap((knowledgeBox) =>
      knowledgeBox.getResource('my-resource').pipe(
        switchMap((resource) =>
          resource.setField(FIELD_TYPE.text, 'my-field', {
            body: '*my text*',
            format: 'MARKDOWN',
          }),
        ),
      ),
    ),
  )
  .subscribe(() => {
    console.log('field added');
  });

Parameters

• type: FIELD_TYPE

• field: string

• data: FileField | LinkField | TextField | ConversationField

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:296

---

setLabels()

setLabels(fieldId, fieldType, paragraphId, labels): Observable<void>

Parameters

• fieldId: string

• fieldType: string

• paragraphId: string

• labels: Classification[]

Returns

Observable<void>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:428

---

upload()

upload(field, file, TUS, metadata)

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

Uploads a file in the resource. The field will be stored in the indicated field.

Example:

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

Parameters

• field: string

• file: File

• TUS?: boolean

• metadata?: FileMetadata

Returns

Observable<UploadResponse>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:325

upload(field, buffer, TUS, metadata)

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

Parameters

• field: string

• buffer: ArrayBuffer

• TUS?: boolean

• metadata?: FileMetadata

Returns

Observable<UploadResponse>

Defined in

libs/sdk-core/src/lib/db/resource/resource.ts:326