Class VectorStore

Index

Constructors

Methods

addVector addVectors batchRetrieve clear count getById getByIds removeVector removeVectors retrieve newChroma newFaiss

Constructors

constructor

new VectorStore(): VectorStore
Returns VectorStore

Methods

addVector

addVector(input: VectorStoreAddInput): Promise<string>
Parameters
- input: VectorStoreAddInput
Returns Promise<string>
- Defined in ailoy_core.d.ts:137

addVectors

addVectors(inputs: VectorStoreAddInput[]): Promise<string[]>
Parameters
- inputs: VectorStoreAddInput[]
Returns Promise<string[]>
- Defined in ailoy_core.d.ts:138

batchRetrieve

batchRetrieve(
queryEmbeddings: Embedding[],
topK: number,
): Promise<VectorStoreRetrieveResult[][]>
Parameters
- queryEmbeddings: Embedding[]
- topK: number
Returns Promise<VectorStoreRetrieveResult[][]>
- Defined in ailoy_core.d.ts:145

clear

clear(): Promise<void>
Returns Promise<void>
- Defined in ailoy_core.d.ts:151

count

count(): Promise<number>
Returns Promise<number>
- Defined in ailoy_core.d.ts:152

getById

getById(id: string): Promise<VectorStoreGetResult | null>
Parameters
- id: string
Returns Promise<VectorStoreGetResult | null>
- Defined in ailoy_core.d.ts:139

getByIds

getByIds(ids: string[]): Promise<VectorStoreGetResult[]>
Parameters
- ids: string[]
Returns Promise<VectorStoreGetResult[]>
- Defined in ailoy_core.d.ts:140

removeVector

removeVector(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in ailoy_core.d.ts:149

removeVectors

removeVectors(ids: string[]): Promise<void>
Parameters
- ids: string[]
Returns Promise<void>
- Defined in ailoy_core.d.ts:150

retrieve

retrieve(
queryEmbedding: Embedding,
topK: number,
): Promise<VectorStoreRetrieveResult[]>
Parameters
- queryEmbedding: Embedding
- topK: number
Returns Promise<VectorStoreRetrieveResult[]>
- Defined in ailoy_core.d.ts:141

`Static`newChroma

newChroma(url: string, collectionName?: string | null): Promise<VectorStore>
Parameters
- url: string
- OptionalcollectionName: string | null
Returns Promise<VectorStore>
- Defined in ailoy_core.d.ts:133

`Static`newFaiss

newFaiss(dim: number): Promise<VectorStore>
Parameters
- dim: number
Returns Promise<VectorStore>
- Defined in ailoy_core.d.ts:132