RelationalAI Python API Reference#

This section contains reference documentation for the RelationalAI Python API.

relationalai#

The relationalai namespace contains classes for fundamental concepts, including the Model, Type, and Producer classes.

• Model
  • .export()
  • .found()
  • .name
  • .not_found()
  • .match()
  • .query()
  • .rule()
  • .case()
  • .Type()
• Type
  • .__call__()
  • .__or__()
  • .add()
  • .extend()
  • .known_properties()
  • .model
  • .name
• Producer
  • .__add__()
  • .__enter__()
  • .__eq__()
  • .__exit__()
  • .__floordiv__()
  • .__ge__()
  • .__getattribute__()
  • .__gt__()
  • .__le__()
  • .__lt__()
  • .__mod__()
  • .__mul__()
  • .__ne__()
  • .__radd__()
  • .__rfloordiv__()
  • .__rmod__()
  • .__rmul__()
  • .__rsub__()
  • .__rtruediv__()
  • .__sub__()
  • .__truediv__()
• Instance
  • .set()
• Property
• InstanceProperty
  • .add()
  • .choose()
  • .extend()
  • .has_value()
  • .in_()
  • .or_()
  • .set()
• Expression
• Context
  • .__enter__()
  • .__exit__()
  • .model
  • .results
• ContextSelect
  • .add()
  • .__call__()
  • .__getattribute__()

relationalai.std#

The relationalai.std namespace contains the RelationalAI Query Builder Standard Library. This includes functions for performing aggregations as well as classes for creating and working with graphs.

• alias()
• Vars

relationalai.std.aggregates#

• avg()
• bottom()
• count()
• max()
• min()
• rank_asc()
• rank_desc()
• sum()
• top()

relationalai.std.dates#

• Date()
• DateTime()
• date()
• date.fromdatetime()
• date.fromordinal()
• date_add()
• date_range()
• date_subtract()
• datetime()
• datetime.fromdate()
• datetime.fromordinal()
• day()
• days()
• dayofyear()
• hour()
• hours()
• isoweekday()
• microseconds()
• milliseconds()
• minute()
• minutes()
• month()
• months()
• nanoseconds()
• quarter()
• second()
• seconds()
• week()
• weekday()
• year()
• years()

relationalai.std.graphs#

• Graph
  • .compute
  • .Edge
  • .fetch()
  • .id
  • .model
  • .Node
  • .undirected
  • .visualize()
• Edge
  • .add()
  • .extend()
• EdgeInstance
  • .from_
  • .to
  • .set()
• Compute
  • .adamic_adar()
  • .avg_clustering_coefficient()
  • .avg_degree()
  • .avg_indegree()
  • .avg_outdegree()
  • .betweenness_centrality()
  • .cosine_similarity()
  • .common_neighbor()
  • .degree_centrality()
  • .degree()
  • .diameter_range()
  • .distance()
  • .eigenvector_centrality()
  • .indegree()
  • .is_connected()
  • .is_reachable()
  • .is_triangle()
  • .label_propagation()
  • .local_clustering_coefficient()
  • .louvain()
  • .max_degree()
  • .max_indegree()
  • .max_outdegree()
  • .min_degree()
  • .min_indegree()
  • .min_outdegree()
  • .num_edges()
  • .num_nodes()
  • .num_triangles()
  • .outdegree()
  • .pagerank()
  • .preferential_attachment()
  • .reachable_from()
  • .triangles()
  • .weakly_connected_component()
  • .weighted_distance()
  • .weighted_cosine_similarity()
  • .weighted_degree_centrality()
  • .weighted_jaccard_similarity()

relationalai.std.math#

• abs()
• acos()
• asin()
• atan()
• isclose()
• ceil()
• cbrt()
• cos()
• degrees()
• floor()
• log()
• radians()
• sign()
• sin()
• sqrt()
• tan()
• trunc_divide()

relationalai.std.strings#

• concat()
• contains()
• ends_with()
• join()
• length()
• like()
• lowercase()
• regex_compile()
• regex_match()
• replace()
• split()
• split_part()
• uppercase()