Class: Document
A document is just a special text node with a docId.
Hierarchy
↳
Document
Constructors
constructor
• new Document(init?
)
Parameters
Name | Type |
---|---|
init? | Partial <Document > |
Overrides
Defined in
Node.ts:216
Properties
embedding
• Optional
embedding: number
[]
Inherited from
Defined in
Node.ts:39
endCharIdx
• Optional
endCharIdx: number
Inherited from
Defined in
Node.ts:139
excludedEmbedMetadataKeys
• excludedEmbedMetadataKeys: string
[] = []
Inherited from
TextNode.excludedEmbedMetadataKeys
Defined in
Node.ts:43
excludedLlmMetadataKeys
• excludedLlmMetadataKeys: string
[] = []
Inherited from
TextNode.excludedLlmMetadataKeys
Defined in
Node.ts:44
hash
• hash: string
= ""
Inherited from
Defined in
Node.ts:46
id_
• id_: string
Inherited from
Defined in
Node.ts:38
metadata
• metadata: Record
<string
, any
> = {}
Inherited from
Defined in
Node.ts:42
metadataSeparator
• metadataSeparator: string
= "\n"
Inherited from
Defined in
Node.ts:142
relationships
• relationships: Partial
<Record
<NodeRelationship
, RelatedNodeType
>> = {}
Inherited from
Defined in
Node.ts:45
startCharIdx
• Optional
startCharIdx: number
Inherited from
Defined in
Node.ts:138
text
• text: string
= ""
Inherited from
Defined in
Node.ts:137
Accessors
childNodes
• get
childNodes(): undefined
| RelatedNodeInfo
[]
Returns
undefined
| RelatedNodeInfo
[]
Inherited from
TextNode.childNodes
Defined in
Node.ts:104
docId
• get
docId(): string
Returns
string
Defined in
Node.ts:225
nextNode
• get
nextNode(): undefined
| RelatedNodeInfo
Returns
undefined
| RelatedNodeInfo
Inherited from
TextNode.nextNode
Defined in
Node.ts:84
nodeId
• get
nodeId(): string
Returns
string
Inherited from
TextNode.nodeId
Defined in
Node.ts:58
parentNode
• get
parentNode(): undefined
| RelatedNodeInfo
Returns
undefined
| RelatedNodeInfo
Inherited from
TextNode.parentNode
Defined in
Node.ts:94
prevNode
• get
prevNode(): undefined
| RelatedNodeInfo
Returns
undefined
| RelatedNodeInfo
Inherited from
TextNode.prevNode
Defined in
Node.ts:72
sourceNode
• get
sourceNode(): undefined
| RelatedNodeInfo
Returns
undefined
| RelatedNodeInfo
Inherited from
TextNode.sourceNode
Defined in
Node.ts:62
Methods
asRelatedNodeInfo
▸ asRelatedNodeInfo(): RelatedNodeInfo
Returns
Inherited from
Defined in
Node.ts:124
generateHash
▸ generateHash(): void
Returns
void
Inherited from
Defined in
Node.ts:149
getContent
▸ getContent(metadataMode?
): string
Parameters
Name | Type | Default value |
---|---|---|
metadataMode | MetadataMode | MetadataMode.NONE |
Returns
string
Inherited from
Defined in
Node.ts:157
getEmbedding
▸ getEmbedding(): number
[]
Returns
number
[]
Inherited from
Defined in
Node.ts:116
getMetadataStr
▸ getMetadataStr(metadataMode
): string
Parameters
Name | Type |
---|---|
metadataMode | MetadataMode |
Returns
string
Inherited from
Defined in
Node.ts:162
getNodeInfo
▸ getNodeInfo(): Object
Returns
Object
Name | Type |
---|---|
end | undefined | number |
start | undefined | number |
Inherited from
Defined in
Node.ts:187
getText
▸ getText(): string
Returns
string
Inherited from
Defined in
Node.ts:191
getType
▸ getType(): ObjectType
Returns
Overrides
Defined in
Node.ts:221
setContent
▸ setContent(value
): void
Parameters
Name | Type |
---|---|
value | string |
Returns
void
Inherited from
Defined in
Node.ts:183