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

Hierarchy

Constructors

Properties

FilterType: VectorizeVectorMetadataFilter
caller: AsyncCaller
index: VectorizeIndex
textKey: string
namespace?: string

Methods

  • Method that adds documents to the Vectorize database.

    Parameters

    • documents: Document[]

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

      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.

  • 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.

    • Optional filter: VectorizeVectorMetadataFilter

    Returns Promise<[Document, number][]>

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

  • Static method that creates a new instance of the CloudflareVectorizeStore class from documents.

    Parameters

    • docs: Document[]

      Array of documents to add to the Vectorize database.

    • embeddings: EmbeddingsInterface

      Embeddings to use for the documents.

    • dbConfig: VectorizeLibArgs

      Configuration for the Vectorize database.

    Returns Promise<CloudflareVectorizeStore>

    Promise that resolves with a new instance of the CloudflareVectorizeStore class.

  • Static method that creates a new instance of the CloudflareVectorizeStore class from texts.

    Parameters

    • texts: string[]

      Array of texts to add to the Vectorize database.

    • metadatas: Record<string, VectorizeVectorMetadata> | Record<string, VectorizeVectorMetadata>[]

      Metadata associated with the texts.

    • embeddings: EmbeddingsInterface

      Embeddings to use for the texts.

    • dbConfig: VectorizeLibArgs

      Configuration for the Vectorize database.

    Returns Promise<CloudflareVectorizeStore>

    Promise that resolves with a new instance of the CloudflareVectorizeStore class.

Generated using TypeDoc