Class TurbopufferVectorStore

Abstract class representing a store of vectors. Provides methods for adding vectors and documents, deleting from the store, and searching the store.

Hierarchy

VectorStore
- TurbopufferVectorStore

Constructors

constructor

new TurbopufferVectorStore(embeddings, args): TurbopufferVectorStore
Parameters
- embeddings: EmbeddingsInterface
- args: TurbopufferParams
Returns TurbopufferVectorStore
Overrides VectorStore.constructor
- Defined in libs/langchain-community/src/vectorstores/turbopuffer.ts:70

Properties

FilterType

FilterType: TurbopufferFilterType

batchSize

batchSize: number = 3000

caller

caller: AsyncCaller

embeddings

embeddings: EmbeddingsInterface

`Protected` apiKey

apiKey: string

`Protected` apiUrl

apiUrl: string = "https://api.turbopuffer.com/v1"

`Protected` distanceMetric

distanceMetric: TurbopufferDistanceMetric = "cosine_distance"

`Protected` namespace

namespace: string = "default"

Methods

addDocuments

addDocuments(documents, options?): Promise<string[]>
Parameters
- documents: DocumentInterface<Record<string, any>>[]
- Optional options: {
  ids?: string[];
  }
  - Optional ids?: string[]
Returns Promise<string[]>
Overrides VectorStore.addDocuments
- Defined in libs/langchain-community/src/vectorstores/turbopuffer.ts:239

addVectors

addVectors(vectors, documents, options?): Promise<string[]>
Parameters
- vectors: number[][]
- documents: DocumentInterface<Record<string, any>>[]
- Optional options: {
  ids?: string[];
  }
  - Optional ids?: string[]
Returns Promise<string[]>
Overrides VectorStore.addVectors
- Defined in libs/langchain-community/src/vectorstores/turbopuffer.ts:140

asRetriever

asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<TurbopufferVectorStore>
Parameters
- Optional kOrFields: number | Partial<VectorStoreRetrieverInput<TurbopufferVectorStore>>
- Optional filter: TurbopufferFilterType
- Optional callbacks: Callbacks
- Optional tags: string[]
- Optional metadata: Record<string, unknown>
- Optional verbose: boolean
Returns VectorStoreRetriever<TurbopufferVectorStore>
Inherited from VectorStore.asRetriever
- Defined in langchain-core/dist/vectorstores.d.ts:126

callWithRetry

callWithRetry(fetchUrl, stringifiedBody, method?): Promise<any>
Parameters
- fetchUrl: string
- stringifiedBody: undefined | string
- method: string = "POST"
Returns Promise<any>
- Defined in libs/langchain-community/src/vectorstores/turbopuffer.ts:107

defaultHeaders

defaultHeaders(): {
Authorization: string;
Content-Type: string;
}
Returns {
Authorization: string;
Content-Type: string;
}
- Authorization: string
- Content-Type: string
- Defined in libs/langchain-community/src/vectorstores/turbopuffer.ts:100

delete

delete(params): Promise<void>
Parameters
- params: {
  deleteIndex?: boolean;
  }
  - Optional deleteIndex?: boolean
Returns Promise<void>
Overrides VectorStore.delete
- Defined in libs/langchain-community/src/vectorstores/turbopuffer.ts:227

similaritySearch

similaritySearch(query, k?, filter?, _callbacks?): Promise<DocumentInterface<Record<string, any>>[]>
Parameters
- query: string
- Optional k: number
- Optional filter: TurbopufferFilterType
- Optional _callbacks: Callbacks
Returns Promise<DocumentInterface<Record<string, any>>[]>
Inherited from VectorStore.similaritySearch
- Defined in langchain-core/dist/vectorstores.d.ts:106

similaritySearchVectorWithScore

similaritySearchVectorWithScore(query, k, filter?): Promise<[DocumentInterface<Record<string, any>>, number][]>
Parameters
- query: number[]
- k: number
- Optional filter: TurbopufferFilterType
Returns Promise<[DocumentInterface<Record<string, any>>, number][]>
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in libs/langchain-community/src/vectorstores/turbopuffer.ts:272

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[DocumentInterface<Record<string, any>>, number][]>
Parameters
- query: string
- Optional k: number
- Optional filter: TurbopufferFilterType
- Optional _callbacks: Callbacks
Returns Promise<[DocumentInterface<Record<string, any>>, number][]>
Inherited from VectorStore.similaritySearchWithScore
- Defined in langchain-core/dist/vectorstores.d.ts:107

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from VectorStore.toJSON
- Defined in langchain-core/dist/load/serializable.d.ts:64

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from VectorStore.toJSONNotImplemented
- Defined in langchain-core/dist/load/serializable.d.ts:65

`Optional` maxMarginalRelevanceSearch

