ahvn.ukf.templates.basic.document module

class ahvn.ukf.templates.basic.document.DocumentUKFT(*, name, notes='', short_description='', description='', type='general', version='v0.1.0', version_notes='', variant='default', variant_notes='', content='', content_resources=<factory>, content_composers=<factory>, source='unknown', parents=<factory>, creator='unknown', owner='unknown', workspace='unknown', collection='general', tags=<factory>, synonyms=<factory>, triggers=<factory>, priority=0, related=<factory>, auths=<factory>, timefluid=False, timestamp=<factory>, last_verified=<factory>, expiration=-1, inactive_mark=False, metadata=<factory>, profile=<factory>)

Bases: BaseUKF

Document (chunks) entity for storing text-based information.

UKF Type: document Recommended Components of content_resources:

None

Recommended Composers:

Any

Parameters:

• name (UKFMediumTextType)

• notes (UKFMediumTextType)

• short_description (UKFMediumTextType)

• description (UKFMediumTextType)

• type (UKFShortTextType)

• version (UKFShortTextType)

• version_notes (UKFMediumTextType)

• variant (UKFShortTextType)

• variant_notes (UKFMediumTextType)

• content (UKFLongTextType)

• content_resources (UKFJsonType)

• content_composers (UKFJsonType)

• source (UKFShortTextType)

• parents (UKFJsonType)

• creator (UKFShortTextType)

• owner (UKFShortTextType)

• workspace (UKFShortTextType)

• collection (UKFShortTextType)

• tags (UKFTagsType)

• synonyms (UKFSynonymsType)

• triggers (UKFJsonType)

• priority (UKFIntegerType)

• related (UKFRelatedType)

• auths (UKFAuthsType)

• timefluid (UKFBooleanType)

• timestamp (UKFTimestampType)

• last_verified (UKFTimestampType)

• expiration (UKFDurationType)

• inactive_mark (UKFBooleanType)

• metadata (UKFJsonType)

• profile (UKFJsonType)

type_default: ClassVar[str] = 'document'

model_config = {'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self (BaseModel) – The BaseModel instance.

• context (Any) – The context.

Return type:

None