github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-09-23 03:19:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

experimental[patch]: update module doc strings (#19539)

Browse Source 
Added missed module descriptions. Fixed format.
This commit is contained in:
Leonid Ganeline
2024-03-26 07:38:10 -07:00
committed by GitHub
parent 72ba738bf5
commit 4159a4723c
30 changed files with 154 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
libs/experimental/langchain_experimental/graph_transformers/__init__.py
View File

@@ -1,3 +1,4 @@
"""**Graph Transformers** transform Documents into Graph Documents."""
from langchain_experimental.graph_transformers.diffbot import DiffbotGraphTransformer
from langchain_experimental.graph_transformers.llm import LLMGraphTransformer

22
libs/experimental/langchain_experimental/graph_transformers/llm.py
View File

@@ -143,24 +143,26 @@ def map_to_base_relationship(rel: Any) -> Relationship:
class LLMGraphTransformer:
"""
A class designed to transform documents into graph-based documents using a LLM.
"""Transform documents into graph-based documents using a LLM.
It allows specifying constraints on the types of nodes and relationships to include
in the output graph. The class doesn't support neither extract and node or
relationship properties
Args:
llm (BaseLanguageModel): An instance of a language model supporting structured
output. allowed_nodes (List[str], optional): Specifies which node types are
allowed in the graph. Defaults to an empty list, allowing all node types.
output.
allowed_nodes (List[str], optional): Specifies which node types are
allowed in the graph. Defaults to an empty list, allowing all node types.
allowed_relationships (List[str], optional): Specifies which relationship types
are allowed in the graph. Defaults to an empty list, allowing all relationship
types.
prompt (Optional[ChatPromptTemplate], optional): The prompt to pass to the to
the LLM with additional instructions.
are allowed in the graph. Defaults to an empty list, allowing all relationship
types.
prompt (Optional[ChatPromptTemplate], optional): The prompt to pass to
the LLM with additional instructions.
strict_mode (bool, optional): Determines whether the transformer should apply
filtering to strictly adhere to `allowed_nodes` and `allowed_relationships`.
Defaults to True.
filtering to strictly adhere to `allowed_nodes` and `allowed_relationships`.
Defaults to True.
Example:
.. code-block:: python
from langchain_experimental.graph_transformers import LLMGraphTransformer