Skip to main content

Resource

@nuclia/core

@nuclia/core / Resource

Class: Resource

Defined in: libs/sdk-core/src/lib/db/resource/resource.ts:182

Extends ReadableResource and implements all the write operations.

Extends​

Extended by​

Implements​

Constructors​

Constructor​

new Resource(nuclia, kb, data): Resource

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

Parameters​

nuclia​

INuclia

kb​

string

data​

IResource

Returns​

Resource

Overrides​

ReadableResource.constructor

Properties​

computedmetadata?​

optional computedmetadata?: ComputedMetadata

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

Implementation of​

IResource.computedmetadata

Inherited from​

ReadableResource.computedmetadata

created?​

optional created?: string

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

Implementation of​

IResource.created

Inherited from​

ReadableResource.created

data​

data: ResourceData = {}

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

Implementation of​

IResource.data

Inherited from​

ReadableResource.data

extra?​

optional extra?: ExtraMetadata

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

Implementation of​

IResource.extra

Inherited from​

ReadableResource.extra

fieldmetadata?​

optional fieldmetadata?: UserFieldMetadata[]

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

Implementation of​

IResource.fieldmetadata

Inherited from​

ReadableResource.fieldmetadata

hidden?​

optional hidden?: boolean

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

Implementation of​

IResource.hidden

Inherited from​

ReadableResource.hidden

icon?​

optional icon?: string

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

Implementation of​

IResource.icon

Inherited from​

ReadableResource.icon

id​

id: string

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

Implementation of​

IResource.id

Inherited from​

ReadableResource.id

kb​

kb: string

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

last_account_seq?​

optional last_account_seq?: number

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

Implementation of​

IResource.last_account_seq

Inherited from​

ReadableResource.last_account_seq

last_seqid?​

optional last_seqid?: number

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

Implementation of​

IResource.last_seqid

Inherited from​

ReadableResource.last_seqid

metadata?​

optional metadata?: Metadata

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

Implementation of​

IResource.metadata

Inherited from​

ReadableResource.metadata

modified?​

optional modified?: string

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

Implementation of​

IResource.modified

Inherited from​

ReadableResource.modified

origin?​

optional origin?: Origin

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

Implementation of​

IResource.origin

Inherited from​

ReadableResource.origin

queue?​

optional queue?: "private" | "shared"

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

Implementation of​

IResource.queue

Inherited from​

ReadableResource.queue

relations?​

optional relations?: Relation[] | null

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

Implementation of​

IResource.relations

Inherited from​

ReadableResource.relations

security?​

optional security?: Security

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

Implementation of​

IResource.security

Inherited from​

ReadableResource.security

slug?​

optional slug?: string

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

Implementation of​

IResource.slug

Inherited from​

ReadableResource.slug

summary?​

optional summary?: string

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

Implementation of​

IResource.summary

Inherited from​

ReadableResource.summary

thumbnail?​

optional thumbnail?: string

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

Implementation of​

IResource.thumbnail

Inherited from​

ReadableResource.thumbnail

title?​

optional title?: string

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

Implementation of​

IResource.title

Inherited from​

ReadableResource.title

usermetadata?​

optional usermetadata?: UserMetadata

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

Implementation of​

IResource.usermetadata

Inherited from​

ReadableResource.usermetadata

uuid​

uuid: string

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

Accessors​

kbPath​

Get Signature​

get kbPath(): string

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

Returns​

string

path​

Get Signature​

get path(): string

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

Returns​

string

Methods​

appendMessages()​

appendMessages(field, messages): Observable<void>

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

Appends messages to a conversation field

Parameters​

field​

string

messages​

Message[]

Returns​

Observable<void>

ask()​

Call Signature​

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

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

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>

Call Signature​

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

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

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

callback?​

(answer) => void

Returns​

Observable<null>

askToResource()​

Call Signature​

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

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

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>

Call Signature​

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

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

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

callback?​

(answer) => void

Returns​

Observable<null>

batchUpload()​

batchUpload(files): Observable<UploadStatus>

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

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>

delete()​

delete(synchronous?): Observable<void>

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

Deletes the resource.

Parameters​

