Class TurbopufferVectorStore

constructor

• new TurbopufferVectorStore(embeddings, args): TurbopufferVectorStore

• Parameters

  • embeddings: EmbeddingsInterface

  • args: TurbopufferParams

  Returns TurbopufferVectorStore

FilterType

batchSize

caller

addDocuments

• addDocuments(documents, options?): Promise<string[]>

• Parameters

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

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

    • Optional ids?: string[]

  Returns Promise<string[]>

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[]>

callWithRetry

• callWithRetry(fetchUrl, stringifiedBody, method?): Promise<any>

• Parameters

  • fetchUrl: string

  • stringifiedBody: undefined | string

  • method: string = "POST"

  Returns Promise<any>

defaultHeaders

• defaultHeaders(): {
      Authorization: string;
      Content-Type: string;
  }

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

  • Authorization: string

  • Content-Type: string

delete

• delete(params): Promise<void>

• Parameters

  • params: {
        deleteIndex?: boolean;
    }

    • Optional deleteIndex?: boolean

  Returns Promise<void>

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][]>

Static fromDocuments

• fromDocuments(docs, embeddings, dbConfig): Promise<TurbopufferVectorStore>

• Parameters

  • docs: DocumentInterface<Record<string, any>>[]

  • embeddings: EmbeddingsInterface

  • dbConfig: TurbopufferParams

  Returns Promise<TurbopufferVectorStore>