Class for interacting with the MyScale database. It extends the VectorStore class and provides methods for adding vectors and documents, searching for similar vectors, and creating instances from texts or documents.

Hierarchy

Constructors

Properties

FilterType: MyScaleFilter
embeddings: Embeddings

Methods

  • Method to add documents to the MyScale database.

    Parameters

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

      The documents to add.

    Returns Promise<void>

    Promise that resolves when the documents have been added.

  • Method to add vectors to the MyScale database.

    Parameters

    • vectors: number[][]

      The vectors to add.

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

      The documents associated with the vectors.

    Returns Promise<void>

    Promise that resolves when the vectors have been added.

  • Parameters

    • Optional _params: Record<string, any>

    Returns Promise<void>

  • Parameters

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

  • Method to search for vectors that are similar to a given query vector.

    Parameters

    • query: number[]

      The query vector.

    • k: number

      The number of similar vectors to return.

    • Optional filter: MyScaleFilter

      Optional filter for the search results.

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

    Promise that resolves with an array of tuples, each containing a Document and a score.

  • Parameters

    Returns Promise<[Document<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<Document<Record<string, any>>[]>

    • List of documents selected by maximal marginal relevance.
  • Static method to create an instance of MyScaleStore from documents.

    Parameters

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

      The documents to use.

    • embeddings: Embeddings

      The embeddings to use.

    • args: MyScaleLibArgs

      The arguments for the MyScaleStore.

    Returns Promise<MyScaleStore>

    Promise that resolves with a new instance of MyScaleStore.

  • Static method to create an instance of MyScaleStore from an existing index.

    Parameters

    Returns Promise<MyScaleStore>

    Promise that resolves with a new instance of MyScaleStore.

  • Static method to create an instance of MyScaleStore from texts.

    Parameters

    • texts: string[]

      The texts to use.

    • metadatas: object | object[]

      The metadata associated with the texts.

    • embeddings: Embeddings

      The embeddings to use.

    • args: MyScaleLibArgs

      The arguments for the MyScaleStore.

    Returns Promise<MyScaleStore>

    Promise that resolves with a new instance of MyScaleStore.

Generated using TypeDoc