ImageDocument

Defined in: .build/typescript/packages/core/src/schema/node.ts:415

TextNode is the default node type for text. Most common node type in LlamaIndex.TS

Extends

• ImageNode<T>

Type Parameters

T

T extends Metadata = Metadata

Constructors

Constructor

new ImageDocument<T>(init): ImageDocument<T>

Defined in: .build/typescript/packages/core/src/schema/node.ts:416

Parameters

init

ImageNodeParams<T>

Returns

ImageDocument<T>

Overrides

ImageNode.constructor

Properties

id_

id_: string

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

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

ImageNode.id_

---

embedding

embedding: undefined | number[]

Defined in: .build/typescript/packages/core/src/schema/node.ts:65

Inherited from

ImageNode.embedding

---

metadata

metadata: T

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

Inherited from

ImageNode.metadata

---

excludedEmbedMetadataKeys

excludedEmbedMetadataKeys: string[]

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

Inherited from

ImageNode.excludedEmbedMetadataKeys

---

excludedLlmMetadataKeys

excludedLlmMetadataKeys: string[]

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

Inherited from

ImageNode.excludedLlmMetadataKeys

---

relationships

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

Defined in: .build/typescript/packages/core/src/schema/node.ts:71

Inherited from

ImageNode.relationships

---

text

text: string

Defined in: .build/typescript/packages/core/src/schema/node.ts:218

Inherited from

ImageNode.text

---

textTemplate

textTemplate: string

Defined in: .build/typescript/packages/core/src/schema/node.ts:219

Inherited from

ImageNode.textTemplate

---

startCharIdx?

optional startCharIdx: number

Defined in: .build/typescript/packages/core/src/schema/node.ts:221

Inherited from

ImageNode.startCharIdx

---

endCharIdx?

optional endCharIdx: number

Defined in: .build/typescript/packages/core/src/schema/node.ts:222

Inherited from

ImageNode.endCharIdx

---

metadataSeparator

metadataSeparator: string

Defined in: .build/typescript/packages/core/src/schema/node.ts:225

Inherited from

ImageNode.metadataSeparator

---

image

image: ImageType

Defined in: .build/typescript/packages/core/src/schema/node.ts:365

Inherited from

ImageNode.image

Accessors

hash

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

Inherited from

ImageNode.hash

---

sourceNode

Get Signature

get sourceNode(): undefined | RelatedNodeInfo<T>

Defined in: .build/typescript/packages/core/src/schema/node.ts:103

Returns

undefined | RelatedNodeInfo<T>

Inherited from

ImageNode.sourceNode

---

prevNode

Get Signature

get prevNode(): undefined | RelatedNodeInfo<T>

Defined in: .build/typescript/packages/core/src/schema/node.ts:113

Returns

undefined | RelatedNodeInfo<T>

Inherited from

ImageNode.prevNode

---

nextNode

Get Signature

get nextNode(): undefined | RelatedNodeInfo<T>

Defined in: .build/typescript/packages/core/src/schema/node.ts:125

Returns

undefined | RelatedNodeInfo<T>

Inherited from

ImageNode.nextNode

---

parentNode

Get Signature

get parentNode(): undefined | RelatedNodeInfo<T>

Defined in: .build/typescript/packages/core/src/schema/node.ts:135

Returns

undefined | RelatedNodeInfo<T>

Inherited from

ImageNode.parentNode

---

childNodes

Get Signature

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

Defined in: .build/typescript/packages/core/src/schema/node.ts:145

Returns

undefined | RelatedNodeInfo<T>[]

Inherited from

ImageNode.childNodes

---

type

Get Signature

get type(): ObjectType

Defined in: .build/typescript/packages/core/src/schema/node.ts:420

Returns

ObjectType

Overrides

ImageNode.type

Methods

getEmbedding()

getEmbedding(): number[]

Defined in: .build/typescript/packages/core/src/schema/node.ts:159

Returns

number[]

Inherited from

ImageNode.getEmbedding

---

asRelatedNodeInfo()

asRelatedNodeInfo(): RelatedNodeInfo<T>

Defined in: .build/typescript/packages/core/src/schema/node.ts:167

Returns

RelatedNodeInfo<T>

Inherited from

ImageNode.asRelatedNodeInfo

---

toJSON()

toJSON(): Record<string, any>

Defined in: .build/typescript/packages/core/src/schema/node.ts:181

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

ImageNode.toJSON

---

clone()

clone(): BaseNode

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

Returns

BaseNode

Inherited from

ImageNode.clone

---

toMutableJSON()

toMutableJSON(): Record<string, any>

Defined in: .build/typescript/packages/core/src/schema/node.ts:200

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

ImageNode.toMutableJSON

---

getContent()

getContent(metadataMode): string

Defined in: .build/typescript/packages/core/src/schema/node.ts:262

Parameters

metadataMode

MetadataMode = MetadataMode.NONE

Returns

string

Inherited from

ImageNode.getContent

---

getMetadataStr()

getMetadataStr(metadataMode): string

Defined in: .build/typescript/packages/core/src/schema/node.ts:267

Parameters

metadataMode

MetadataMode

Returns

string

Inherited from

ImageNode.getMetadataStr

---

setContent()

setContent(value): void

Defined in: .build/typescript/packages/core/src/schema/node.ts:288

Parameters

value

string

Returns

void

Inherited from

ImageNode.setContent

---

getNodeInfo()

getNodeInfo(): object

Defined in: .build/typescript/packages/core/src/schema/node.ts:293

Returns

object

start

start: undefined | number

end

end: undefined | number

Inherited from

ImageNode.getNodeInfo

---

getText()

getText(): string

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

Returns

string

Inherited from

ImageNode.getText

---

getUrl()

getUrl(): URL

Defined in: .build/typescript/packages/core/src/schema/node.ts:377

Returns

URL

Inherited from

ImageNode.getUrl

---

generateHash()

generateHash(): string

Defined in: .build/typescript/packages/core/src/schema/node.ts:405

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

ImageNode.generateHash