Class Neo4jVectorStore

Security

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include necessary permissions. Failure to do so may result in data corruption or loss, since the calling code may attempt commands that would result in deletion, mutation of data if appropriately prompted or reading sensitive data if such data is present in the database. The best way to guard against such negative outcomes is to (as appropriate) limit the permissions granted to the credentials used with this tool. For example, creating read only users for the database is a good way to ensure that the calling code cannot mutate or delete data.

Link

See https://js.langchain.com/docs/security for more information.

Hierarchy

  • VectorStore
    • Neo4jVectorStore

Constructors

constructor

Properties

FilterType embeddings

Methods

addDocuments addVectors asRetriever close createNewIndex createNewKeywordIndex delete maxMarginalRelevanceSearch? query retrieveExistingFtsIndex retrieveExistingIndex similaritySearch similaritySearchVectorWithScore similaritySearchWithScore sortByIndexName toJSON toJSONNotImplemented fromDocuments fromExistingGraph fromExistingIndex fromTexts initialize

Constructors

constructor

Properties

FilterType

FilterType: string | object

embeddings

embeddings: EmbeddingsInterface

Methods

addDocuments

addVectors

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

  • Parameters

    • vectors: number[][]
    • documents: Document<Record<string, any>>[]
    • Optionalmetadatas: Record<string, any>[]
    • Optionalids: string[]

    Returns Promise<string[]>

asRetriever

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

  • Parameters

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

    Returns VectorStoreRetriever<Neo4jVectorStore>

close

createNewIndex

createNewKeywordIndex

delete

  • delete(_params?): Promise<void>

  • Parameters

    • Optional_params: Record<string, any>

    Returns Promise<void>

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

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

    • List of documents selected by maximal marginal relevance.

query

retrieveExistingFtsIndex

retrieveExistingIndex

similaritySearch

similaritySearchVectorWithScore

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

  • Parameters

    • vector: number[]
    • k: number
    • query: string
    • params: Record<string, any> = {}

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

similaritySearchWithScore

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

  • Parameters

    • query: string
    • k: number = 4
    • params: Record<string, any> = {}

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

sortByIndexName

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

StaticfromDocuments

StaticfromExistingGraph

StaticfromExistingIndex

StaticfromTexts

Staticinitialize

Settings

Member Visibility

On This Page

Constructors
Properties
Methods