caikit.interfaces.common.data_model.stream_sources

This file contains interfaces required to generate DataStreamSource[T] classes

Classes

FileReference

A DataObject is a data model class that is backed by a @dataclass.

ListOfFileReferences

A DataObject is a data model class that is backed by a @dataclass.

Directory

A DataObject is a data model class that is backed by a @dataclass.

S3Base

A DataObject is a data model class that is backed by a @dataclass.

S3Files

A DataObject is a data model class that is backed by a @dataclass.

S3Path

A DataObject is a data model class that is backed by a @dataclass.

Module Contents

class caikit.interfaces.common.data_model.stream_sources.FileReference[source]

Bases: caikit.core.data_model.DataObjectBase

A DataObject is a data model class that is backed by a @dataclass.

Data model classes that use the @dataobject decorator must derive from this base class.

filename: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]
class caikit.interfaces.common.data_model.stream_sources.ListOfFileReferences[source]

Bases: caikit.core.data_model.DataObjectBase

A DataObject is a data model class that is backed by a @dataclass.

Data model classes that use the @dataobject decorator must derive from this base class.

files: py_to_proto.dataclass_to_proto.Annotated[List[str], FieldNumber(1)]
class caikit.interfaces.common.data_model.stream_sources.Directory[source]

Bases: caikit.core.data_model.DataObjectBase

A DataObject is a data model class that is backed by a @dataclass.

Data model classes that use the @dataobject decorator must derive from this base class.

dirname: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]
extension: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(2)]
class caikit.interfaces.common.data_model.stream_sources.S3Base[source]

Bases: caikit.core.data_model.DataObjectBase

A DataObject is a data model class that is backed by a @dataclass.

Data model classes that use the @dataobject decorator must derive from this base class.

endpoint: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(2)]
region: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(3)]
bucket: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(4)]
accessKey: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(5)]
secretKey: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(6)]
IAM_id: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(7)]
IAM_api_key: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(8)]
class caikit.interfaces.common.data_model.stream_sources.S3Files[source]

Bases: S3Base

A DataObject is a data model class that is backed by a @dataclass.

Data model classes that use the @dataobject decorator must derive from this base class.

files: py_to_proto.dataclass_to_proto.Annotated[List[str], FieldNumber(1)]
class caikit.interfaces.common.data_model.stream_sources.S3Path[source]

Bases: S3Base

A DataObject is a data model class that is backed by a @dataclass.

Data model classes that use the @dataobject decorator must derive from this base class.

path: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]