graphrag_sdk.schema package

Submodules

graphrag_sdk.schema.auto_detect module

graphrag_sdk.schema.auto_detect.convert_table(s, client, model, tbl, columns, foreign_keys)

graphrag_sdk.schema.auto_detect.convert_tables(s, client, model, inspector, table_names)

graphrag_sdk.schema.auto_detect.create_entity(s, client, model, name: str, columns) → None

graphrag_sdk.schema.auto_detect.create_entity_with_relation(s, client, model, name: str, columns, foreign_keys) → None

graphrag_sdk.schema.auto_detect.create_relation(s, name: str, foreign_keys)

graphrag_sdk.schema.auto_detect.generate_graph_schema(s, client, model)

graphrag_sdk.schema.auto_detect.get_assistant(client, assistant_name, model)

graphrag_sdk.schema.auto_detect.handle_run(client, run, queue)

graphrag_sdk.schema.auto_detect.initiate_interaction(client, assistant, user_message)

graphrag_sdk.schema.auto_detect.process_source(client, assistant, src, queue)

graphrag_sdk.schema.auto_detect.run_sql(arg, queue)

graphrag_sdk.schema.auto_detect.schema_auto_detect(schema, sources, model='gpt-3.5-turbo-0125')

graphrag_sdk.schema.auto_detect.sqlalchemy_to_python_type(sqlalchemy_type)

graphrag_sdk.schema.decoder module

class graphrag_sdk.schema.decoder.SchemaDecoder

Bases: object

decode(schema, data: dict)

from_JSON(schema, json: str)

graphrag_sdk.schema.encoder module

class graphrag_sdk.schema.encoder.SchemaEncoder

Bases: object

encode(schema) → dict

to_JSON(schema) → str

graphrag_sdk.schema.entity module

class graphrag_sdk.schema.entity.Attribute(name: str, type: type, desc=None, unique=False, mandatory=False)

Bases: object

class graphrag_sdk.schema.entity.Entity(name: str)

Bases: object

Represents an ontolegy entity

add_attribute(name: str, type: type, desc: str | None = None, unique: bool = False, mandatory: bool = False) → Entity

Add attribute to entity

Parameters:

name (str): attribute name type (type): attribute type desc (str): short description for attribute unique (bool): is the attribute value unique mandatory (bool): is the attribute mandatory

Returns:

Entity

get_attribute(name: str) → Attribute | None

Get attribute

Parameters:

name (str): name of attribute to get

Returns:

attribute

remove_attribute(name: str) → Entity

Remove attribute from entity

Parameters:

name (str): name of attribute to remove

Returns:

Entity

unique_attributes() → list[Attribute]

Get a list of Entity’s unique attributes

Returns:

list of unique attributes

graphrag_sdk.schema.from_graph module

graphrag_sdk.schema.from_graph.schema_from_graph(s, g: Graph)

graphrag_sdk.schema.functions_gen module

graphrag_sdk.schema.functions_gen.entity_to_create_func(e: Entity)

graphrag_sdk.schema.functions_gen.relation_to_create_func(r: Relation)

graphrag_sdk.schema.functions_gen.schema_to_functions(s: Schema)

graphrag_sdk.schema.relation module

class graphrag_sdk.schema.relation.Relation(name: str, src: Entity, dest: Entity)

Bases: object

graphrag_sdk.schema.schema module

class graphrag_sdk.schema.schema.Schema

Bases: object

Knowledge Graph schema (ontology) The schema captures entities types in addition to their attributes and the relationship types between the them

add_entity(name: str) → Entity

Add a new entity to schema

Parameters:

name (str): Entity name.

Returns:

entity

add_relation(name: str, src: Entity, dest: Entity) → Relation

Add a relationship to schema

Returns:

relation

classmethod auto_detect(sources: list[AbstractSource], model='gpt-3.5-turbo-0125') → Schema

Auto detect schema from sources

Parameters:

sources (list[AbstractSource]): list of sources to extract schema from model (str): OpenAI model to use

Returns:

Schema: schema

classmethod from_JSON(json: str) → Schema

Create a schema from JSON

Parameters:

json (str): the output from to_JSON

Returns:

Schema: schema

classmethod from_graph(g: Graph) → Schema

Create a schema from an ontology graph

Parameters:

g (Graph): ontology graph to load

Returns:

Schema: schema

get_entity(name: str) → Entity | None

Get an entity from schema

Returns:

entity

save_graph(g: Graph) → None

Save schema as an ontology graph

Parameters:

g (Graph): graph to create

to_JSON() → str

Encode schema to JSON string

Returns:

JSON representation of schema

validate() → bool

Validate schema

Returns:

True if schema is valid

graphrag_sdk.schema.to_graph module

graphrag_sdk.schema.to_graph.schema_to_graph(s, g: Graph) → None

graphrag_sdk.schema.tools_gen module

graphrag_sdk.schema.tools_gen.entity_to_tool(e: Entity)

graphrag_sdk.schema.tools_gen.relation_to_tool(r: Relation)

graphrag_sdk.schema.tools_gen.schema_to_tools(s: Schema)

graphrag_sdk.schema.tools_gen.type_mapping(t) → str

Module contents