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
Defined in
packages/core/dist/schema/index.d.ts:130
Properties
embedding?
optional
embedding:number
[]
Inherited from
Defined in
packages/core/dist/schema/index.d.ts:52
endCharIdx?
optional
endCharIdx:number
Inherited from
Defined in
packages/core/dist/schema/index.d.ts:99
excludedEmbedMetadataKeys
excludedEmbedMetadataKeys:
string
[]
Inherited from
TextNode
.excludedEmbedMetadataKeys
Defined in
packages/core/dist/schema/index.d.ts:54
excludedLlmMetadataKeys
excludedLlmMetadataKeys:
string
[]
Inherited from
TextNode
.excludedLlmMetadataKeys
Defined in
packages/core/dist/schema/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
Defined in
packages/core/dist/schema/index.d.ts:51
metadata
metadata:
T
Inherited from
Defined in
packages/core/dist/schema/index.d.ts:53
metadataSeparator
metadataSeparator:
string
Inherited from
Defined in
packages/core/dist/schema/index.d.ts:100
relationships
relationships:
Partial
<Record
<NodeRelationship
,RelatedNodeType
<T
>>>
Inherited from
Defined in
packages/core/dist/schema/index.d.ts:56
startCharIdx?
optional
startCharIdx:number
Inherited from
Defined in
packages/core/dist/schema/index.d.ts:98