Class GraphCypherQAChain

Chain for question-answering against a graph by generating Cypher statements.

Example

const chain = new GraphCypherQAChain({
  llm: new ChatOpenAI({ model: "gpt-4o-mini", temperature: 0 }),
  graph: new Neo4jGraph(),
});
const res = await chain.invoke("Who played in Pulp Fiction?");

Security

This chain will execute Cypher statements against the provided database. 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.

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

Hierarchy (View Summary)

BaseChain
- GraphCypherQAChain

Index

Constructors

constructor

new GraphCypherQAChain(props: GraphCypherQAChainInput): GraphCypherQAChain
Parameters
- props: GraphCypherQAChainInput
Returns GraphCypherQAChain
Overrides BaseChain.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/graph_qa/cypher.ts:83

Properties

`Optional`memory

memory?: any

Accessors

inputKeys

get inputKeys(): string[]
Returns string[]
Overrides BaseChain.inputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/graph_qa/cypher.ts:121

lc_namespace

get lc_namespace(): string[]
Returns string[]
Inherited from QAEvalChain.lc_namespace
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:41

outputKeys

get outputKeys(): string[]
Returns string[]
Overrides BaseChain.outputKeys
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/graph_qa/cypher.ts:125

Methods

_call

_call(values: ChainValues, runManager?: any): Promise<ChainValues>
Run the core logic of this chain and return the output
Parameters
- values: ChainValues
- OptionalrunManager: any
Returns Promise<ChainValues>
Overrides BaseChain._call
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/graph_qa/cypher.ts:182

_chainType

_chainType(): "graph_cypher_chain"
Return the string type key uniquely identifying this class of chain.

Returns "graph_cypher_chain"
Overrides BaseChain._chainType
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/graph_qa/cypher.ts:117

`Protected`_formatValues

_formatValues(values: any): Promise<any>
Parameters
- values: any
Returns Promise<any>
Inherited from BaseChain._formatValues
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:217

apply

apply(inputs: ChainValues[], config?: any[]): Promise<ChainValues[]>
Parameters
- inputs: ChainValues[]
- Optionalconfig: any[]
Returns Promise<ChainValues[]>
Deprecated
Use .batch() instead. Will be removed in 0.2.0.

Call the chain on all inputs in the list
Inherited from BaseChain.apply
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:258

call

call(values: any, config?: any, tags?: string[]): Promise<ChainValues>
Parameters
- values: any
- Optionalconfig: any
- Optionaltags: string[]
  Deprecated
Returns Promise<ChainValues>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.

Run the core logic of this chain and add to output if desired.

Wraps _call and handles memory.
Inherited from BaseChain.call
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:243

invoke

invoke(input: ChainValues, options?: any): Promise<ChainValues>
Invoke the chain with the provided input and returns the output.
Parameters
- input: ChainValues
  Input values for the chain run.
- Optionaloptions: any
Returns Promise<ChainValues>
Promise that resolves with the output of the chain run.
Inherited from BaseChain.invoke
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:86

prepOutputs

prepOutputs(
    inputs: Record<string, unknown>,
    outputs: Record<string, unknown>,
    returnOnlyOutputs?: boolean,
): Promise<Record<string, unknown>>
Parameters
- inputs: Record<string, unknown>
- outputs: Record<string, unknown>
- returnOnlyOutputs: boolean = false
Returns Promise<Record<string, unknown>>
Inherited from BaseChain.prepOutputs
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:149

run

run(input: any, config?: any): Promise<string>
Parameters
- input: any
- Optionalconfig: any
Returns Promise<string>
Deprecated
Use .invoke() instead. Will be removed in 0.2.0.
Inherited from BaseChain.run
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:190

serialize

serialize(): SerializedBaseChain
Return a json-like object representing this chain.

Returns SerializedBaseChain
Inherited from BaseChain.serialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:181

`Static`deserialize

deserialize(
data: SerializedBaseChain,
values?: LoadValues,
): Promise<BaseChain<ChainValues, ChainValues>>
Load a chain from a json-like object describing it.
Parameters
- data: SerializedBaseChain
- values: LoadValues = {}
Returns Promise<BaseChain<ChainValues, ChainValues>>
Inherited from BaseChain.deserialize
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/base.ts:270

`Static`fromLLM

fromLLM(props: FromLLMInput): GraphCypherQAChain
Parameters
- props: FromLLMInput
Returns GraphCypherQAChain
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain/src/chains/graph_qa/cypher.ts:129

Class GraphCypherQAChain

Example

Security

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GraphCypherQAChain

Properties

Optionalmemory

Accessors

inputKeys

Returns string[]

lc_namespace

Returns string[]

outputKeys

Returns string[]

Methods

_call

Parameters

Returns Promise<ChainValues>

_chainType

Returns "graph_cypher_chain"

Protected_formatValues

Parameters

Returns Promise<any>

apply

Parameters

Returns Promise<ChainValues[]>

Deprecated

call

Parameters

Deprecated

Returns Promise<ChainValues>

Deprecated

invoke

Parameters

Returns Promise<ChainValues>

prepOutputs

Parameters

Returns Promise<Record<string, unknown>>

run

Parameters

Returns Promise<string>

Deprecated

serialize

Returns SerializedBaseChain

Staticdeserialize

Parameters

Returns Promise<BaseChain<ChainValues, ChainValues>>

StaticfromLLM

Parameters

Returns GraphCypherQAChain

Settings

On This Page

`Optional`memory

`Protected`_formatValues

`Static`deserialize

`Static`fromLLM