跳转到内容

ImageDocument

定义于：.build/typescript/packages/core/src/schema/node.ts:415

TextNode 是文本的默认节点类型。LlamaIndex.TS 中最常见的节点类型。

扩展

ImageNode<T>

类型参数

T

T extends Metadata = Metadata

构造函数

构造函数

新建图像文档<T>(init): ImageDocument<T>

定义于：.build/typescript/packages/core/src/schema/node.ts:416

参数

初始化

ImageNodeParams<T>

返回

ImageDocument<T>

覆盖设置

ImageNode.constructor

属性

id_

id_: string

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

节点/文档的唯一标识符。末尾的下划线是为了避免与 Python 中的 id 关键字产生冲突。

默认设置为UUID。

继承自

ImageNode.id_

嵌入

embedding: undefined | number[]

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

继承自

ImageNode.embedding

元数据

metadata: T

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

继承自

ImageNode.metadata

excludedEmbedMetadataKeys

excludedEmbedMetadataKeys: string[]

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

继承自

ImageNode.excludedEmbedMetadataKeys

excludedLlmMetadataKeys

excludedLlmMetadataKeys: string[]

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

继承自

ImageNode.excludedLlmMetadataKeys

关系

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

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

继承自

ImageNode.relationships

文本

text: string

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

继承自

ImageNode.text

textTemplate

textTemplate: string

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

继承自

ImageNode.textTemplate

起始字符索引？

optional startCharIdx: number

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

继承自

ImageNode.startCharIdx

结束字符索引？

optional endCharIdx: number

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

继承自

ImageNode.endCharIdx

metadataSeparator

metadataSeparator: string

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

继承自

ImageNode.metadataSeparator

图像

image: ImageType

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

继承自

ImageNode.image

访问器

哈希

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

继承自

ImageNode.hash

sourceNode

获取签名

get sourceNode(): undefined | RelatedNodeInfo<T>

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

返回

undefined | RelatedNodeInfo<T>

继承自

ImageNode.sourceNode

prevNode

获取签名

get prevNode(): undefined | RelatedNodeInfo<T>

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

返回

undefined | RelatedNodeInfo<T>

继承自

ImageNode.prevNode

nextNode

获取签名

get nextNode(): undefined | RelatedNodeInfo<T>

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

返回

undefined | RelatedNodeInfo<T>

继承自

ImageNode.nextNode

parentNode

获取签名

get parentNode(): undefined | RelatedNodeInfo<T>

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

返回

undefined | RelatedNodeInfo<T>

继承自

ImageNode.parentNode

childNodes

获取签名

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

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

返回

undefined | RelatedNodeInfo<T>[]

继承自

ImageNode.childNodes

类型

获取签名

get type(): ObjectType

定义于：.build/typescript/packages/core/src/schema/node.ts:420

返回

覆盖设置

ImageNode.type

方法

getEmbedding()

getEmbedding(): number[]

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

返回

number[]

继承自

ImageNode.getEmbedding

asRelatedNodeInfo()

asRelatedNodeInfo(): RelatedNodeInfo<T>

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

返回

RelatedNodeInfo<T>

继承自

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).

返回

Record<string, any>

参见

toMutableJSON - 用于返回可变JSON替代

继承自

ImageNode.toJSON

clone()

clone(): BaseNode

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

返回

继承自

ImageNode.clone

toMutableJSON()

toMutableJSON(): Record<string, any>

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

将对象转换为JSON表示形式。可以安全地修改属性，因为会创建属性的深度克隆。

返回

Record<string, any>

对象的JSON表示形式。

继承自

ImageNode.toMutableJSON

getContent()

getContent(metadataMode): string

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

参数

metadataMode

MetadataMode = MetadataMode.NONE

返回

string

继承自

ImageNode.getContent

getMetadataStr()

getMetadataStr(metadataMode): string

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

参数

metadataMode

返回

string

继承自

ImageNode.getMetadataStr

setContent()

setContent(value): void

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

参数

值

string

返回

void

继承自

ImageNode.setContent

getNodeInfo()

getNodeInfo(): object

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

返回

object

开始

start: undefined | number

结束

end: undefined | number

继承自

ImageNode.getNodeInfo

getText()

getText(): string

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

返回

string

继承自

ImageNode.getText

getUrl()

getUrl(): URL

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

返回

URL

继承自

ImageNode.getUrl

generateHash()

generateHash(): string

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

生成文本节点的哈希值。 ID不包含在哈希值中，因为它可能独立于内容发生变化。

返回

string

继承自

ImageNode.generateHash