Skip to content
2 min read · 462 words

Class: WeaviateVectorStore

Defined in: batteries/vector/weaviate/index.ts:114

Weaviate-backed @nhtio/adk/batteries/vector/contract!VectorStore. Node-only.

Remarks

Stores ids/documents/metadata as explicit object properties and all metadata filtering is evaluated in JavaScript for portable behavior across Weaviate schema/index settings.

Extends

Constructors

Constructor

ts
new WeaviateVectorStore(options: BaseVectorStoreOptions): WeaviateVectorStore;

Defined in: batteries/vector/contract.ts:35

Parameters

ParameterType
optionsBaseVectorStoreOptions

Returns

WeaviateVectorStore

Inherited from

BaseVectorStore.constructor

Properties

PropertyModifierTypeOverridesDefined in
capabilitiesreadonlyVectorStoreCapabilitiesBaseVectorStore.capabilitiesbatteries/vector/weaviate/index.ts:115

Accessors

schema

Get Signature

ts
get schema(): VectorSchemaBuilder;

Defined in: batteries/vector/contract.ts:64

Returns

VectorSchemaBuilder

Inherited from

BaseVectorStore.schema

Methods

asCallable()

ts
asCallable(): CallableVectorStore;

Defined in: batteries/vector/contract.ts:73

Returns

CallableVectorStore

Inherited from

BaseVectorStore.asCallable


close()

ts
close(): Promise<void>;

Defined in: batteries/vector/weaviate/index.ts:173

Returns

Promise<void>

Overrides

BaseVectorStore.close


connect()

ts
connect(): Promise<void>;

Defined in: batteries/vector/weaviate/index.ts:138

Returns

Promise<void>

Overrides

BaseVectorStore.connect


createCollection()

ts
createCollection(spec: CollectionSpec, ifNotExists: boolean): Promise<void>;

Defined in: batteries/vector/weaviate/index.ts:179

Parameters

ParameterType
specCollectionSpec
ifNotExistsboolean

Returns

Promise<void>

Overrides

BaseVectorStore.createCollection


dropCollection()

ts
dropCollection(collection: string, ifExists: boolean): Promise<void>;

Defined in: batteries/vector/weaviate/index.ts:204

Parameters

ParameterType
collectionstring
ifExistsboolean

Returns

Promise<void>

Overrides

BaseVectorStore.dropCollection


executeDelete()

ts
executeDelete(plan: DeletePlan): Promise<void>;

Defined in: batteries/vector/weaviate/index.ts:314

Parameters

ParameterType
planDeletePlan

Returns

Promise<void>

Overrides

BaseVectorStore.executeDelete


executeSearch()

ts
executeSearch(plan: SearchPlan): Promise<VectorMatch[]>;

Defined in: batteries/vector/weaviate/index.ts:268

Parameters

ParameterType
planSearchPlan

Returns

Promise<VectorMatch[]>

Overrides

BaseVectorStore.executeSearch


executeUpsert()

ts
executeUpsert(plan: UpsertPlan): Promise<void>;

Defined in: batteries/vector/weaviate/index.ts:232

Parameters

ParameterType
planUpsertPlan

Returns

Promise<void>

Overrides

BaseVectorStore.executeUpsert


hasCollection()

ts
hasCollection(collection: string): Promise<boolean>;

Defined in: batteries/vector/weaviate/index.ts:223

Parameters

ParameterType
collectionstring

Returns

Promise<boolean>

Overrides

BaseVectorStore.hasCollection


isAvailable()

ts
isAvailable(): boolean;

Defined in: batteries/vector/weaviate/index.ts:134

Returns

boolean

Overrides

BaseVectorStore.isAvailable


query()

ts
query(collection: string): VectorQueryBuilder;

Defined in: batteries/vector/contract.ts:68

Parameters

ParameterType
collectionstring

Returns

VectorQueryBuilder

Inherited from

BaseVectorStore.query


renameCollection()

ts
renameCollection(_from: string, _to: string): Promise<void>;

Defined in: batteries/vector/weaviate/index.ts:228

Parameters

ParameterType
_fromstring
_tostring

Returns

Promise<void>

Overrides

BaseVectorStore.renameCollection


transaction()

ts
transaction(_fn: (tx: CallableVectorStore) => Promise<void>): Promise<void>;

Defined in: batteries/vector/contract.ts:60

Parameters

ParameterType
_fn(tx: CallableVectorStore) => Promise<void>

Returns

Promise<void>

Inherited from

BaseVectorStore.transaction


isAvailable()

ts
static isAvailable(): boolean;

Defined in: batteries/vector/weaviate/index.ts:130

Returns

boolean