Entity Definition Container Classes
xpressinsight.Entity
|
Abstract base class of all native Insight entities, excluding composed entities like DataFrames.
|
|
|
Alias to use for the entity in the UI.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether to retain the result data when the value of this entity is updated outside a scenario execution.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.EntityBase
|
Abstract base class of all Insight entities, including composed entities like DataFrames.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Query whether this entity would be managed as input / result.
|
|
|
Name of the attribute representing the entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.Scalar
|
The configuration of a scalar entity.
|
|
|
The constructor.
|
|
|
Alias to use for the entity in the UI.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Check if the type is correct and check the bounds.
|
|
|
Default value for this scalar.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether to retain the result data when the value of this entity is updated outside a scenario execution.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.Param
|
The configuration of a parameter entity.
|
|
|
Initializes Param with the data type or a default value (in which case data type is inferred).
|
|
|
Alias to use for the entity in the UI.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Check if the type is correct and check the bounds.
|
|
|
Default value for this scalar.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether to retain the result data when the value of this entity is updated outside a scenario execution.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.IndexBase
|
Abstract base class for entities that will be represented as sets in the Insight schema.
|
|
|
Alias to use for the entity in the UI.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether to retain the result data when the value of this entity is updated outside a scenario execution.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.Index
|
The configuration of an index entity, to be stored as a Pandas Index.
|
|
|
Create a new Index entity.
|
|
|
Alias to use for the entity in the UI.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Index is a pandas.Index.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether to retain the result data when the value of this entity is updated outside a scenario execution.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.PolarsIndex
|
The configuration of an index entity, to be represented as a Polars Series.
|
|
|
Create a new Index entity.
|
|
|
Alias to use for the entity in the UI.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.PolarsIndex is a polars.Series.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether to retain the result data when the value of this entity is updated outside a scenario execution.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.Series
|
The configuration of a Series entity, a declaration of a pandas Series data structure.
|
|
|
Initializes Series.
|
|
|
Alias to use for the entity in the UI.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Index entities for this entity.
|
|
|
Index entity names for this entity.
|
|
|
Index types for this series.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name to be used for this Pandas series.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Index names, modified so that each is unique.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether to retain the result data when the value of this entity is updated outside a scenario execution.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.Column
|
Represent a single column within a DataFrame or PolarsDataFrame entity.
|
|
|
Alias to use for the entity in the UI.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
The value used to fill empty cells in this column when the DataFrame is loaded from the Insight scenario.
|
|
|
The type of values in this entity.
|
|
|
Name of the entity.
|
|
|
Format string for entity values.
|
|
|
Whether the entity is hidden.
|
|
|
Index entities for this entity.
|
|
|
Index names for this entity.
|
|
|
Index types for this series.
|
|
|
Check whether the entity is managed as the given management type: input/result.
|
|
|
How the entity is managed.
|
|
|
Name of the attribute representing the entity.
|
|
|
Whether the entity can be edited from the UI.
|
|
|
Name of labels transformation series for this entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.DataFrame is a pandas.DataFrame.
|
|
|
Index names, modified so that each is unique.
|
|
|
Whether this input entity is also saved with results.
|
|
|
Whether to retain the result data when the value of this entity is updated outside a scenario execution.
|
|
|
Whether this is a 'progress' entity.
|
xpressinsight.DataFrameBase
|
Abstract base class for entities that comprise multiple columns with a shared index; the shared index can be a single or multiple index-type entities.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Columns in this DataFrame.
|
|
|
Index entities for this entity.
|
|
|
Index entity names for this entity.
|
|
|
Index types for this series.
|
|
|
Check whether the DataFrame has a column that is managed as the given management type.
|
|
|
Name of the attribute representing the entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Index names, modified so that each is unique.
|
|
|
Check whether DataFrame has any columns where the update_progress attribute is True.
|
xpressinsight.DataFrame
|
The configuration of a DataFrame entity, which is a group of columns with a shared index, stored as a Pandas DataFrame.
|
|
|
Initializes DataFrame.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Verifies that the given value can be used as the value of an entity of this type, considering only the given subset of columns (if specified; all columns if not).
|
|
|
Columns in this DataFrame.
|
|
|
Index entities for this entity.
|
|
|
Index entity names for this entity.
|
|
|
Index types for this series.
|
|
|
Check whether the DataFrame has a column that is managed as the given management type.
|
|
|
Name of the attribute representing the entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.Series is a pandas.Series.
|
|
|
Index names, modified so that each is unique.
|
|
|
Check whether DataFrame has any columns where the update_progress attribute is True.
|
xpressinsight.PolarsDataFrame
|
The configuration of a PolarsDataFrame entity, which is a group of columns with a shared index, represented as a Polars DataFrame.
|
|
|
Initializes PolarsDataFrame.
|
|
|
Verifies that the given value can be used as the value of an entity of this type.
|
|
|
Verifies that the given value can be used as the value of an entity of this type, considering only the given subset of columns (if specified; all columns if not).
|
|
|
Columns in this DataFrame.
|
|
|
Index entities for this entity.
|
|
|
Index entity names for this entity.
|
|
|
Index types for this series.
|
|
|
Check whether the DataFrame has a column that is managed as the given management type.
|
|
|
Name of the attribute representing the entity.
|
|
|
The target Python type for values in this Insight entity - e.g. the Python target type of an xpressinsight.PolarsDataFrame is a polars.DataFrame.
|
|
|
Index names, modified so that each is unique.
|
|
|
Check whether DataFrame has any columns where the update_progress attribute is True.
|
© 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.