Toggle Menu
Prev Up Next

# `langchain_community.graphs.neo4j_graph`.Neo4jGraph

class langchain_community.graphs.neo4j_graph.Neo4jGraph(url: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None, database: Optional[str] = None, timeout: Optional[float] = None, sanitize: bool = False, refresh_schema: bool = True, *, driver_config: Optional[Dict] = None, enhanced_schema: bool = False)

  Neo4j database wrapper for various graph operations.

  Parameters: url (Optional[str]): The URL of the Neo4j database server. username (Optional[str]): The username for database authentication. password (Optional[str]): The password for database authentication. database (str): The name of the database to connect to. Default is ‘neo4j’. timeout (Optional[float]): The timeout for transactions in seconds.

  > Useful for terminating long-running queries. By default, there is no timeout set.

  sanitize (bool): A flag to indicate whether to remove lists with

    more than 128 elements from results. Useful for removing embedding-like properties from database responses. Default is False.

  refresh_schema (bool): A flag whether to refresh schema information

    at initialization. Default is True.

  enhanced_schema (bool): A flag whether to scan the database for

    example values and use them in the graph schema. Default is False.

  driver_config (Dict): Configuration passed to Neo4j Driver.

  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.

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

  Create a new Neo4j graph wrapper instance.

  Attributes

  `get_schema` | Returns the schema of the Graph
  `get_structured_schema` | Returns the structured schema of the Graph

  Methods

  `__init__`([url, username, password, ...]) | Create a new Neo4j graph wrapper instance.
  `add_graph_documents`(graph_documents[, ...]) | This method constructs nodes and relationships in the graph based on the provided GraphDocument objects.
  `query`(query[, params]) | Query Neo4j database.
  `refresh_schema`() | Refreshes the Neo4j graph schema information.

  Parameters

    - url (Optional[str]) –

    - username (Optional[str]) –

    - password (Optional[str]) –

    - database (Optional[str]) –

    - timeout (Optional[float]) –

    - sanitize (bool) –

    - refresh_schema (bool) –

    - driver_config (Optional[Dict]) –

    - enhanced_schema (bool) –

  __init__(url: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None, database: Optional[str] = None, timeout: Optional[float] = None, sanitize: bool = False, refresh_schema: bool = True, *, driver_config: Optional[Dict] = None, enhanced_schema: bool = False) → None

    Create a new Neo4j graph wrapper instance.

    Parameters

      - url (Optional[str]) –

      - username (Optional[str]) –

      - password (Optional[str]) –

      - database (Optional[str]) –

      - timeout (Optional[float]) –

      - sanitize (bool) –

      - refresh_schema (bool) –

      - driver_config (Optional[Dict]) –

      - enhanced_schema (bool) –

    Return type

      None

  add_graph_documents(graph_documents: List[GraphDocument], include_source: bool = False, baseEntityLabel: bool = False) → None

    This method constructs nodes and relationships in the graph based on the provided GraphDocument objects.

    Parameters: - graph_documents (List[GraphDocument]): A list of GraphDocument objects that contain the nodes and relationships to be added to the graph. Each GraphDocument should encapsulate the structure of part of the graph, including nodes, relationships, and the source document information. - include_source (bool, optional): If True, stores the source document and links it to nodes in the graph using the MENTIONS relationship. This is useful for tracing back the origin of data. Merges source documents based on the id property from the source document metadata if available; otherwise it calculates the MD5 hash of page_content for merging process. Defaults to False. - baseEntityLabel (bool, optional): If True, each newly created node gets a secondary __Entity__ label, which is indexed and improves import speed and performance. Defaults to False.

    Parameters

      - graph_documents (List[GraphDocument]) –

      - include_source (bool) –

      - baseEntityLabel (bool) –

    Return type

      None

  query(query: str, params: dict = {}) → List[Dict[str, Any]]

    Query Neo4j database.

    Parameters

      - query (str) –

      - params (dict) –

    Return type

      List[Dict[str, Any]]

  refresh_schema() → None

    Refreshes the Neo4j graph schema information.

    Return type

      None

# Examples using Neo4jGraph

- How many people played in Top Gun?

- Neo4j

- Uncomment the below to use LangSmith. Not required.

- diffbot.md