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

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>

  • Parameters

    • OptionalkOrFields: number | Partial<VectorStoreRetrieverInput<CloudflareVectorizeStore>>
    • Optionalfilter: VectorizeVectorMetadataFilter
    • Optionalcallbacks: Callbacks
    • Optionaltags: string[]
    • Optionalmetadata: Record<string, unknown>
    • Optionalverbose: boolean

    Returns VectorStoreRetriever<CloudflareVectorizeStore>

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

  • Parameters

    • query: string
    • Optionalk: number
    • Optionalfilter: VectorizeVectorMetadataFilter
    • Optional_callbacks: Callbacks

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

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

  • Parameters

    • query: string
    • Optionalk: number
    • Optionalfilter: VectorizeVectorMetadataFilter
    • Optional_callbacks: Callbacks

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

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