Class TurbopufferVectorStore

Deprecated

Use TurbopufferVectorStore from @langchain/turbopuffer instead. The new package uses the official SDK and supports document deletion, region configuration, and returns document IDs in search results.

Hierarchy (View Summary)

Toolkit
- TurbopufferVectorStore

Index

Constructors

constructor

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

Properties

`Protected`apiKey

apiKey: string

`Protected`apiUrl

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

batchSize

batchSize: number = 3000

caller

caller: AsyncCaller

`Protected`distanceMetric

distanceMetric: TurbopufferDistanceMetric = "cosine_distance"

FilterType

FilterType: TurbopufferFilterType

`Protected`namespace

namespace: string = "default"

Accessors

lc_aliases

get lc_aliases(): { [key: string]: string }
Returns { [key: string]: string }
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:60

lc_secrets

get lc_secrets(): { [key: string]: string }
Returns { [key: string]: string }
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:54

Methods

_vectorstoreType

_vectorstoreType(): string
Returns string
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:83

addDocuments

addDocuments(
documents: DocumentInterface[],
options?: { ids?: string[] },
): Promise<string[]>
Parameters
- documents: DocumentInterface[]
- Optionaloptions: { ids?: string[] }
Returns Promise<string[]>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:257

addVectors

addVectors(
    vectors: number[][],
    documents: DocumentInterface[],
    options?: { ids?: string[] },
): Promise<string[]>
Parameters
- vectors: number[][]
- documents: DocumentInterface[]
- Optionaloptions: { ids?: string[] }
Returns Promise<string[]>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:157

callWithRetry

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

defaultHeaders

defaultHeaders(): { Authorization: string; "Content-Type": string }
Returns { Authorization: string; "Content-Type": string }
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:117

delete

delete(params: { deleteIndex?: boolean }): Promise<void>
Parameters
- params: { deleteIndex?: boolean }
Returns Promise<void>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:245

`Protected`queryVectors

queryVectors(
    query: number[],
    k: number,
    includeVector?: boolean,
    filter?: TurbopufferFilterType,
): Promise<TurbopufferQueryResult[]>
Parameters
- query: number[]
- k: number
- OptionalincludeVector: boolean
- Optionalfilter: TurbopufferFilterType
Returns Promise<TurbopufferQueryResult[]>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:268

similaritySearchVectorWithScore

similaritySearchVectorWithScore(
    query: number[],
    k: number,
    filter?: TurbopufferFilterType,
): Promise<[DocumentInterface, number][]>
Parameters
- query: number[]
- k: number
- Optionalfilter: TurbopufferFilterType
Returns Promise<[DocumentInterface, number][]>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:290

`Static`fromDocuments

fromDocuments(
    docs: DocumentInterface[],
    embeddings: EmbeddingsInterface,
    dbConfig: TurbopufferParams,
): Promise<TurbopufferVectorStore>
Parameters
- docs: DocumentInterface[]
- embeddings: EmbeddingsInterface
- dbConfig: TurbopufferParams
Returns Promise<TurbopufferVectorStore>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:310

`Static`lc_name

lc_name(): string
Returns string
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/vectorstores/turbopuffer.ts:67

Class TurbopufferVectorStore

Deprecated

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TurbopufferVectorStore

Properties

ProtectedapiKey

ProtectedapiUrl

batchSize

caller

ProtecteddistanceMetric

FilterType

Protectednamespace

Accessors

lc_aliases

Returns { [key: string]: string }

lc_secrets

Returns { [key: string]: string }

Methods

_vectorstoreType

Returns string

addDocuments

Parameters

Returns Promise<string[]>

addVectors

Parameters

Returns Promise<string[]>

callWithRetry

Parameters

Returns Promise<any>

defaultHeaders

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

delete

Parameters

Returns Promise<void>

ProtectedqueryVectors

Parameters

Returns Promise<TurbopufferQueryResult[]>

similaritySearchVectorWithScore

Parameters

Returns Promise<[DocumentInterface, number][]>

StaticfromDocuments

Parameters

Returns Promise<TurbopufferVectorStore>

Staticlc_name

Returns string

Settings

On This Page

`Protected`apiKey

`Protected`apiUrl

`Protected`distanceMetric

`Protected`namespace

`Protected`queryVectors

`Static`fromDocuments

`Static`lc_name