Class: PineconeVectorStore
Defined in: batteries/vector/pinecone/index.ts:55
Extends
Constructors
Constructor
new PineconeVectorStore(options: BaseVectorStoreOptions): PineconeVectorStore;Defined in: batteries/vector/contract.ts:35
Parameters
| Parameter | Type |
|---|---|
options | BaseVectorStoreOptions |
Returns
PineconeVectorStore
Inherited from
Properties
| Property | Modifier | Type | Overrides | Defined in |
|---|---|---|---|---|
capabilities | readonly | VectorStoreCapabilities | BaseVectorStore.capabilities | batteries/vector/pinecone/index.ts:56 |
Accessors
schema
Get Signature
get schema(): VectorSchemaBuilder;Defined in: batteries/vector/contract.ts:64
Returns
Inherited from
Methods
asCallable()
asCallable(): CallableVectorStore;Defined in: batteries/vector/contract.ts:73
Returns
Inherited from
close()
close(): Promise<void>;Defined in: batteries/vector/pinecone/index.ts:190
Returns
Promise<void>
Overrides
connect()
connect(): Promise<void>;Defined in: batteries/vector/pinecone/index.ts:179
Returns
Promise<void>
Overrides
createCollection()
createCollection(spec: CollectionSpec, ifNotExists: boolean): Promise<void>;Defined in: batteries/vector/pinecone/index.ts:194
Parameters
| Parameter | Type |
|---|---|
spec | CollectionSpec |
ifNotExists | boolean |
Returns
Promise<void>
Overrides
BaseVectorStore.createCollection
dropCollection()
dropCollection(collection: string, ifExists: boolean): Promise<void>;Defined in: batteries/vector/pinecone/index.ts:211
Parameters
| Parameter | Type |
|---|---|
collection | string |
ifExists | boolean |
Returns
Promise<void>
Overrides
BaseVectorStore.dropCollection
executeDelete()
executeDelete(plan: DeletePlan): Promise<void>;Defined in: batteries/vector/pinecone/index.ts:440
Parameters
| Parameter | Type |
|---|---|
plan | DeletePlan |
Returns
Promise<void>
Overrides
executeSearch()
executeSearch(plan: SearchPlan): Promise<VectorMatch[]>;Defined in: batteries/vector/pinecone/index.ts:310
Parameters
| Parameter | Type |
|---|---|
plan | SearchPlan |
Returns
Promise<VectorMatch[]>
Overrides
executeUpsert()
executeUpsert(plan: UpsertPlan): Promise<void>;Defined in: batteries/vector/pinecone/index.ts:266
Parameters
| Parameter | Type |
|---|---|
plan | UpsertPlan |
Returns
Promise<void>
Overrides
hasCollection()
hasCollection(collection: string): Promise<boolean>;Defined in: batteries/vector/pinecone/index.ts:258
Parameters
| Parameter | Type |
|---|---|
collection | string |
Returns
Promise<boolean>
Overrides
isAvailable()
isAvailable(): boolean;Defined in: batteries/vector/pinecone/index.ts:176
Returns
boolean
Overrides
query()
query(collection: string): VectorQueryBuilder;Defined in: batteries/vector/contract.ts:68
Parameters
| Parameter | Type |
|---|---|
collection | string |
Returns
Inherited from
renameCollection()
renameCollection(_from: string, _to: string): Promise<void>;Defined in: batteries/vector/pinecone/index.ts:263
Parameters
| Parameter | Type |
|---|---|
_from | string |
_to | string |
Returns
Promise<void>
Overrides
BaseVectorStore.renameCollection
transaction()
transaction(_fn: (tx: CallableVectorStore) => Promise<void>): Promise<void>;Defined in: batteries/vector/contract.ts:60
Parameters
| Parameter | Type |
|---|---|
_fn | (tx: CallableVectorStore) => Promise<void> |
Returns
Promise<void>
Inherited from
isAvailable()
static isAvailable(): boolean;Defined in: batteries/vector/pinecone/index.ts:173
Returns
boolean