ReadableSession

@nuclia/core • Docs

---

@nuclia/core / ReadableSession

Class: ReadableSession

Implements all the read operation on sessions.

A session allows you to store content in the Retrieval Agent. A single sessio might contain several fields.

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

Extends

• ReadableResource

Implements

• ISession

Constructors

new ReadableSession()

new ReadableSession(data): ReadableSession

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

ReadableSession

Inherited from

ReadableResource.constructor

Defined in

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

Properties

computedmetadata?

optional computedmetadata: ComputedMetadata

Implementation of

ISession.computedmetadata

Inherited from

ReadableResource.computedmetadata

Defined in

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

---

created?

optional created: string

Implementation of

ISession.created

Inherited from

ReadableResource.created

Defined in

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

---

data

data: ResourceData = {}

Implementation of

ISession.data

Inherited from

ReadableResource.data

Defined in

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

---

extra?

optional extra: ExtraMetadata

Implementation of

ISession.extra

Inherited from

ReadableResource.extra

Defined in

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

---

fieldmetadata?

optional fieldmetadata: UserFieldMetadata[]

Implementation of

ISession.fieldmetadata

Inherited from

ReadableResource.fieldmetadata

Defined in

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

---

hidden?

optional hidden: boolean

Implementation of

ISession.hidden

Inherited from

ReadableResource.hidden

Defined in

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

---

icon?

optional icon: string

Implementation of

ISession.icon

Inherited from

ReadableResource.icon

Defined in

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

---

id

id: string

Implementation of

ISession.id

Inherited from

ReadableResource.id

Defined in

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

---

last_account_seq?

optional last_account_seq: number

Implementation of

ISession.last_account_seq

Inherited from

ReadableResource.last_account_seq

Defined in

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

---

last_seqid?

optional last_seqid: number

Implementation of

ISession.last_seqid

Inherited from

ReadableResource.last_seqid

Defined in

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

---

metadata?

optional metadata: Metadata

Implementation of

ISession.metadata

Inherited from

ReadableResource.metadata

Defined in

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

---

modified?

optional modified: string

Implementation of

ISession.modified

Inherited from

ReadableResource.modified

Defined in

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

---

origin?

optional origin: Origin

Implementation of

ISession.origin

Inherited from

ReadableResource.origin

Defined in

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

---

queue?

optional queue: "private" | "shared"

Implementation of

ISession.queue

Inherited from

ReadableResource.queue

Defined in

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

---

security?

optional security: Security

Implementation of

ISession.security

Inherited from

ReadableResource.security

Defined in

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

---

slug?

optional slug: string

Implementation of

ISession.slug

Inherited from

ReadableResource.slug

Defined in

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

---

summary?

optional summary: string

Implementation of

ISession.summary

Inherited from

ReadableResource.summary

Defined in

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

---

thumbnail?

optional thumbnail: string

Implementation of

ISession.thumbnail

Inherited from

ReadableResource.thumbnail

Defined in

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

---

title?

optional title: string

Implementation of

ISession.title

Inherited from

ReadableResource.title

Defined in

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

---

usermetadata?

optional usermetadata: UserMetadata

Implementation of

ISession.usermetadata

Inherited from

ReadableResource.usermetadata

Defined in

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

Methods

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

---

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): string

Parameters

• fieldType: FIELD_TYPE

• fieldId: string

• paragraph: Paragraph

Returns

string

Inherited from

ReadableResource.getParagraphText

Defined in

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

---

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): string

Parameters

• fieldType: FIELD_TYPE

• fieldId: string

• sentence: Sentence

Returns

string

Inherited from

ReadableResource.getSentenceText

Defined in

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

---

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