VectordbApi API

The vectordbApi module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
addChunks
addDocuments
createCollection
createIndex
deleteChunk
deleteCollection
deleteDocuments
getChunks
getCollection
getDocuments
getSettings
listCollections
query
updateCollection
updateSettings

Methods

---

addChunks

plugin.vectordbApi.addChunks(id: string, data: AddVectorChunksRequest): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	AddVectorChunksRequest	Yes

Returns: Promise<unknown>

Full reference →

---

addDocuments

plugin.vectordbApi.addDocuments(id: string, data: AddVectorDocumentsRequest): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	AddVectorDocumentsRequest	Yes

Returns: Promise<unknown>

Full reference →

---

createCollection

plugin.vectordbApi.createCollection(data: CreateVectorCollectionRequest): Promise<VectorCollection>

Parameter	Type	Required	Description
data	CreateVectorCollectionRequest	Yes

Returns: Promise<VectorCollection>

Full reference →

---

createIndex

plugin.vectordbApi.createIndex(data: CreateVectorIndexRequest): Promise<unknown>

Parameter	Type	Required	Description
data	CreateVectorIndexRequest	Yes

Returns: Promise<unknown>

Full reference →

---

deleteChunk

plugin.vectordbApi.deleteChunk(id: string, chunkId: string): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
chunkId	string	Yes

Returns: Promise<unknown>

Full reference →

---

deleteCollection

plugin.vectordbApi.deleteCollection(id: string): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

deleteDocuments

plugin.vectordbApi.deleteDocuments(id: string, data?: DeleteVectorDocumentsRequest): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	DeleteVectorDocumentsRequest	No

Returns: Promise<unknown>

Full reference →

---

getChunks

plugin.vectordbApi.getChunks(id: string, params?: Record<string, unknown>): Promise<VectorChunk[]>

Parameter	Type	Required	Description
id	string	Yes
params	Record<string, unknown>	No

Returns: Promise<VectorChunk[]>

Full reference →

---

getCollection

plugin.vectordbApi.getCollection(id: string): Promise<VectorCollection>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<VectorCollection>

Full reference →

---

getDocuments

plugin.vectordbApi.getDocuments(id: string, params?: Record<string, unknown>): Promise<VectorDocument[]>

Parameter	Type	Required	Description
id	string	Yes
params	Record<string, unknown>	No

Returns: Promise<VectorDocument[]>

Full reference →

---

getSettings

plugin.vectordbApi.getSettings(id: string): Promise<VectorCollectionSettings>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<VectorCollectionSettings>

Full reference →

---

listCollections

plugin.vectordbApi.listCollections(params?: Record<string, unknown>): Promise<VectorCollection[]>

Parameter	Type	Required	Description
params	Record<string, unknown>	No

Returns: Promise<VectorCollection[]>

Full reference →

---

query

plugin.vectordbApi.query(id: string, data: VectorQueryRequest): Promise<VectorSearchResult[]>

Parameter	Type	Required	Description
id	string	Yes
data	VectorQueryRequest	Yes

Returns: Promise<VectorSearchResult[]>

Full reference →

---

updateCollection

plugin.vectordbApi.updateCollection(id: string, data: UpdateVectorCollectionRequest): Promise<VectorCollection>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateVectorCollectionRequest	Yes

Returns: Promise<VectorCollection>

Full reference →

---

updateSettings

plugin.vectordbApi.updateSettings(id: string, data: UpdateVectorSettingsRequest): Promise<VectorCollectionSettings>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateVectorSettingsRequest	Yes

Returns: Promise<VectorCollectionSettings>

Full reference →