Class VectorDBBase`Abstract`

Hierarchy

VectorDBBase

Index

Constructors

Properties

Accessors

Methods

createIndex createRecord createRecords deleteIndex deleteRecord deleteRecords editIndex getIndex getRecord getRecords listIndexes queryIndex updateRecord updateRecords

Constructors

constructor

new VectorDBBase(apiKey): VectorDBBase
Parameters
- apiKey: string
Returns VectorDBBase
- Defined in generic/VectorDBBase.ts:15

Properties

`Private` _apiKey

_apiKey: string

Accessors

`Protected` apiKey

get apiKey(): string
Only sub-classes can access the API key

Returns string
- Defined in generic/VectorDBBase.ts:11

Methods

`Abstract` createIndex

createIndex(params): BaseResponse | Promise<BaseResponse>
Parameters
- params: CreateIndexParams
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:25

`Abstract` createRecord

createRecord(record): BaseResponse | Promise<BaseResponse>
Parameters
- record: VectorRecord
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:30

`Abstract` createRecords

createRecords(record): BaseResponse | Promise<BaseResponse>
Parameters
- record: VectorRecord[]
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:31

`Abstract` deleteIndex

deleteIndex(params): BaseResponse | Promise<BaseResponse>
Parameters
- params: BaseRequestParams
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:26

`Abstract` deleteRecord

deleteRecord(record): BaseResponse | Promise<BaseResponse>
Parameters
- record: VectorRecord
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:36

`Abstract` deleteRecords

deleteRecords(records): BaseResponse | Promise<BaseResponse>
Parameters
- records: VectorRecord[]
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:37

`Abstract` editIndex

editIndex(params): BaseResponse | Promise<BaseResponse>
Parameters
- params: BaseRequestParams
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:27

`Abstract` getIndex

getIndex(params): BaseResponse | Promise<BaseResponse>
Parameters
- params: BaseRequestParams
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:24

`Abstract` getRecord

getRecord(param): BaseResponse | Promise<BaseResponse>
Parameters
- param: BaseRequestParams
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:32

`Abstract` getRecords

getRecords(params): BaseResponse | Promise<BaseResponse>
Parameters
- params: BaseRequestParams
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:33

`Abstract` listIndexes

listIndexes(): IndexList | Promise<IndexList>
Returns IndexList | Promise<IndexList>
- Defined in generic/VectorDBBase.ts:23

`Abstract` queryIndex

queryIndex(params): BaseResponse | Promise<BaseResponse>
Parameters
- params: QueryOptions
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:28

`Abstract` updateRecord

updateRecord(record): BaseResponse | Promise<BaseResponse>
Parameters
- record: UpdateOptions
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:34

`Abstract` updateRecords

updateRecords(records): BaseResponse | Promise<BaseResponse>
Parameters
- records: UpdateOptions
Returns BaseResponse | Promise<BaseResponse>
- Defined in generic/VectorDBBase.ts:35