Lesson 3: Features
These code samples provide a basic introduction on on setting and getting Features on entities. For an in-depth description of Features and their role in Avial modeling, please visit our wiki <https://docs.ledr.io/en/the-orchestra-platfrom/avial-model#features>
Set Features on Person Entity
- module.utils.set_person_features.set_feature(person_entity: AvEntity, home_address: str, work_address: str, auth: AvAuthorization)[source]
A person can have multiple addresses. Features, Facets/Factors & Factors, and Frames are Avial constructs that can be used to add additional attributes to a Fact. This function shows how facets and factors can be used for multiple addresses. When to use Features, facets, or Frames is a modeling discussion and not applicable to this lesson.
- Parameters:
person_entity – The entity ID of the person entity to add the feature.
home_address – Person’s home address.
work_address – Person’s work address.
auth – The Orchestra server authorization that allows entity operations.
How to get Features From Entities
- module.utils.how_to_get_features_from_entities.examples_of_get_features_by_brute_force(entity: AvEntity, auth: AvAuthorization)[source]
This function shows how to get features from an entity, by specifying which attributes you want to get.
- Parameters:
entity – The entity ID of the entity to get the facts.
auth – The Orchestra server authorization that allows entity operations.
- module.utils.how_to_get_features_from_entities.examples_of_get_features_by_retrieve(entity: AvEntity, attribute: AxAttribute, auth: AvAuthorization)[source]
This function shows how to get features from an entity. Its extremely helpful when you don’t actually know what facts are in an entity or need to iterate though the facts.
- Parameters:
entity – The entity ID of the entity to get the facts.
attribute – The attribute of the entity to obtain the features for.
auth – The Orchestra server authorization that allows entity operations.