ImageDocument
Defined in: packages/core/src/schema/node.ts:424
TextNode is the default node type for text. Most common node type in vectorstores
Extends
Section titled “Extends”ImageNode<T>
Type Parameters
Section titled “Type Parameters”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ImageDocument<
T>(init):ImageDocument<T>
Defined in: packages/core/src/schema/node.ts:425
Parameters
Section titled “Parameters”Returns
Section titled “Returns”ImageDocument<T>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”id_:
string
Defined in: packages/core/src/schema/node.ts:63
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
Section titled “Inherited from”embedding
Section titled “embedding”embedding:
number[] |undefined
Defined in: packages/core/src/schema/node.ts:64
Inherited from
Section titled “Inherited from”metadata
Section titled “metadata”metadata:
T
Defined in: packages/core/src/schema/node.ts:67
Inherited from
Section titled “Inherited from”excludedEmbedMetadataKeys
Section titled “excludedEmbedMetadataKeys”excludedEmbedMetadataKeys:
string[]
Defined in: packages/core/src/schema/node.ts:68
Inherited from
Section titled “Inherited from”ImageNode.excludedEmbedMetadataKeys
excludedLlmMetadataKeys
Section titled “excludedLlmMetadataKeys”excludedLlmMetadataKeys:
string[]
Defined in: packages/core/src/schema/node.ts:69
Inherited from
Section titled “Inherited from”ImageNode.excludedLlmMetadataKeys
relationships
Section titled “relationships”relationships:
Partial<Record<NodeRelationship,RelatedNodeType<T>>>
Defined in: packages/core/src/schema/node.ts:70
Inherited from
Section titled “Inherited from”text:
string
Defined in: packages/core/src/schema/node.ts:227
Inherited from
Section titled “Inherited from”textTemplate
Section titled “textTemplate”textTemplate:
string
Defined in: packages/core/src/schema/node.ts:228
Inherited from
Section titled “Inherited from”startCharIdx?
Section titled “startCharIdx?”
optionalstartCharIdx:number
Defined in: packages/core/src/schema/node.ts:230
Inherited from
Section titled “Inherited from”endCharIdx?
Section titled “endCharIdx?”
optionalendCharIdx:number
Defined in: packages/core/src/schema/node.ts:231
Inherited from
Section titled “Inherited from”metadataSeparator
Section titled “metadataSeparator”metadataSeparator:
string
Defined in: packages/core/src/schema/node.ts:234
Inherited from
Section titled “Inherited from”image:
ImageType
Defined in: packages/core/src/schema/node.ts:374
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get hash():
string
Defined in: packages/core/src/schema/node.ts:74
Returns
Section titled “Returns”string
Set Signature
Section titled “Set Signature”set hash(
newValue):void
Defined in: packages/core/src/schema/node.ts:81
Parameters
Section titled “Parameters”newValue
Section titled “newValue”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”sourceNode
Section titled “sourceNode”Get Signature
Section titled “Get Signature”get sourceNode():
RelatedNodeInfo<T> |undefined
Defined in: packages/core/src/schema/node.ts:112
Returns
Section titled “Returns”RelatedNodeInfo<T> | undefined
Inherited from
Section titled “Inherited from”prevNode
Section titled “prevNode”Get Signature
Section titled “Get Signature”get prevNode():
RelatedNodeInfo<T> |undefined
Defined in: packages/core/src/schema/node.ts:122
Returns
Section titled “Returns”RelatedNodeInfo<T> | undefined
Inherited from
Section titled “Inherited from”nextNode
Section titled “nextNode”Get Signature
Section titled “Get Signature”get nextNode():
RelatedNodeInfo<T> |undefined
Defined in: packages/core/src/schema/node.ts:134
Returns
Section titled “Returns”RelatedNodeInfo<T> | undefined
Inherited from
Section titled “Inherited from”parentNode
Section titled “parentNode”Get Signature
Section titled “Get Signature”get parentNode():
RelatedNodeInfo<T> |undefined
Defined in: packages/core/src/schema/node.ts:144
Returns
Section titled “Returns”RelatedNodeInfo<T> | undefined
Inherited from
Section titled “Inherited from”childNodes
Section titled “childNodes”Get Signature
Section titled “Get Signature”get childNodes():
RelatedNodeInfo<T>[] |undefined
Defined in: packages/core/src/schema/node.ts:154
Returns
Section titled “Returns”RelatedNodeInfo<T>[] | undefined
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get type():
ObjectType
Defined in: packages/core/src/schema/node.ts:429
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Methods
Section titled “Methods”getEmbedding()
Section titled “getEmbedding()”getEmbedding():
number[]
Defined in: packages/core/src/schema/node.ts:168
Returns
Section titled “Returns”number[]
Inherited from
Section titled “Inherited from”asRelatedNodeInfo()
Section titled “asRelatedNodeInfo()”asRelatedNodeInfo():
RelatedNodeInfo<T>
Defined in: packages/core/src/schema/node.ts:176
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”toJSON()
Section titled “toJSON()”toJSON():
Record<string,any>
Defined in: packages/core/src/schema/node.ts:190
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
Section titled “Returns”Record<string, any>
toMutableJSON - use to return a mutable JSON instead
Inherited from
Section titled “Inherited from”clone()
Section titled “clone()”clone():
BaseNode
Defined in: packages/core/src/schema/node.ts:199
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”toMutableJSON()
Section titled “toMutableJSON()”toMutableJSON():
Record<string,any>
Defined in: packages/core/src/schema/node.ts:209
Converts the object to a JSON representation. Properties can be safely modified as a deep clone of the properties are created.
Returns
Section titled “Returns”Record<string, any>
- The JSON representation of the object.
Inherited from
Section titled “Inherited from”getContent()
Section titled “getContent()”getContent(
metadataMode):string
Defined in: packages/core/src/schema/node.ts:271
Parameters
Section titled “Parameters”metadataMode
Section titled “metadataMode”MetadataMode = MetadataMode.NONE
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”getMetadataStr()
Section titled “getMetadataStr()”getMetadataStr(
metadataMode):string
Defined in: packages/core/src/schema/node.ts:276
Parameters
Section titled “Parameters”metadataMode
Section titled “metadataMode”Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”setContent()
Section titled “setContent()”setContent(
value):void
Defined in: packages/core/src/schema/node.ts:297
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getNodeInfo()
Section titled “getNodeInfo()”getNodeInfo():
object
Defined in: packages/core/src/schema/node.ts:302
Returns
Section titled “Returns”object
start:
number|undefined
end:
number|undefined
Inherited from
Section titled “Inherited from”getText()
Section titled “getText()”getText():
string
Defined in: packages/core/src/schema/node.ts:306
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”getUrl()
Section titled “getUrl()”getUrl():
URL
Defined in: packages/core/src/schema/node.ts:386
Returns
Section titled “Returns”URL
Inherited from
Section titled “Inherited from”generateHash()
Section titled “generateHash()”generateHash():
string
Defined in: packages/core/src/schema/node.ts:414
Generate a hash of the text node. The ID is not part of the hash as it can change independent of content.
Returns
Section titled “Returns”string