maxMarginalRelevanceSearch(query, options, _callbacks): Promise<DocumentInterface<Record<string, any>>[]>
Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Parameters
- query: string
  
  Text to look up documents similar to.
- options: MaxMarginalRelevanceSearchOptions<TurbopufferFilterType>
- _callbacks: undefined | Callbacks
Returns Promise<DocumentInterface<Record<string, any>>[]>
- List of documents selected by maximal marginal relevance.
Inherited from VectorStore.maxMarginalRelevanceSearch
- Defined in langchain-core/dist/vectorstores.d.ts:123

`Static` fromDocuments

fromDocuments(docs, embeddings, dbConfig): Promise<TurbopufferVectorStore>
Parameters
- docs: DocumentInterface<Record<string, any>>[]
- embeddings: EmbeddingsInterface
- dbConfig: TurbopufferParams
Returns Promise<TurbopufferVectorStore>
Overrides VectorStore.fromDocuments
- Defined in libs/langchain-community/src/vectorstores/turbopuffer.ts:292

`Static` fromTexts

fromTexts(_texts, _metadatas, _embeddings, _dbConfig): Promise<VectorStore>
Parameters
- _texts: string[]
- _metadatas: object | object[]
- _embeddings: EmbeddingsInterface
- _dbConfig: Record<string, any>
Returns Promise<VectorStore>
Inherited from VectorStore.fromTexts
- Defined in langchain-core/dist/vectorstores.d.ts:124

`Protected` queryVectors

queryVectors(query, k, includeVector?, filter?): Promise<TurbopufferQueryResult[]>
Parameters
- query: number[]
- k: number
- Optional includeVector: boolean
- Optional filter: TurbopufferFilterType
Returns Promise<TurbopufferQueryResult[]>
- Defined in libs/langchain-community/src/vectorstores/turbopuffer.ts:250

Class TurbopufferVectorStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

embeddings: EmbeddingsInterface

args: TurbopufferParams

Returns TurbopufferVectorStore

Properties

FilterType

batchSize

caller

embeddings

Protected apiKey

Protected apiUrl

Protected distanceMetric

Protected namespace

Methods

addDocuments

Parameters

documents: DocumentInterface<Record<string, any>>[]

Optional options: { ids?: string[]; }

Optional ids?: string[]

Returns Promise<string[]>

addVectors

Parameters

vectors: number[][]

documents: DocumentInterface<Record<string, any>>[]

Optional options: { ids?: string[]; }

Optional ids?: string[]

Returns Promise<string[]>

asRetriever

Parameters

Optional kOrFields: number | Partial<VectorStoreRetrieverInput<TurbopufferVectorStore>>

Optional filter: TurbopufferFilterType

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<TurbopufferVectorStore>

callWithRetry

Parameters

fetchUrl: string

stringifiedBody: undefined | string

method: string = "POST"

Returns Promise<any>

defaultHeaders

Returns { Authorization: string; Content-Type: string; }

Authorization: string

Content-Type: string

delete

Parameters

params: { deleteIndex?: boolean; }

Optional deleteIndex?: boolean

Returns Promise<void>

similaritySearch

Parameters

query: string

Optional k: number

Optional filter: TurbopufferFilterType

Optional _callbacks: Callbacks

Returns Promise<DocumentInterface<Record<string, any>>[]>

similaritySearchVectorWithScore

Parameters

query: number[]

k: number

Optional filter: TurbopufferFilterType

Returns Promise<[DocumentInterface<Record<string, any>>, number][]>

similaritySearchWithScore

Parameters

query: string

Optional k: number

Optional filter: TurbopufferFilterType

Optional _callbacks: Callbacks

Returns Promise<[DocumentInterface<Record<string, any>>, number][]>

toJSON

`Protected` apiKey

`Protected` apiUrl

`Protected` distanceMetric

`Protected` namespace

`Optional` options: {
ids?: string[];
}

`Optional` ids?: string[]

`Optional` options: {
ids?: string[];
}

`Optional` ids?: string[]

`Optional` kOrFields: number | Partial<VectorStoreRetrieverInput<TurbopufferVectorStore>>

`Optional` filter: TurbopufferFilterType

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

Returns {
Authorization: string;
Content-Type: string;
}

params: {
deleteIndex?: boolean;
}

`Optional` deleteIndex?: boolean

`Optional` k: number

`Optional` filter: TurbopufferFilterType

`Optional` _callbacks: Callbacks

`Optional` filter: TurbopufferFilterType

`Optional` k: number

`Optional` filter: TurbopufferFilterType

`Optional` _callbacks: Callbacks

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

`Static` fromTexts

`Protected` queryVectors

`Optional` includeVector: boolean

`Optional` filter: TurbopufferFilterType