Class PineconeStore

constructor

• new PineconeStore(options: PineconeConfiguration): PineconeStore

  Parameters

  • options: PineconeConfiguration

  Returns PineconeStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): Pinecone

  Returns the underlying Pinecone client for anything not wrapped here (e.g. collections, assistants, inference).

  Returns Pinecone

listIndexes

• listIndexes(): Promise<IndexList>

  List all indexes in the project.

  Returns Promise<IndexList>

describeIndex

• describeIndex(indexName: string): Promise<IndexModel>

  Describe a single index (dimension, metric, host, spec, ready status).

  Parameters

  • indexName: string

  Returns Promise<IndexModel>

createIndex

• createIndex(options: CreateIndexOptions): Promise<void | IndexModel>

  Create a new index. options.spec selects the deployment shape - { serverless: { cloud, region } } for a serverless index or { pod: { environment, podType, ... } } for a pod-based index - and is required by the underlying SDK, matching Pinecone's actual index lifecycle (there is no dimension-less/spec-less index).

  Parameters

  • options: CreateIndexOptions

  Returns Promise<void | IndexModel>

deleteIndex

• deleteIndex(indexName: string): Promise<void>

  Delete an index by name. Irreversible - all vectors in every namespace are destroyed with it.

  Parameters

  • indexName: string

  Returns Promise<void>

upsert

• upsert<T extends RecordMetadata = RecordMetadata>(
      indexName: string,
      records: VectorRecord<T> | VectorRecord<T>[],
      options?: UpsertVectorsOptions,
  ): Promise<void>

  Upsert one or more vector records into indexName. If a record's id already exists, its values/metadata are overwritten in full (not merged) - this is the same "insert or fully replace" semantics as the real Pinecone upsert API.

  Type Parameters

  • T extends RecordMetadata = RecordMetadata

  Parameters

  • indexName: string
  • records: VectorRecord<T> | VectorRecord<T>[]
  • options: UpsertVectorsOptions = {}

  Returns Promise<void>

query

• query<T extends RecordMetadata = RecordMetadata>(
      indexName: string,
      options: QueryOptions,
      namespace?: string,
  ): Promise<QueryResponse<T>>

  Find the topK records most similar to a query vector (options.vector) or to an existing record's vector (options.id). See QueryVectorsOptions/the real SDK's QueryOptions for filter/includeMetadata/includeValues.

  Type Parameters

  • T extends RecordMetadata = RecordMetadata

  Parameters

  • indexName: string
  • options: QueryOptions
  • Optionalnamespace: string

  Returns Promise<QueryResponse<T>>

fetch

• fetch<T extends RecordMetadata = RecordMetadata>(
      indexName: string,
      ids: string[],
      options?: FetchVectorsOptions,
  ): Promise<FetchResponse<T>>

  Fetch one or more records by id. Ids that don't exist are simply absent from records in the response.

  Type Parameters

  • T extends RecordMetadata = RecordMetadata

  Parameters

  • indexName: string
  • ids: string[]
  • options: FetchVectorsOptions = {}

  Returns Promise<FetchResponse<T>>

update

• update<T extends RecordMetadata = RecordMetadata>(
      indexName: string,
      options: UpdateVectorOptions<T>,
  ): Promise<void>

  Update an existing record by id. A provided values array overwrites the stored vector; a provided metadata object is merged into the existing metadata (only the given fields are added/changed, matching the real SDK's partial-update semantics).

  Type Parameters

  • T extends RecordMetadata = RecordMetadata

  Parameters

  • indexName: string
  • options: UpdateVectorOptions<T>

  Returns Promise<void>

deleteByIds

• deleteByIds(
      indexName: string,
      ids: string[],
      options?: PineconeDeleteByIdsOptions,
  ): Promise<void>

  Delete records by id.

  Parameters

  • indexName: string
  • ids: string[]
  • options: PineconeDeleteByIdsOptions = {}

  Returns Promise<void>

deleteByFilter

• deleteByFilter(
      indexName: string,
      filter: object,
      options?: PineconeDeleteByFilterOptions,
  ): Promise<void>

  Delete every record matching a metadata filter (e.g. { genre: { $eq: 'classical' } }).

  Parameters

  • indexName: string
  • filter: object
  • options: PineconeDeleteByFilterOptions = {}

  Returns Promise<void>

deleteAll

• deleteAll(indexName: string, options?: DeleteAllVectorsOptions): Promise<void>

  Delete every record in a namespace (or the default namespace, if none is given).

  Parameters

  • indexName: string
  • options: DeleteAllVectorsOptions = {}

  Returns Promise<void>

describeIndexStats

• describeIndexStats(
      indexName: string,
      options?: DescribeIndexStatsOptions,
  ): Promise<IndexStatsDescription>

  Record counts per namespace, the index's configured dimension, and (for pod-based indexes) fullness.

  Parameters

  • indexName: string
  • options: DescribeIndexStatsOptions = {}

  Returns Promise<IndexStatsDescription>