oso.framework.data namespace

Submodules

oso.framework.data.types module

OSO Datatypes.

class oso.framework.data.types.ComponentStatus(*, status_code: int, status: str, errors: list[~oso.framework.data.types.V1_3.Error] = <factory>, **extra_data: ~typing.Any)

Bases: BaseModel

Component Status.

status_code

A HTTP status code.

Type:

int

status

A human readable message about the status.

Type:

str

errors

A list of errors

Type:

list[.Error], default=[]

class oso.framework.data.types.Document(*, id: str, content: str, metadata: str | None = None)

Bases: BaseModel

Document.

id

Document ID.

Type:

str

content

Document content.

Type:

str

metadata

Document metadata.

Type:

str | None, default=None

classmethod validate_metadata(metadata: str | None) → str

Fill metadata with empty string, if empty.

class oso.framework.data.types.DocumentList(*, documents: list[~oso.framework.data.types.V1_3.Document] = <factory>, count: int)

Bases: BaseModel

Document List.

documents

A list of `.Document`s.

Type:

list[.Document], default=[]

count

A count of documents.

Type:

int

class oso.framework.data.types.Error(*, code: str, message: str)

Bases: BaseModel

Error.

code

A searchable code of the error.

Type:

str

message

A human readable message about the error.

Type:

str

class oso.framework.data.types.V1_3

Bases: object

Version 1.3.

class ComponentStatus(*, status_code: int, status: str, errors: list[~oso.framework.data.types.V1_3.Error] = <factory>, **extra_data: ~typing.Any)

Bases: BaseModel

Component Status.

status_code

A HTTP status code.

Type:

int

status

A human readable message about the status.

Type:

str

errors

A list of errors

Type:

list[.Error], default=[]

class Document(*, id: str, content: str, metadata: str | None = None)

Bases: BaseModel

Document.

id

Document ID.

Type:

str

content

Document content.

Type:

str

metadata

Document metadata.

Type:

str | None, default=None

classmethod validate_metadata(metadata: str | None) → str

Fill metadata with empty string, if empty.

class DocumentList(*, documents: list[~oso.framework.data.types.V1_3.Document] = <factory>, count: int)

Bases: BaseModel

Document List.

documents

A list of `.Document`s.

Type:

list[.Document], default=[]

count

A count of documents.

Type:

int

class Error(*, code: str, message: str)

Bases: BaseModel

Error.

code

A searchable code of the error.

Type:

str

message

A human readable message about the error.

Type:

str