Skip to main content

Class: Document<T>

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

Extends

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

Defined in

packages/core/schema/dist/index.d.ts:130

Properties

embedding

embedding: undefined | number[]

Inherited from

TextNode.embedding

Defined in

packages/core/schema/dist/index.d.ts:52


endCharIdx?

optional endCharIdx: number

Inherited from

TextNode.endCharIdx

Defined in

packages/core/schema/dist/index.d.ts:99


excludedEmbedMetadataKeys

excludedEmbedMetadataKeys: string[]

Inherited from

TextNode.excludedEmbedMetadataKeys

Defined in

packages/core/schema/dist/index.d.ts:54


excludedLlmMetadataKeys

excludedLlmMetadataKeys: string[]

Inherited from

TextNode.excludedLlmMetadataKeys

Defined in

packages/core/schema/dist/index.d.ts:55


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_

Defined in

packages/core/schema/dist/index.d.ts:51


metadata

metadata: T

Inherited from

TextNode.metadata

Defined in

packages/core/schema/dist/index.d.ts:53


metadataSeparator

metadataSeparator: string

Inherited from

TextNode.metadataSeparator

Defined in

packages/core/schema/dist/index.d.ts:100


relationships

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

Inherited from

TextNode.relationships

Defined in

packages/core/schema/dist/index.d.ts:56


startCharIdx?

optional startCharIdx: number

Inherited from

TextNode.startCharIdx

Defined in

packages/core/schema/dist/index.d.ts:98


text

text: string

Inherited from

TextNode.text

Defined in

packages/core/schema/dist/index.d.ts:96


textTemplate

textTemplate: string

Inherited from

TextNode.textTemplate

Defined in

packages/core/schema/dist/index.d.ts:97

Accessors

childNodes

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

Returns

undefined | RelatedNodeInfo<T>[]

Inherited from

TextNode.childNodes

Defined in

packages/core/schema/dist/index.d.ts:67


hash

Inherited from

TextNode.hash

Defined in

packages/core/schema/dist/index.d.ts:57


nextNode

get nextNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

TextNode.nextNode

Defined in

packages/core/schema/dist/index.d.ts:65


parentNode

get parentNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

TextNode.parentNode

Defined in

packages/core/schema/dist/index.d.ts:66


prevNode

get prevNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

TextNode.prevNode

Defined in

packages/core/schema/dist/index.d.ts:64


sourceNode

get sourceNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

TextNode.sourceNode

Defined in

packages/core/schema/dist/index.d.ts:63


type

get type(): ObjectType

Returns

ObjectType

Overrides

TextNode.type

Defined in

packages/core/schema/dist/index.d.ts:131

Methods

asRelatedNodeInfo()

asRelatedNodeInfo(): RelatedNodeInfo<T>

Returns

RelatedNodeInfo<T>

Inherited from

TextNode.asRelatedNodeInfo

Defined in

packages/core/schema/dist/index.d.ts:70


clone()

clone(): BaseNode<Metadata>

Returns

BaseNode<Metadata>

Inherited from

TextNode.clone

Defined in

packages/core/schema/dist/index.d.ts:77


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

Defined in

packages/core/schema/dist/index.d.ts:107


getContent()

getContent(metadataMode?): string

Parameters

metadataMode?: MetadataMode

Returns

string

Inherited from

TextNode.getContent

Defined in

packages/core/schema/dist/index.d.ts:109


getEmbedding()

getEmbedding(): number[]

Returns

number[]

Inherited from

TextNode.getEmbedding

Defined in

packages/core/schema/dist/index.d.ts:69


getMetadataStr()

getMetadataStr(metadataMode): string

Parameters

metadataMode: MetadataMode

Returns

string

Inherited from

TextNode.getMetadataStr

Defined in

packages/core/schema/dist/index.d.ts:110


getNodeInfo()

getNodeInfo(): object

Returns

object

end

end: undefined | number

start

start: undefined | number

Inherited from

TextNode.getNodeInfo

Defined in

packages/core/schema/dist/index.d.ts:112


getText()

getText(): string

Returns

string

Inherited from

TextNode.getText

Defined in

packages/core/schema/dist/index.d.ts:116


setContent()

setContent(value): void

Parameters

value: string

Returns

void

Inherited from

TextNode.setContent

Defined in

packages/core/schema/dist/index.d.ts:111


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>

See

toMutableJSON - use to return a mutable JSON instead

Inherited from

TextNode.toJSON

Defined in

packages/core/schema/dist/index.d.ts:76


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

Defined in

packages/core/schema/dist/index.d.ts:83