⚠️ Deprecated ⚠️

Install and import from "@langchain/cloudflare" instead.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Class that extends the VectorStore class and provides methods to interact with the Cloudflare Vectorize vector database.

Hierarchy

Constructors

Properties

FilterType: string | object
caller: AsyncCaller
index: VectorizeIndex
textKey: string
namespace?: string

Methods

  • Method that adds documents to the Vectorize database.

    Parameters

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

      Array of documents to add.

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

      Optional ids for the documents.

    Returns Promise<string[]>

    Promise that resolves with the ids of the added documents.

  • Method that adds vectors to the Vectorize database.

    Parameters

    • vectors: number[][]

      Array of vectors to add.

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

      Array of documents associated with the vectors.

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

      Optional ids for the vectors.

    Returns Promise<string[]>

    Promise that resolves with the ids of the added vectors.

  • Parameters

    • query: string
    • Optional k: number
    • Optional filter: string | object
    • Optional _callbacks: Callbacks

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

  • Method that performs a similarity search in the Vectorize database and returns the results along with their scores.

    Parameters

    • query: number[]

      Query vector for the similarity search.

    • k: number

      Number of top results to return.

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

    Promise that resolves with an array of documents and their scores.

  • Parameters

    • query: string
    • Optional k: number
    • Optional filter: string | object
    • Optional _callbacks: Callbacks

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

  • Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.

    Parameters

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

    • List of documents selected by maximal marginal relevance.

Generated using TypeDoc