Skip to content

TopicIRMetric

Source code in docs_src/capo_quicksight/types/topic_ir_metric.py
class TopicIRMetric(TypedDict, closed=True):
    metric_id: NotRequired["capo_quicksight.types.identifier.Identifier"]
    """<p>The metric ID for the <code>TopicIRMetric</code>.</p>"""
    function: NotRequired["capo_quicksight.types.agg_function.AggFunction"]
    """<p>The function for the <code>TopicIRMetric</code>.</p>"""
    operands: NotRequired["capo_quicksight.types.operand_list.OperandList"]
    """<p>The operands for the <code>TopicIRMetric</code>.</p>"""
    comparison_method: NotRequired[
        "capo_quicksight.types.topic_ir_comparison_method.TopicIRComparisonMethod"
    ]
    """<p>The comparison method for the <code>TopicIRMetric</code>.</p>"""
    expression: NotRequired["capo_quicksight.types.expression.Expression"]
    """<p>The expression for the <code>TopicIRMetric</code>.</p>"""
    calculated_field_references: NotRequired[
        "capo_quicksight.types.calculated_field_reference_list.CalculatedFieldReferenceList"
    ]
    """<p>The calculated field references for the <code>TopicIRMetric</code>.</p>"""
    display_format: NotRequired["capo_quicksight.types.display_format.DisplayFormat"]
    """<p>The display format for the <code>TopicIRMetric</code>.</p>"""
    display_format_options: NotRequired[
        "capo_quicksight.types.display_format_options.DisplayFormatOptions"
    ]
    named_entity: NotRequired["capo_quicksight.types.named_entity_ref.NamedEntityRef"]
    """<p>The named entity for the <code>TopicIRMetric</code>.</p>"""

calculated_field_references instance-attribute

calculated_field_references: NotRequired[CalculatedFieldReferenceList]

The calculated field references for the TopicIRMetric.

comparison_method instance-attribute

comparison_method: NotRequired[TopicIRComparisonMethod]

The comparison method for the TopicIRMetric.

display_format instance-attribute

display_format: NotRequired[DisplayFormat]

The display format for the TopicIRMetric.

display_format_options instance-attribute

display_format_options: NotRequired[DisplayFormatOptions]

expression instance-attribute

expression: NotRequired[Expression]

The expression for the TopicIRMetric.

function instance-attribute

function: NotRequired[AggFunction]

The function for the TopicIRMetric.

metric_id instance-attribute

metric_id: NotRequired[Identifier]

The metric ID for the TopicIRMetric.

named_entity instance-attribute

named_entity: NotRequired[NamedEntityRef]

The named entity for the TopicIRMetric.

operands instance-attribute

operands: NotRequired[OperandList]

The operands for the TopicIRMetric.