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

new Neo4jVectorStore(embeddings, config): Neo4jVectorStore
Parameters
- embeddings: Embeddings
- config: Neo4jVectorStoreArgs
Returns Neo4jVectorStore
Overrides VectorStore.constructor
- Defined in langchain/src/vectorstores/neo4j_vector.ts:74

Properties

FilterType

FilterType: string | object

embeddings

embeddings: Embeddings

lc_kwargs

lc_kwargs: SerializedFields

lc_namespace

lc_namespace: string[] = ...

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

lc_serializable

lc_serializable: boolean = false

Accessors

lc_aliases

get lc_aliases(): undefined | {
[key: string]: string;
}
A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

Returns undefined | {
[key: string]: string;
}
Inherited from VectorStore.lc_aliases
- Defined in langchain/src/load/serializable.ts:132

lc_attributes

get lc_attributes(): undefined | SerializedFields
A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

Returns undefined | SerializedFields
Inherited from VectorStore.lc_attributes
- Defined in langchain/src/load/serializable.ts:122

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from VectorStore.lc_id
- Defined in langchain/src/load/serializable.ts:100

lc_secrets

get lc_secrets(): undefined | {
[key: string]: string;
}
A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

Returns undefined | {
[key: string]: string;
}
Inherited from VectorStore.lc_secrets
- Defined in langchain/src/load/serializable.ts:112

Methods

_dropIndex

_dropIndex(): Promise<void>
Returns Promise<void>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:138

_initializeDriver

_initializeDriver(__namedParameters): Promise<void>
Parameters
- __namedParameters: Neo4jVectorStoreArgs
Returns Promise<void>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:114

_vectorstoreType

_vectorstoreType(): string
Returns string
Overrides VectorStore._vectorstoreType
- Defined in langchain/src/vectorstores/neo4j_vector.ts:70

_verifyConnectivity

_verifyConnectivity(): Promise<void>
Returns Promise<void>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:130

addDocuments

addDocuments(documents): Promise<string[]>
Parameters
- documents: Document<Record<string, any>>[]
Returns Promise<string[]>
Overrides VectorStore.addDocuments
- Defined in langchain/src/vectorstores/neo4j_vector.ts:572

addVectors

addVectors(vectors, documents, metadatas?, ids?): Promise<string[]>
Parameters
- vectors: number[][]
- documents: Document<Record<string, any>>[]
- Optional metadatas: Record<string, any>[]
- Optional ids: string[]
Returns Promise<string[]>
Overrides VectorStore.addVectors
- Defined in langchain/src/vectorstores/neo4j_vector.ts:527

asRetriever

asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<Neo4jVectorStore>
Parameters
- Optional kOrFields: number | Partial<VectorStoreRetrieverInput<Neo4jVectorStore>>
- Optional filter: string | object
- Optional callbacks: Callbacks
- Optional tags: string[]
- Optional metadata: Record<string, unknown>
- Optional verbose: boolean
Returns VectorStoreRetriever<Neo4jVectorStore>
Inherited from VectorStore.asRetriever
- Defined in langchain/src/vectorstores/base.ts:246

close

close(): Promise<void>
Returns Promise<void>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:134

createNewIndex

createNewIndex(): Promise<void>
Returns Promise<void>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:389

createNewKeywordIndex

createNewKeywordIndex(textNodeProperties?): Promise<void>
Parameters
- textNodeProperties: string[] = []
Returns Promise<void>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:496

delete

delete(_params?): Promise<void>
Parameters
- Optional _params: Record<string, any>
Returns Promise<void>
Inherited from VectorStore.delete
- Defined in langchain/src/vectorstores/base.ts:164

query

query(query, params?): Promise<any[]>
Parameters
- query: string
- params: any = {}
Returns Promise<any[]>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:155

retrieveExistingFtsIndex

retrieveExistingFtsIndex(textNodeProperties?): Promise<null | string>
Parameters
- textNodeProperties: string[] = []
Returns Promise<null | string>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:450

retrieveExistingIndex

retrieveExistingIndex(): Promise<null | number>
Returns Promise<null | number>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:411

similaritySearch

similaritySearch(query, k?): Promise<Document<Record<string, any>>[]>
Parameters
- query: string
- k: number = 4
Returns Promise<Document<Record<string, any>>[]>
Overrides VectorStore.similaritySearch
- Defined in langchain/src/vectorstores/neo4j_vector.ts:581

similaritySearchVectorWithScore

similaritySearchVectorWithScore(vector, k, query): Promise<[Document<Record<string, any>>, number][]>
Parameters
- vector: number[]
- k: number
- query: string
Returns Promise<[Document<Record<string, any>>, number][]>
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in langchain/src/vectorstores/neo4j_vector.ts:593

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[Document<Record<string, any>>, number][]>
Parameters
- query: string
- k: number = 4
- filter: undefined | string | object = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<[Document<Record<string, any>>, number][]>
Inherited from VectorStore.similaritySearchWithScore
- Defined in langchain/src/vectorstores/base.ts:189