synchronous?​

boolean = true

Returns​

Observable<void>

deleteField()​

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

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

Deletes the field with the given type and id.

Parameters​

type​

FIELD_TYPE

field​

string

synchronous?​

boolean = false

Returns​

Observable<void>

find()​

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

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

Performs a find operation in the resource.

Parameters​

query​

string

features?​

ResourceFeatures[] = []

options?​

SearchOptions

Returns​

Observable<FindResults | IErrorResponse>

getClassifications()​

getClassifications(): Classification[]

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

Returns​

Classification[]

Inherited from​

ReadableResource.getClassifications

getExtractedSummaries()​

getExtractedSummaries(): string[]

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

Returns the summaries generated by Nuclia for every resource fields.

Returns​

string[]

Inherited from​

ReadableResource.getExtractedSummaries

getExtractedTexts()​

getExtractedTexts(): ExtractedText[]

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

Returns the texts generated by Nuclia for every resource fields.

Returns​

ExtractedText[]

Inherited from​

ReadableResource.getExtractedTexts

getField()​

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

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

Parameters​

type​

FIELD_TYPE

field​

string

show?​

ResourceFieldProperties[] = ...

extracted?​

ExtractedDataTypes[] = ...

page?​

number | "last" | undefined

Returns​

Observable<ResourceField>

getFieldData()​

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

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

Type Parameters​

T​

T = IFieldData

Parameters​

type​

keyof ResourceData

fieldId​

string

Returns​

T | undefined

Inherited from​

ReadableResource.getFieldData

getFields()​

getFields<T>(types?): T[]

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

Type Parameters​

T​

T = IFieldData

Parameters​

types?​

keyof ResourceData[] = ...

Returns​

T[]

Inherited from​

ReadableResource.getFields

getFiles()​

getFiles(): CloudLink[]

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

Returns the files contained in the resource.

Returns​

CloudLink[]

Inherited from​

ReadableResource.getFiles

getNamedEntities()​

getNamedEntities(): object

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

Returns the entities extracted from the resource.

Returns​

object

Inherited from​

ReadableResource.getNamedEntities

getParagraphText()​

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

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

Parameters​

fieldType​

FIELD_TYPE

fieldId​

string

paragraph​

Paragraph

split?​

string

Returns​

string

Inherited from​

ReadableResource.getParagraphText

getPositionedNamedEntities()​

getPositionedNamedEntities(fieldType, fieldId): PositionedNER[]

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

Parameters​

fieldType​

keyof ResourceData

fieldId​

string

Returns​

PositionedNER[]

Inherited from​

ReadableResource.getPositionedNamedEntities

getSentenceText()​

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

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

Parameters​

fieldType​

FIELD_TYPE

fieldId​

string

sentence​

Sentence

split?​

string

Returns​

string

Inherited from​

ReadableResource.getSentenceText

getThumbnails()​

getThumbnails(): CloudLink[]

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

Returns the thumbnails generated by Nuclia for every resource fields.

Returns​

CloudLink[]

Inherited from​

ReadableResource.getThumbnails

getThumbnailsUrl()​

getThumbnailsUrl(): Observable<string[]>

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

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

Returns​

Observable<string[]>

modify()​

modify(data, synchronous?): Observable<void>

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

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>

reprocess()​

reprocess(): Observable<void>

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

Triggers a resource reprocessing.

Returns​

Observable<void>

runTasks()​

runTasks(agent_ids?): Observable<TaskResults>

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

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

Parameters​

agent_ids?​

string[]

Returns​

Observable<TaskResults>

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

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

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

Parameters​

query​

string

features?​

ResourceFeatures[] = []

options?​

SearchOptions

Returns​

Observable<IErrorResponse | Results>

setField()​

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

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

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>

setLabels()​

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

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

Parameters​

fieldId​

string

fieldType​

string

paragraphId​

string

labels​

Classification[]

Returns​

Observable<void>

upload()​

Call Signature​

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

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

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>

Call Signature​

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

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

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

buffer​

ArrayBuffer

TUS?​

boolean

metadata?​

FileMetadata

Returns​

Observable<UploadResponse>