semantics

relationalai

Build and query RelationalAI semantic models.

The relationalai.semantics package provides a small, composable Python DSL for:

• Creating a Model
• Declaring concepts (entity types) and relationships with Concept and Relationship
• Adding definitions (base data and logic) with define
• Filtering and composing queries with where
• Selecting values with select and materializing results (for example with Fragment.to_df)

Most functions in this module are convenience wrappers. They operate on the single “active” model (the only Model that has been created). For quick interactive use (e.g., notebooks) these convenience wrappers (select, where, etc.) can keep code terse. For larger applications and libraries, prefer calling methods on an explicit model instance (e.g., Model.select, Model.where, and Model.define). This avoids ambiguity if another module (or test) creates a second Model.

In addition to the query helpers, this module re-exports commonly used DSL types such as Concept, Relationship, and Property from frontend.base, as well as core value types such as Any, semantics.frontend.core.String, and semantics.frontend.core.Number from frontend.core.

Examples

Create a semantic model:

>>> from relationalai.semantics import Model, define, select, where, String, Integer
>>> m = Model()

Declare a Person concept:

>>> Person = m.Concept("Person")

Declare properties on Person:

>>> Person.name = m.Property(f"{Person} is named {String:name}")
>>> Person.age = m.Property(f"{Person} is {Integer:age} years old")

Define some Person entities:

>>> define(
...     Person.new(name="Alice", age=10),
...     Person.new(name="Bob", age=30),
... )

Select names of people over 18:

>>> where(Person.age > 18).select(Person.name).to_df()

Attributes

Attributes exposed by this module.

Value Union of value types. Re-exported from relationalai.semantics.frontend.base.

Any A concept type that matches any value. Re-exported from relationalai.semantics.frontend.core.

AnyEntity A concept type that matches any entity. Re-exported from relationalai.semantics.frontend.core.

Number A concept type for decimal numbers. Re-exported from relationalai.semantics.frontend.core.

String A concept type for string values. Re-exported from relationalai.semantics.frontend.core.

Integer The integer number type, `Number(38, 0). Re-exported from relationalai.semantics.frontend.core`.

Int Alias for semantics.frontend.core.Integer. Re-exported from relationalai.semantics.frontend.core.

Int64 The 64-bit integer number type, `Number(19, 0). Re-exported from relationalai.semantics.frontend.core`.

Int128 Alias for semantics.frontend.core.Integer. Re-exported from relationalai.semantics.frontend.core.

Float A concept type for floating-point numeric values. Re-exported from relationalai.semantics.frontend.core.

Decimal Alias for semantics.frontend.core.DefaultNumber. Re-exported from relationalai.semantics.frontend.core.

Bool Alias for semantics.frontend.core.Boolean. Re-exported from relationalai.semantics.frontend.core.

Boolean A concept type for boolean values. Re-exported from relationalai.semantics.frontend.core.

Date A concept type for date values. Re-exported from relationalai.semantics.frontend.core.

DateTime A concept type for date-time values. Re-exported from relationalai.semantics.frontend.core.

Error A core Concept for emitting errors. Re-exported from relationalai.semantics.frontend.core.

Functions

Functions exposed by this module.

select() Return a selection fragment from the active model.

define() Add definitions (facts and logic) to the active model.

where() Return a fragment filtered by the given conditions.

require() Add requirements (constraints) to the active model.

union() Combine items with a logical OR or a set-style union.

data() Create a temporary table from in-memory Python or pandas data.

distinct() Mark values as distinct (unique) for use in select and aggregates.

not_() Return a negated condition for use in query filters.

Classes

Classes exposed by this module.

Alias Represents a DSL value labeled with an output alias. Re-exported from relationalai.semantics.frontend.base.

Concept Represents an entity type (concept) in a semantic model. Re-exported from relationalai.semantics.frontend.base.

Data Represents a temporary table backed by in-memory data. Re-exported from relationalai.semantics.frontend.base.

Distinct Represents a "distinct" wrapper for values in a query. Re-exported from relationalai.semantics.frontend.base.

Expression Represents an expression in the DSL. Re-exported from relationalai.semantics.frontend.base.

Field Describe one named field in a relationship or property. Re-exported from relationalai.semantics.frontend.base.

FieldRef Refer to a specific field of a relationship. Re-exported from relationalai.semantics.frontend.base.

Fragment Represents a composable query or rule fragment. Re-exported from relationalai.semantics.frontend.base.

Literal Wrap a Python value so it can be used in DSL expressions. Re-exported from relationalai.semantics.frontend.base.

Match Represents a left-to-right fallback across alternative branches. Re-exported from relationalai.semantics.frontend.base.

Model Create and manage a semantic model. Re-exported from relationalai.semantics.frontend.base.

New Represents a "new entity" statement for a concept. Re-exported from relationalai.semantics.frontend.base.

Not Represents a negated condition for use in query filters. Re-exported from relationalai.semantics.frontend.base.

Chain Represents a chained relationship path created by attribute access. Re-exported from relationalai.semantics.frontend.base.

Property Represents a single-valued attribute on entities. Re-exported from relationalai.semantics.frontend.base.

Reading Represents an alternative reading for a relationship. Re-exported from relationalai.semantics.frontend.base.

Relationship Represents a relationship between entities in a semantic model. Re-exported from relationalai.semantics.frontend.base.

Table Represents an external table reference in a semantic model. Re-exported from relationalai.semantics.frontend.base.

Union Represents a logical OR / union across multiple branches. Re-exported from relationalai.semantics.frontend.base.

Variable Represents a composable value in the semantics DSL. Re-exported from relationalai.semantics.frontend.base.

Modules and Subpackages

Submodules and subpackages available under this namespace.

frontend User-facing frontend for the semantics DSL.

std The RelationalAI Semantics Standard Library.

reasoners The RelationalAI Semantics Reasoners Module.