Class Typesense

Typesense vector store.

Hierarchy

  • VectorStore
    • Typesense

Constructors

constructor

Properties

FilterType embeddings

Methods

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

Constructors

constructor

Properties

FilterType

FilterType: Partial<MultiSearchRequestSchema>

embeddings

embeddings: EmbeddingsInterface

Methods

addDocuments

  • addDocuments(documents): Promise<void>

  • Add documents to the vector store. Will be updated if in the metadata there is a document with the same id if is using the default import function. Metadata will be added in the columns of the schema based on metadataColumnNames.

    Parameters

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

      Documents to add.

    Returns Promise<void>

addVectors

  • addVectors(vectors, documents): Promise<void>

  • Adds vectors to the vector store.

    Parameters

    • vectors: number[][]

      Vectors to add.

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

      Documents associated with the vectors.

    Returns Promise<void>

asRetriever

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

  • Parameters

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

    Returns VectorStoreRetriever<Typesense>

delete

  • delete(_params?): Promise<void>

  • Parameters

    • Optional_params: Record<string, any>

    Returns Promise<void>

deleteDocuments

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<Partial<MultiSearchRequestSchema>>
    • _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: Partial<MultiSearchRequestSchema>
    • Optional_callbacks: Callbacks

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

similaritySearchVectorWithScore

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

  • Search for similar documents with their similarity score.

    Parameters

    • vectorPrompt: number[]

      vector to search for

    • Optionalk: number

      amount of results to return

    • filter: Partial<MultiSearchRequestSchema> = {}

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

    similar documents with their similarity score

similaritySearchWithScore

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

  • Parameters

    • query: string
    • Optionalk: number
    • Optionalfilter: Partial<MultiSearchRequestSchema>
    • Optional_callbacks: Callbacks

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

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

StaticfromDocuments

  • fromDocuments(docs, embeddings, config): Promise<Typesense>

  • Create a vector store from documents.

    Parameters

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

      documents

    • embeddings: EmbeddingsInterface

      embeddings

    • config: TypesenseConfig

      Typesense configuration

    Returns Promise<Typesense>

    Typesense vector store

    Warning

    You can omit this method, and only use the constructor and addDocuments.

StaticfromTexts

Settings

Member Visibility

On This Page

Constructors
Properties
Methods