Skip to content

relationalai.std.inspect.inspect()

inspect(
    type: Type,
    props: list[str]|None,
    limit: int = 20,
    silent = False
) -> pandas.DataFrame

Gets a pandas DataFrame containing a sample of the objects in type and their statically known properties.

Parameters

Name	Type	Description
`type`	`Type`	The type to inspect.
`props`	`list[str]` or `None`	The properties to inspect. If `None`, inspects all statically known properties.
`limit`	`int`	The maximum number of objects to sample. (Default: 20)

Returns

A pandas Dataframe object.

Example

Use inspect() to get a sample of objects in a Type and their statically known properties:

import relationalai as rai
from relationalai.std.inspect import inspect


# =====
# SETUP
# =====

model = rai.Model("people")
Person = model.Type("Person")

with model.rule():
    Person.add(name="Joe", age=30)
    Person.add(name="Susan", age=32)


# =======
# EXAMPLE
# =======

df = inspect(Person)

print(df)
#                   person   name  age
# 0 aiTt+pn1Y6IexW+u9SgXhg  Susan   32
# 1 ppSccXmTLAgcxu4ZWgcKug    Joe   30

See Also