ReadableResource

@nuclia/core

---

@nuclia/core / ReadableResource

Class: ReadableResource

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

Implements all the read operations on resources.

A resource allows you to store content in the Knowledge Box. A single resource might contain several fields.

Fields have different types: files, links, texts, conversations, etc.

Extends

• IResource

Extended by

• Resource
• ReadableSession

Implements

• IResource

Constructors

Constructor

new ReadableResource(data): ReadableResource

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

Note: Usually you will not need to create a Resource object yourself. It is returned by the getResource method of the KnowledgeBox object.

Parameters

data

IResource

Returns

ReadableResource

Inherited from

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

IResource.computedmetadata

---

created?

optional created?: string

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

Implementation of

IResource.created

Inherited from

IResource.created

---

data

data: ResourceData = {}

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

Implementation of

IResource.data

Inherited from

IResource.data

---

extra?

optional extra?: ExtraMetadata

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

Implementation of

IResource.extra

Inherited from

IResource.extra

---

fieldmetadata?

optional fieldmetadata?: UserFieldMetadata[]

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

Implementation of

IResource.fieldmetadata

Inherited from

IResource.fieldmetadata

---

hidden?

optional hidden?: boolean

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

Implementation of

IResource.hidden

Inherited from

IResource.hidden

---

icon?

optional icon?: string

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

Implementation of

IResource.icon

Inherited from

IResource.icon

---

id

id: string

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

Implementation of

IResource.id

Inherited from

IResource.id

---

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

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

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

IResource.metadata

---

modified?

optional modified?: string

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

Implementation of

IResource.modified

Inherited from

IResource.modified

---

origin?

optional origin?: Origin

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

Implementation of

IResource.origin

Inherited from

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

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

IResource.relations

---

security?

optional security?: Security

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

Implementation of

IResource.security

Inherited from

IResource.security

---

slug?

optional slug?: string

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

Implementation of

IResource.slug

Inherited from

IResource.slug

---

summary?

optional summary?: string

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

Implementation of

IResource.summary

Inherited from

IResource.summary

---

thumbnail?

optional thumbnail?: string

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

Implementation of

IResource.thumbnail

Inherited from

IResource.thumbnail

---

title?

optional title?: string

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

Implementation of

IResource.title

Inherited from

IResource.title

---

usermetadata?

optional usermetadata?: UserMetadata

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

Implementation of

IResource.usermetadata

Inherited from

IResource.usermetadata

Methods

getClassifications()

getClassifications(): Classification[]

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

Returns

Classification[]

---

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[]

---

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[]

---

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

---

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[]

---

getFiles()

getFiles(): CloudLink[]

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

Returns the files contained in the resource.

Returns

CloudLink[]

---

getNamedEntities()

getNamedEntities(): object

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

Returns the entities extracted from the resource.

Returns

object

---

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

---

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[]

---

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

---

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[]