Class: Document<T>

A document is just a special text node with a docId.

Extends

• TextNode<T>

Type parameters

• T extends Metadata = Metadata

Constructors

new Document()

new Document<T>(init?): Document<T>

Parameters

• init?: TextNodeParams<T>

Returns

Document<T>

Overrides

TextNode . constructor

Source

packages/core/src/Node.ts:315

Properties

embedding?

optional embedding: number[]

Inherited from

TextNode . embedding

Source

packages/core/src/Node.ts:61

---

endCharIdx?

optional endCharIdx: number

Inherited from

TextNode . endCharIdx

Source

packages/core/src/Node.ts:214

---

excludedEmbedMetadataKeys

excludedEmbedMetadataKeys: string[]

Inherited from

TextNode . excludedEmbedMetadataKeys

Source

packages/core/src/Node.ts:65

---

excludedLlmMetadataKeys

excludedLlmMetadataKeys: string[]

Inherited from

TextNode . excludedLlmMetadataKeys

Source

packages/core/src/Node.ts:66

---

id_

id_: string

The unique ID of the Node/Document. The trailing underscore is here to avoid collisions with the id keyword in Python.

Set to a UUID by default.

Inherited from

TextNode . id_

Source

packages/core/src/Node.ts:60

---

metadata

metadata: T

Inherited from

TextNode . metadata

Source

packages/core/src/Node.ts:64

---

metadataSeparator

metadataSeparator: string

Inherited from

TextNode . metadataSeparator

Source

packages/core/src/Node.ts:217

---

relationships

relationships: Partial<Record <NodeRelationship, RelatedNodeType<T>>>

Inherited from

TextNode . relationships

Source

packages/core/src/Node.ts:67

---

startCharIdx?

optional startCharIdx: number

Inherited from

TextNode . startCharIdx

Source

packages/core/src/Node.ts:213

---

text

text: string

Inherited from

TextNode . text

Source

packages/core/src/Node.ts:210

---

textTemplate

textTemplate: string

Inherited from

TextNode . textTemplate

Source

packages/core/src/Node.ts:211

Accessors

childNodes

get childNodes(): undefined | RelatedNodeInfo<T>[]

Returns

undefined | RelatedNodeInfo<T>[]

Source

packages/core/src/Node.ts:139

---

hash

---

nextNode

get nextNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Source

packages/core/src/Node.ts:119

---

parentNode

get parentNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Source

packages/core/src/Node.ts:129

---

prevNode

get prevNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Source

packages/core/src/Node.ts:107

---

sourceNode

get sourceNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Source

packages/core/src/Node.ts:97

---

type

get type(): ObjectType

Returns

ObjectType

Source

packages/core/src/Node.ts:319

Methods

asRelatedNodeInfo()

asRelatedNodeInfo(): RelatedNodeInfo<T>

Returns

RelatedNodeInfo<T>

Inherited from

TextNode . asRelatedNodeInfo

Source

packages/core/src/Node.ts:161

---

clone()

clone(): BaseNode <Metadata>

Returns

BaseNode <Metadata>

Inherited from

TextNode . clone

Source

packages/core/src/Node.ts:183

---

generateHash()

generateHash(): string

Generate a hash of the text node. The ID is not part of the hash as it can change independent of content.

Returns

string

Inherited from

TextNode . generateHash

Source

packages/core/src/Node.ts:237

---

getContent()

getContent(metadataMode): string

Parameters

• metadataMode: MetadataMode= MetadataMode.NONE

Returns

string

Inherited from

TextNode . getContent

Source

packages/core/src/Node.ts:252

---

getEmbedding()

getEmbedding(): number[]

Returns

number[]

Inherited from

TextNode . getEmbedding

Source

packages/core/src/Node.ts:153

---

getMetadataStr()

getMetadataStr(metadataMode): string

Parameters

• metadataMode: MetadataMode

Returns

string

Inherited from

TextNode . getMetadataStr

Source

packages/core/src/Node.ts:257

---

getNodeInfo()

getNodeInfo(): object

Returns

object

end

end: undefined | number

start

start: undefined | number

Inherited from

TextNode . getNodeInfo

Source

packages/core/src/Node.ts:283

---

getText()

getText(): string

Returns

string

Inherited from

TextNode . getText

Source

packages/core/src/Node.ts:287

---

setContent()

setContent(value): void

Parameters

• value: string

Returns

void

Inherited from

TextNode . setContent

Source

packages/core/src/Node.ts:278

---

toJSON()

toJSON(): Record<string, any>

Called by built in JSON.stringify (see https://javascript.info/json) Properties are read-only as they are not deep-cloned (not necessary for stringification).

Returns

Record<string, any>

Inherited from

TextNode . toJSON

See

toMutableJSON - use to return a mutable JSON instead

Source

packages/core/src/Node.ts:174

---

toMutableJSON()

toMutableJSON(): Record<string, any>

Converts the object to a JSON representation. Properties can be safely modified as a deep clone of the properties are created.

Returns

Record<string, any>

• The JSON representation of the object.

Inherited from

TextNode . toMutableJSON

Source

packages/core/src/Node.ts:192