xpressinsight.types.Column.__init__
xpressinsight.types.Column.__init__(self, name: str, dtype: Type[BasicType], alias: str = '', format: str = '', hidden: Hidden = Hidden.FALSE, manage: Manage = Manage.INPUT, read_only: bool = False, transform_labels_entity: str = '', update_after_execution: bool = False, *, update_keep_result_data: bool = False, update_progress: bool = False, default: Union[bool, float, int, str] = None, entity_name: str = None)
|
name
|
The name of the column.
|
|
dtype
|
The data type.
|
|
alias
|
Used to provide an alternative name for an entity in the UI. The value is used in place of the entity name where appropriate in the UI.
|
|
format
|
The formatting string used for displaying numeric values.
|
|
hidden
|
Indicates whether the UI should hide the entity where appropriate.
|
|
manage
|
How and whether Insight handles an entity. Defines how the system manages the entity data.
|
|
read_only
|
Whether an entity is readonly. Specifies that the value(s) of the entity cannot be modified. See also
hidden.
|
|
transform_labels_entity
|
The name of an entity in the schema from which to read labels for values of this entity. The type of the index set of the labels entity must match the data type of this entity. The data type of the labels entity can be any primitive type.
|
|
update_after_execution
|
Whether the value of the entity in the scenario is updated with the value of the corresponding model entity at the end of the scenario execution. If
True the value of the entity is updated to correspond with the model entity after execution.
|
|
update_keep_result_data
|
Whether to retain result data when this input entity is updated outside a scenario execution (e.g. in a view or a REST API call). If
False, the result data may be deleted when a view or REST API request updates this entity, depending on the configuration of
AppConfig.result_data. If
True, the result data will not be deleted when this entity is updated.
|
|
update_progress
|
Whether the value of the entity in the scenario is sent on progress updates. If
True the value of the entity will be written back to the Insight repository when
insight.send_progress_update is called from an execution mode where the
send_progress attribute is
True.
|
|
default
|
The value to insert into any cells of this column that do not have a value when the DataFrame is loaded from the Insight scenario; optional. If specified, must be a value of the appropriate type for the
dtype of this entity (e.g. a
str if
dtype is
string).
|
|
entity_name
|
The name of the entity in the Insight app schema. If not given, use the column name preceded by the name of the containing DataFrame and an underscore.
|
© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.