| title | create_graph |
|---|---|
| description | Create a graph from documents |
name(str): Name of the graph to createfilters(Dict[str, Any], optional): Optional metadata filters to determine which documents to includedocuments(List[str], optional): Optional list of specific document IDs to includeprompt_overrides(GraphPromptOverrides | Dict[str, Any], optional): Optional customizations for entity extraction and resolution promptsfolder_name(str | List[str], optional): Optional folder scope (canonical path or list of paths/names)end_user_id(str, optional): Optional end-user scope
Calling create_graph now returns a placeholder Graph immediately.
graph(Graph): Graph stub withsystem_metadata["status"] = "processing". Entities and relationships will be empty until processing completes.
Use db.wait_for_graph_completion("<name>") (sync) or
await db.wait_for_graph_completion("<name>") (async) to block until the
graph is done, or poll graph.is_processing / graph.is_completed.
db = Morphik()
# Start graph creation – returns immediately with status "processing"
graph = db.create_graph(
name="research_graph",
filters={"category": "research"},
folder_name="/projects/alpha",
)
# Option 1: Block until finished
graph = db.wait_for_graph_completion("research_graph")
# Option 2: Poll periodically
while graph.is_processing:
time.sleep(10)
graph = db.get_graph("research_graph")
print("Entities:", len(graph.entities))
# Create a graph from specific documents
graph = db.create_graph(
name="custom_graph",
documents=["doc1", "doc2", "doc3"]
)
# With custom entity extraction examples
from morphik.models import EntityExtractionPromptOverride, EntityExtractionExample, GraphPromptOverrides
# Example with only entity extraction examples
graph = db.create_graph(
name="medical_graph",
filters={"category": "medical"},
prompt_overrides=GraphPromptOverrides(
entity_extraction=EntityExtractionPromptOverride(
examples=[
EntityExtractionExample(label="Insulin", type="MEDICATION"),
EntityExtractionExample(label="Diabetes", type="CONDITION")
]
)
)
)
# Example with custom entity extraction prompt template and examples
graph = db.create_graph(
name="financial_graph",
documents=["doc1", "doc2"],
prompt_overrides=GraphPromptOverrides(
entity_extraction=EntityExtractionPromptOverride(
prompt_template="Extract financial entities from the following text:\n\n{content}\n\nFocus on these types of entities:\n{examples}\n\nReturn in JSON format.",
examples=[
EntityExtractionExample(label="Apple Inc.", type="COMPANY", properties={"sector": "Technology"}),
EntityExtractionExample(label="Q3 2024", type="TIME_PERIOD"),
EntityExtractionExample(label="Revenue Growth", type="METRIC")
]
),
entity_resolution=EntityResolutionPromptOverride(
examples=[
EntityResolutionExample(
canonical="Apple Inc.",
variants=["Apple", "AAPL", "Apple Computer"]
)
]
)
)
)
print(f"Created graph with {len(graph.entities)} entities and {len(graph.relationships)} relationships")
```
async with AsyncMorphik() as db:
# Start graph creation (returns quickly)
graph = await db.create_graph(
name="research_graph",
filters={"category": "research"},
folder_name="/projects/alpha",
)
# Wait for completion
graph = await db.wait_for_graph_completion("research_graph")
print("Entities:", len(graph.entities))
# Create a graph from documents with category="research"
graph = await db.create_graph(
name="research_graph",
filters={"category": "research"}
)
# Create a graph from specific documents
graph = await db.create_graph(
name="custom_graph",
documents=["doc1", "doc2", "doc3"]
)
# With custom entity extraction examples
from morphik.models import EntityExtractionPromptOverride, EntityExtractionExample, GraphPromptOverrides
# Example with only entity extraction examples
graph = await db.create_graph(
name="medical_graph",
filters={"category": "medical"},
prompt_overrides=GraphPromptOverrides(
entity_extraction=EntityExtractionPromptOverride(
examples=[
EntityExtractionExample(label="Insulin", type="MEDICATION"),
EntityExtractionExample(label="Diabetes", type="CONDITION")
]
)
)
)
# Example with custom entity extraction prompt template and examples
graph = await db.create_graph(
name="financial_graph",
documents=["doc1", "doc2"],
prompt_overrides=GraphPromptOverrides(
entity_extraction=EntityExtractionPromptOverride(
prompt_template="Extract financial entities from the following text:\n\n{content}\n\nFocus on these types of entities:\n{examples}\n\nReturn in JSON format.",
examples=[
EntityExtractionExample(label="Apple Inc.", type="COMPANY", properties={"sector": "Technology"}),
EntityExtractionExample(label="Q3 2024", type="TIME_PERIOD"),
EntityExtractionExample(label="Revenue Growth", type="METRIC")
]
),
entity_resolution=EntityResolutionPromptOverride(
examples=[
EntityResolutionExample(
canonical="Apple Inc.",
variants=["Apple", "AAPL", "Apple Computer"]
)
]
)
)
)
print(f"Created graph with {len(graph.entities)} entities and {len(graph.relationships)} relationships")
```
The returned Graph object has the following properties:
id(str): Unique graph identifiername(str): Graph nameentities(List[Entity]): List of entities in the graphrelationships(List[Relationship]): List of relationships in the graphmetadata(Dict[str, Any]): Graph metadatadocument_ids(List[str]): Source document IDsfilters(Dict[str, Any], optional): Document filters used to create the graphcreated_at(datetime): Creation timestampupdated_at(datetime): Last update timestampowner(Dict[str, str]): Graph owner informationfolder_path(Optional[str]): Canonical folder path for the graph (if scoped)