sortByIndexName

sortByIndexName(values, indexName): {
[key: string]: any;
}[]
Parameters
- values: {
  [key: string]: any;
  }[]
- indexName: string
Returns {
[key: string]: any;
}[]
- Defined in langchain/src/vectorstores/neo4j_vector.ts:514

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from VectorStore.toJSON
- Defined in langchain/src/load/serializable.ts:140

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from VectorStore.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:214

`Optional` maxMarginalRelevanceSearch

maxMarginalRelevanceSearch(query, options, _callbacks): Promise<Document<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<Document<Record<string, any>>[]>
- List of documents selected by maximal marginal relevance.
Inherited from VectorStore.maxMarginalRelevanceSearch
- Defined in langchain/src/vectorstores/base.ts:217

`Static` fromDocuments

fromDocuments(docs, embeddings, config): Promise<Neo4jVectorStore>
Parameters
- docs: Document<Record<string, any>>[]
- embeddings: Embeddings
- config: Neo4jVectorStoreArgs
Returns Promise<Neo4jVectorStore>
Overrides VectorStore.fromDocuments
- Defined in langchain/src/vectorstores/neo4j_vector.ts:182

`Static` fromExistingGraph

fromExistingGraph(embeddings, config): Promise<Neo4jVectorStore>
Parameters
- embeddings: Embeddings
- config: Neo4jVectorStoreArgs
Returns Promise<Neo4jVectorStore>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:281

`Static` fromExistingIndex

fromExistingIndex(embeddings, config): Promise<Neo4jVectorStore>
Parameters
- embeddings: Embeddings
- config: Neo4jVectorStoreArgs
Returns Promise<Neo4jVectorStore>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:232

`Static` fromTexts

fromTexts(texts, metadatas, embeddings, config): Promise<Neo4jVectorStore>
Parameters
- texts: string[]
- metadatas: any
- embeddings: Embeddings
- config: Neo4jVectorStoreArgs
Returns Promise<Neo4jVectorStore>
Overrides VectorStore.fromTexts
- Defined in langchain/src/vectorstores/neo4j_vector.ts:161

`Static` initialize

initialize(embeddings, config): Promise<Neo4jVectorStore>
Parameters
- embeddings: Embeddings
- config: Neo4jVectorStoreArgs
Returns Promise<Neo4jVectorStore>
- Defined in langchain/src/vectorstores/neo4j_vector.ts:78

`Static` lc_name

lc_name(): string
The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

Returns string
Inherited from VectorStore.lc_name
- Defined in langchain/src/load/serializable.ts:93

Class Neo4jVectorStore

Security

Link

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

embeddings: Embeddings

config: Neo4jVectorStoreArgs

Returns Neo4jVectorStore

Properties

FilterType

embeddings

lc_kwargs

lc_namespace

lc_serializable

Accessors

lc_aliases

Returns undefined | { [key: string]: string; }

lc_attributes

Returns undefined | SerializedFields

lc_id

Returns string[]

lc_secrets

Returns undefined | { [key: string]: string; }

Methods

_dropIndex

Returns Promise<void>

_initializeDriver

Parameters

__namedParameters: Neo4jVectorStoreArgs

Returns Promise<void>

_vectorstoreType

Returns string

_verifyConnectivity

Returns Promise<void>

addDocuments

Parameters

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

Returns Promise<string[]>

addVectors

Parameters

vectors: number[][]

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

Optional metadatas: Record<string, any>[]

Optional ids: string[]

Returns Promise<string[]>

asRetriever

Parameters

Optional kOrFields: number | Partial<VectorStoreRetrieverInput<Neo4jVectorStore>>

Optional filter: string | object

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<Neo4jVectorStore>

close

Returns Promise<void>

createNewIndex

Returns Promise<void>

createNewKeywordIndex

Parameters

textNodeProperties: string[] = []

Returns Promise<void>

delete

Parameters

Optional _params: Record<string, any>

Returns Promise<void>

query

Parameters

query: string

params: any = {}

Returns Promise<any[]>

retrieveExistingFtsIndex

Parameters

Returns undefined | {
[key: string]: string;
}

Returns undefined | {
[key: string]: string;
}

`Optional` metadatas: Record<string, any>[]

`Optional` ids: string[]

`Optional` kOrFields: number | Partial<VectorStoreRetrieverInput<Neo4jVectorStore>>

`Optional` filter: string | object

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

`Optional` _params: Record<string, any>

values: {
[key: string]: any;
}[]

Returns {
[key: string]: any;
}[]

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

`Static` fromExistingGraph

`Static` fromExistingIndex

`Static` fromTexts

`Static` initialize

`Static` lc_name