djai.data.api package

DjAI Data API.

class djai.data.api.AudioDataSet(*args, **kwargs)

Bases: djai.data.models.base._FileDataSetABC

DjAI Audio DataSet class.

class Meta

Bases: djai.data.models.base._FileDataSetABC.Meta

Django Model Class Metadata.

abstract = False

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

global_url: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

local_path: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: django.db.models.fields.BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.CSVDataSet(*args, **kwargs)

Bases: djai.data.models.base._FileDataSetABC

DjAI CSV DataSet class.

class Meta

Bases: djai.data.models.base._FileDataSetABC.Meta

Django Model Class Metadata.

abstract = False

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

global_url: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

local_path: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: django.db.models.fields.BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.DataSchema(*args, **kwargs)

Bases: polymorphic.models.PolymorphicModel, djai.util.models._ModelWithUUIDPKAndOptionalUniqueNameAndTimestampsABC

DjAI DataSchema class.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

created

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

data_sets

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)

get_next_by_modified(*, field=<model_utils.fields.AutoLastModifiedField: modified>, is_next=True, **kwargs)

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)

get_previous_by_modified(*, field=<model_utils.fields.AutoLastModifiedField: modified>, is_next=False, **kwargs)

modified

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name: CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_ctype

The model field that stores the ContentType reference to the actual class.

polymorphic_ctype_id

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

specs

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

uuid: UUIDField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class djai.data.api.DataSet(*args, **kwargs)

Bases: polymorphic.models.PolymorphicModel, djai.util.models._ModelWithUUIDPKAndOptionalUniqueNameAndTimestampsABC

DjAI base DataSet class.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

RELATED_NAME: str = 'data_sets'

RELATED_QUERY_NAME: str = 'data_set'

created

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

get_next_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=True, **kwargs)

get_next_by_modified(*, field=<model_utils.fields.AutoLastModifiedField: modified>, is_next=True, **kwargs)

get_previous_by_created(*, field=<model_utils.fields.AutoCreatedField: created>, is_next=False, **kwargs)

get_previous_by_modified(*, field=<model_utils.fields.AutoLastModifiedField: modified>, is_next=False, **kwargs)

in_db_json_data_sets

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Place.restaurant is a ReverseOneToOneDescriptor instance.

modified

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

name: CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_ctype

The model field that stores the ContentType reference to the actual class.

polymorphic_ctype_id

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

schema: django.db.models.fields.related.ForeignKey

Accessor to the related object on the forward side of a many-to-one or one-to-one (via ForwardOneToOneDescriptor subclass) relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

Child.parent is a ForwardManyToOneDescriptor instance.

schema_id

uuid: UUIDField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

class djai.data.api.HDFDataSet(*args, **kwargs)

Bases: djai.data.models.base._FileDataSetABC

DjAI HDF DataSet class.

class Meta

Bases: djai.data.models.base._FileDataSetABC.Meta

Django Model Class Metadata.

abstract = False

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

global_url: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

local_path: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: django.db.models.fields.BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.ImageDataSet(*args, **kwargs)

Bases: djai.data.models.base._FileDataSetABC

DjAI Image DataSet class.

class Meta

Bases: djai.data.models.base._FileDataSetABC.Meta

Django Model Class Metadata.

abstract = False

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

global_url: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

local_path: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: django.db.models.fields.BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.InDBJSONDataSet(*args, **kwargs)

Bases: djai.data.models.base.DataSet

DjAI In-Database JSON DataSet class.

exception DoesNotExist

Bases: djai.data.models.base.DataSet.DoesNotExist

exception MultipleObjectsReturned

Bases: djai.data.models.base.DataSet.MultipleObjectsReturned

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

in_db_json: django.db.models.fields.json.JSONField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.JSONDataSet(*args, **kwargs)

Bases: djai.data.models.json._FileDataSetWithInDBJSONCacheABC

DjAI JSON DataSet class.

class Meta

Bases: djai.data.models.json._FileDataSetWithInDBJSONCacheABC.Meta

Django Model Class Metadata.

abstract = False

global_url: CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

indbjsondataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

indbjsondataset_ptr_id

local_path: CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.LiveAPIDataSource(*args, **kwargs)

Bases: djai.data.models.base.DataSet

DjAI Image DataSet class.

class Meta

Bases: polymorphic.models.PolymorphicModel.Meta

Django Model Class Metadata.

abstract = False

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.NumPyArray(*args, **kwargs)

Bases: djai.data.models.json._FileDataSetWithInDBJSONCacheABC

DjAI JSON DataSet class.

class Meta

Bases: djai.data.models.json._FileDataSetWithInDBJSONCacheABC.Meta

Django Model Class Metadata.

abstract = False

global_url: CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

indbjsondataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

indbjsondataset_ptr_id

local_path: CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.ORCDataSet(*args, **kwargs)

Bases: djai.data.models.base._FileDataSetABC

DjAI ORC DataSet class.

class Meta

Bases: djai.data.models.base._FileDataSetABC.Meta

Django Model Class Metadata.

abstract = False

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

global_url: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

local_path: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: django.db.models.fields.BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.PandasDataFrame(*args, **kwargs)

Bases: djai.data.models.json._FileDataSetWithInDBJSONCacheABC

DjAI JSON DataSet class.

class Meta

Bases: djai.data.models.json._FileDataSetWithInDBJSONCacheABC.Meta

Django Model Class Metadata.

abstract = False

global_url: CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

indbjsondataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

indbjsondataset_ptr_id

local_path: CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.ParquetDataSet(*args, **kwargs)

Bases: djai.data.models.base._FileDataSetABC

DjAI Parquet DataSet class.

class Meta

Bases: djai.data.models.base._FileDataSetABC.Meta

Django Model Class Metadata.

abstract = False

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

global_url: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

local_path: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: django.db.models.fields.BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.TFRecordDataSet(*args, **kwargs)

Bases: djai.data.models.base._FileDataSetABC

DjAI TFRecord DataSet class.

class Meta

Bases: djai.data.models.base._FileDataSetABC.Meta

Django Model Class Metadata.

abstract = False

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

global_url: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

local_path: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: django.db.models.fields.BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.TextDataSet(*args, **kwargs)

Bases: djai.data.models.base._FileDataSetABC

DjAI Text DataSet class.

class Meta

Bases: djai.data.models.base._FileDataSetABC.Meta

Django Model Class Metadata.

abstract = False

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

global_url: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

local_path: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: django.db.models.fields.BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

class djai.data.api.VideoDataSet(*args, **kwargs)

Bases: djai.data.models.base._FileDataSetABC

DjAI Video DataSet class.

class Meta

Bases: djai.data.models.base._FileDataSetABC.Meta

Django Model Class Metadata.

abstract = False

dataset_ptr

Accessor to the related object on the forward side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

Restaurant.place is a ForwardOneToOneDescriptor instance.

dataset_ptr_id

global_url: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

local_path: django.db.models.fields.CharField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

path_is_dir: django.db.models.fields.BooleanField

A wrapper for a deferred-loading field. When the value is read from this object the first time, the query is executed.

polymorphic_primary_key_name = 'uuid'

polymorphic_super_sub_accessors_replaced = False

Subpackages

• djai.data.api.gql package
• djai.data.api.json package
• djai.data.api.rest package