WeaviateVectorStore
Defined in: packages/providers/storage/weaviate/src/WeaviateVectorStore.ts:116
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WeaviateVectorStore(
init?):WeaviateVectorStore
Defined in: packages/providers/storage/weaviate/src/WeaviateVectorStore.ts:131
Parameters
Section titled “Parameters”weaviateClient?
Section titled “weaviateClient?”WeaviateClient
cloudOptions?
Section titled “cloudOptions?”{ clusterURL?: string; apiKey?: string; }
cloudOptions.clusterURL?
Section titled “cloudOptions.clusterURL?”string
cloudOptions.apiKey?
Section titled “cloudOptions.apiKey?”string
indexName?
Section titled “indexName?”string
idKey?
Section titled “idKey?”string
contentKey?
Section titled “contentKey?”string
metadataKey?
Section titled “metadataKey?”string
embeddingKey?
Section titled “embeddingKey?”string
sanitizeMetadata?
Section titled “sanitizeMetadata?”boolean
Returns
Section titled “Returns”WeaviateVectorStore
Overrides
Section titled “Overrides”Properties
Section titled “Properties”isEmbeddingQuery?
Section titled “isEmbeddingQuery?”
optionalisEmbeddingQuery:boolean
Defined in: packages/core/src/vector-store/index.ts:120
Inherited from
Section titled “Inherited from”BaseVectorStore.isEmbeddingQuery
storesText
Section titled “storesText”storesText:
boolean=true
Defined in: packages/providers/storage/weaviate/src/WeaviateVectorStore.ts:117
Overrides
Section titled “Overrides”Methods
Section titled “Methods”client()
Section titled “client()”client():
Promise<WeaviateClient>
Defined in: packages/providers/storage/weaviate/src/WeaviateVectorStore.ts:172
Returns
Section titled “Returns”Promise<WeaviateClient>
Overrides
Section titled “Overrides”add(
nodes):Promise<string[]>
Defined in: packages/providers/storage/weaviate/src/WeaviateVectorStore.ts:176
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<string[]>
Overrides
Section titled “Overrides”delete()
Section titled “delete()”delete(
refDocId,deleteOptions?):Promise<void>
Defined in: packages/providers/storage/weaviate/src/WeaviateVectorStore.ts:216
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
deleteOptions?
Section titled “deleteOptions?”DeleteManyOptions<boolean>
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”query()
Section titled “query()”query(
query):Promise<VectorStoreQueryResult>
Defined in: packages/providers/storage/weaviate/src/WeaviateVectorStore.ts:227
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<VectorStoreQueryResult>
Overrides
Section titled “Overrides”exists()
Section titled “exists()”exists(
refDocId):Promise<boolean>
Defined in: packages/providers/storage/weaviate/src/WeaviateVectorStore.ts:370
Check if any nodes exist for the given document reference ID. Used for de-duplication during ingestion.
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
The reference document ID to check
Returns
Section titled “Returns”Promise<boolean>
true if any nodes with this ref_doc_id exist