Skip to main content

Class: ObjectIndex

Constructors

constructor

new ObjectIndex(index, objectNodeMapping): ObjectIndex

Parameters

NameType
indexany
objectNodeMappingBaseObjectNodeMapping

Returns

ObjectIndex

Defined in

packages/core/src/objects/base.ts:150

Properties

_index

Private _index: VectorStoreIndex

Defined in

packages/core/src/objects/base.ts:147


_objectNodeMapping

Private _objectNodeMapping: BaseObjectNodeMapping

Defined in

packages/core/src/objects/base.ts:148

Accessors

tools

get tools(): Record<string, BaseTool>

Returns

Record<string, BaseTool>

Defined in

packages/core/src/objects/base.ts:179

Methods

asNodeRetriever

asNodeRetriever(kwargs): any

Parameters

NameType
kwargsany

Returns

any

Defined in

packages/core/src/objects/base.ts:190


asRetriever

asRetriever(kwargs): Promise<ObjectRetriever>

Parameters

NameType
kwargsany

Returns

Promise<ObjectRetriever>

Defined in

packages/core/src/objects/base.ts:183


insertObject

insertObject(obj): Promise<void>

Parameters

NameType
objany

Returns

Promise<void>

Defined in

packages/core/src/objects/base.ts:173


fromObjects

fromObjects(objects, objectMapping, indexCls, indexKwargs?): Promise<ObjectIndex>

Parameters

NameType
objectsany
objectMappingBaseObjectNodeMapping
indexClsany
indexKwargs?Record<string, any>

Returns

Promise<ObjectIndex>

Defined in

packages/core/src/objects/base.ts:155