Class CloudflareVectorizeStore

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

Hierarchy

  • VectorStore
    • CloudflareVectorizeStore

Constructors

constructor

Properties

FilterType caller embeddings index namespace? textKey

Methods

addDocuments addVectors asRetriever delete maxMarginalRelevanceSearch? similaritySearch similaritySearchVectorWithScore similaritySearchWithScore toJSON toJSONNotImplemented fromDocuments fromExistingIndex fromTexts

Constructors

constructor

Properties

FilterType

FilterType: VectorizeVectorMetadataFilter

caller

caller: AsyncCaller

embeddings

embeddings: EmbeddingsInterface

Embeddings interface for generating vector embeddings from text queries, enabling vector-based similarity searches.

index

index: VectorizeIndex

Optionalnamespace

namespace?: string

textKey

textKey: string

Methods

addDocuments

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

  • Method that adds documents to the Vectorize database.

    Parameters

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

      Array of documents to add.

    • Optionaloptions: string[] | {
          ids?: string[];
      }

      Optional ids for the documents.

    Returns Promise<string[]>

    Promise that resolves with the ids of the added documents.

addVectors

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

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

    • Optionaloptions: string[] | {
          ids?: string[];
      }

      Optional ids for the vectors.

    Returns Promise<string[]>

    Promise that resolves with the ids of the added vectors.

asRetriever

  • asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<CloudflareVectorizeStore>

  • Creates a VectorStoreRetriever instance with flexible configuration options.

    Parameters

    • OptionalkOrFields: number | Partial<VectorStoreRetrieverInput<CloudflareVectorizeStore>>

      If a number is provided, it sets the k parameter (number of items to retrieve).

      • If an object is provided, it should contain various configuration options.
    • Optionalfilter: VectorizeVectorMetadataFilter

      Optional filter criteria to limit the items retrieved based on the specified filter type.

    • Optionalcallbacks: Callbacks

      Optional callbacks that may be triggered at specific stages of the retrieval process.

    • Optionaltags: string[]

      Tags to categorize or label the VectorStoreRetriever. Defaults to an empty array if not provided.

    • Optionalmetadata: Record<string, unknown>

      Additional metadata as key-value pairs to add contextual information for the retrieval process.

    • Optionalverbose: boolean

      If true, enables detailed logging for the retrieval process. Defaults to false.

    Returns VectorStoreRetriever<CloudflareVectorizeStore>

    • A configured VectorStoreRetriever instance based on the provided parameters.

    Example

    Basic usage with a k value:

    const retriever = myVectorStore.asRetriever(5);

    Usage with a configuration object:

    const retriever = myVectorStore.asRetriever({
      k: 10,
      filter: myFilter,
      tags: ['example', 'test'],
      verbose: true,
      searchType: 'mmr',
      searchKwargs: { alpha: 0.5 },
    });

delete

OptionalmaxMarginalRelevanceSearch

  • 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<VectorizeVectorMetadataFilter>
    • _callbacks: undefined | Callbacks

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

    • List of documents selected by maximal marginal relevance.

similaritySearch

  • similaritySearch(query, k?, filter?, _callbacks?): Promise<DocumentInterface<Record<string, any>>[]>

  • Searches for documents similar to a text query by embedding the query and performing a similarity search on the resulting vector.

    Parameters

    • query: string

      Text query for finding similar documents.

    • Optionalk: number

      Number of similar results to return. Defaults to 4.

    • Optionalfilter: VectorizeVectorMetadataFilter

      Optional filter based on FilterType.

    • Optional_callbacks: Callbacks

      Optional callbacks for monitoring search progress

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

    A promise resolving to an array of DocumentInterface instances representing similar documents.

similaritySearchVectorWithScore

  • similaritySearchVectorWithScore(query, k, filter?): Promise<[Document<Record<string, any>>, number][]>

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

    • Optionalfilter: VectorizeVectorMetadataFilter

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

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

similaritySearchWithScore

  • similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[DocumentInterface<Record<string, any>>, number][]>

  • Searches for documents similar to a text query by embedding the query, and returns results with similarity scores.

    Parameters

    • query: string

      Text query for finding similar documents.

    • Optionalk: number

      Number of similar results to return. Defaults to 4.

    • Optionalfilter: VectorizeVectorMetadataFilter

      Optional filter based on FilterType.

    • Optional_callbacks: Callbacks

      Optional callbacks for monitoring search progress

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

    A promise resolving to an array of tuples, each containing a document and its similarity score.

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

StaticfromDocuments

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

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

    Parameters

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

      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.

StaticfromExistingIndex

StaticfromTexts

  • fromTexts(texts, metadatas, embeddings, dbConfig): Promise<CloudflareVectorizeStore>

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods