Document

Defined in: packages/core/src/schema/node.ts:333

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

Extends

• TextNode<T>

Type Parameters

T

T extends Metadata = Metadata

Constructors

Constructor

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

Defined in: packages/core/src/schema/node.ts:334

Parameters

init?

TextNodeParams<T>

Returns

Document<T>

Overrides

TextNode.constructor

Properties

id_

id_: string

Defined in: packages/core/src/schema/node.ts:63

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_

---

embedding

embedding: number[] | undefined

Defined in: packages/core/src/schema/node.ts:64

Inherited from

TextNode.embedding

---

metadata

metadata: T

Defined in: packages/core/src/schema/node.ts:67

Inherited from

TextNode.metadata

---

excludedEmbedMetadataKeys

excludedEmbedMetadataKeys: string[]

Defined in: packages/core/src/schema/node.ts:68

Inherited from

TextNode.excludedEmbedMetadataKeys

---

excludedLlmMetadataKeys

excludedLlmMetadataKeys: string[]

Defined in: packages/core/src/schema/node.ts:69

Inherited from

TextNode.excludedLlmMetadataKeys

---

relationships

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

Defined in: packages/core/src/schema/node.ts:70

Inherited from

TextNode.relationships

---

text

text: string

Defined in: packages/core/src/schema/node.ts:227

Inherited from

TextNode.text

---

textTemplate

textTemplate: string

Defined in: packages/core/src/schema/node.ts:228

Inherited from

TextNode.textTemplate

---

startCharIdx?

optional startCharIdx: number

Defined in: packages/core/src/schema/node.ts:230

Inherited from

TextNode.startCharIdx

---

endCharIdx?

optional endCharIdx: number

Defined in: packages/core/src/schema/node.ts:231

Inherited from

TextNode.endCharIdx

---

metadataSeparator

metadataSeparator: string

Defined in: packages/core/src/schema/node.ts:234

Inherited from

TextNode.metadataSeparator

Accessors

hash

Get Signature

get hash(): string

Defined in: packages/core/src/schema/node.ts:74

Returns

string

Set Signature

set hash(newValue): void

Defined in: packages/core/src/schema/node.ts:81

Parameters

newValue

string

Returns

void

Inherited from

TextNode.hash

---

sourceNode

Get Signature

get sourceNode(): RelatedNodeInfo<T> | undefined

Defined in: packages/core/src/schema/node.ts:112

Returns

RelatedNodeInfo<T> | undefined

Inherited from

TextNode.sourceNode

---

prevNode

Get Signature

get prevNode(): RelatedNodeInfo<T> | undefined

Defined in: packages/core/src/schema/node.ts:122

Returns

RelatedNodeInfo<T> | undefined

Inherited from

TextNode.prevNode

---

nextNode

Get Signature

get nextNode(): RelatedNodeInfo<T> | undefined

Defined in: packages/core/src/schema/node.ts:134

Returns

RelatedNodeInfo<T> | undefined

Inherited from

TextNode.nextNode

---

parentNode

Get Signature

get parentNode(): RelatedNodeInfo<T> | undefined

Defined in: packages/core/src/schema/node.ts:144

Returns

RelatedNodeInfo<T> | undefined

Inherited from

TextNode.parentNode

---

childNodes

Get Signature

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

Defined in: packages/core/src/schema/node.ts:154

Returns

RelatedNodeInfo<T>[] | undefined

Inherited from

TextNode.childNodes

---

type

Get Signature

get type(): ObjectType

Defined in: packages/core/src/schema/node.ts:338

Returns

ObjectType

Overrides

TextNode.type

Methods

getEmbedding()

getEmbedding(): number[]

Defined in: packages/core/src/schema/node.ts:168

Returns

number[]

Inherited from

TextNode.getEmbedding

---

asRelatedNodeInfo()

asRelatedNodeInfo(): RelatedNodeInfo<T>

Defined in: packages/core/src/schema/node.ts:176

Returns

RelatedNodeInfo<T>

Inherited from

TextNode.asRelatedNodeInfo

---

toJSON()

toJSON(): Record<string, any>

Defined in: packages/core/src/schema/node.ts:190

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>

See

toMutableJSON - use to return a mutable JSON instead

Inherited from

TextNode.toJSON

---

clone()

clone(): BaseNode

Defined in: packages/core/src/schema/node.ts:199

Returns

BaseNode

Inherited from

TextNode.clone

---

toMutableJSON()

toMutableJSON(): Record<string, any>

Defined in: packages/core/src/schema/node.ts:209

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

---

generateHash()

generateHash(): string

Defined in: packages/core/src/schema/node.ts:256

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

---

getContent()

getContent(metadataMode): string

Defined in: packages/core/src/schema/node.ts:271

Parameters

metadataMode

MetadataMode = MetadataMode.NONE

Returns

string

Inherited from

TextNode.getContent

---

getMetadataStr()

getMetadataStr(metadataMode): string

Defined in: packages/core/src/schema/node.ts:276

Parameters

metadataMode

MetadataMode

Returns

string

Inherited from

TextNode.getMetadataStr

---

setContent()

setContent(value): void

Defined in: packages/core/src/schema/node.ts:297

Parameters

value

string

Returns

void

Inherited from

TextNode.setContent

---

getNodeInfo()

getNodeInfo(): object

Defined in: packages/core/src/schema/node.ts:302

Returns

object

start

start: number | undefined

end

end: number | undefined

Inherited from

TextNode.getNodeInfo

---

getText()

getText(): string

Defined in: packages/core/src/schema/node.ts:306

Returns

string

Inherited from

TextNode.getText