Class: ImageDocument<T>

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

Type parameters

Name	Type
T	extends Metadata = Metadata

Hierarchy

• ImageNode<T>

  ↳ ImageDocument

Constructors

constructor

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

Type parameters

Name	Type
T	extends Metadata = Metadata

Parameters

Name	Type
init	ImageNodeConstructorProps<T>

Returns

ImageDocument<T>

Overrides

ImageNode.constructor

Defined in

packages/core/src/Node.ts:363

Properties

embedding

• Optional embedding: number[]

Inherited from

ImageNode.embedding

Defined in

packages/core/src/Node.ts:51

---

endCharIdx

• Optional endCharIdx: number

Inherited from

ImageNode.endCharIdx

Defined in

packages/core/src/Node.ts:174

---

excludedEmbedMetadataKeys

• excludedEmbedMetadataKeys: string[] = []

Inherited from

ImageNode.excludedEmbedMetadataKeys

Defined in

packages/core/src/Node.ts:55

---

excludedLlmMetadataKeys

• excludedLlmMetadataKeys: string[] = []

Inherited from

ImageNode.excludedLlmMetadataKeys

Defined in

packages/core/src/Node.ts:56

---

hash

• hash: string = ""

Inherited from

ImageNode.hash

Defined in

packages/core/src/Node.ts:58

---

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

ImageNode.id_

Defined in

packages/core/src/Node.ts:50

---

image

• image: ImageType

Inherited from

ImageNode.image

Defined in

packages/core/src/Node.ts:313

---

metadata

• metadata: T

Inherited from

ImageNode.metadata

Defined in

packages/core/src/Node.ts:54

---

metadataSeparator

• metadataSeparator: string = "\n"

Inherited from

ImageNode.metadataSeparator

Defined in

packages/core/src/Node.ts:177

---

relationships

• relationships: Partial<Record<NodeRelationship, RelatedNodeType<T>>> = {}

Inherited from

ImageNode.relationships

Defined in

packages/core/src/Node.ts:57

---

startCharIdx

• Optional startCharIdx: number

Inherited from

ImageNode.startCharIdx

Defined in

packages/core/src/Node.ts:173

---

text

• text: string = ""

Inherited from

ImageNode.text

Defined in

packages/core/src/Node.ts:170

---

textTemplate

• textTemplate: string = ""

Inherited from

ImageNode.textTemplate

Defined in

packages/core/src/Node.ts:171

Accessors

childNodes

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

Returns

undefined | RelatedNodeInfo<T>[]

Inherited from

ImageNode.childNodes

Defined in

packages/core/src/Node.ts:113

---

nextNode

• get nextNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

ImageNode.nextNode

Defined in

packages/core/src/Node.ts:93

---

parentNode

• get parentNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

ImageNode.parentNode

Defined in

packages/core/src/Node.ts:103

---

prevNode

• get prevNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

ImageNode.prevNode

Defined in

packages/core/src/Node.ts:81

---

sourceNode

• get sourceNode(): undefined | RelatedNodeInfo<T>

Returns

undefined | RelatedNodeInfo<T>

Inherited from

ImageNode.sourceNode

Defined in

packages/core/src/Node.ts:71

Methods

asRelatedNodeInfo

▸ asRelatedNodeInfo(): RelatedNodeInfo<T>

Returns

RelatedNodeInfo<T>

Inherited from

ImageNode.asRelatedNodeInfo

Defined in

packages/core/src/Node.ts:135

---

clone

▸ clone(): BaseNode<Metadata>

Returns

BaseNode<Metadata>

Inherited from

ImageNode.clone

Defined in

packages/core/src/Node.ts:152

---

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

ImageNode.generateHash

Defined in

packages/core/src/Node.ts:352

---

getContent

▸ getContent(metadataMode?): string

Parameters

Name	Type	Default value
metadataMode	MetadataMode	MetadataMode.NONE

Returns

string

Inherited from

ImageNode.getContent

Defined in

packages/core/src/Node.ts:209

---

getEmbedding

▸ getEmbedding(): number[]

Returns

number[]

Inherited from

ImageNode.getEmbedding

Defined in

packages/core/src/Node.ts:127

---

getMetadataStr

▸ getMetadataStr(metadataMode): string

Parameters

Name	Type
metadataMode	MetadataMode

Returns

string

Inherited from

ImageNode.getMetadataStr

Defined in

packages/core/src/Node.ts:214

---

getNodeInfo

▸ getNodeInfo(): Object

Returns

Object

Name	Type
end	undefined | number
start	undefined | number

Inherited from

ImageNode.getNodeInfo

Defined in

packages/core/src/Node.ts:240

---

getText

▸ getText(): string

Returns

string

Inherited from

ImageNode.getText

Defined in

packages/core/src/Node.ts:244

---

getType

▸ getType(): ObjectType

Returns

ObjectType

Overrides

ImageNode.getType

Defined in

packages/core/src/Node.ts:371

---

getUrl

▸ getUrl(): URL

Returns

URL

Inherited from

ImageNode.getUrl

Defined in

packages/core/src/Node.ts:324

---

setContent

▸ setContent(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

ImageNode.setContent

Defined in

packages/core/src/Node.ts:235

---

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

ImageNode.toJSON

Defined in

packages/core/src/Node.ts:148

---

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

ImageNode.toMutableJSON

Defined in

packages/core/src/Node.ts:161