Skip to content

EvaluationFormQuestion

Source code in docs_src/capo_connect/types/evaluation_form_question.py
class EvaluationFormQuestion(TypedDict, closed=True):
    title: (
        "capo_connect.types.evaluation_form_question_title.EvaluationFormQuestionTitle"
    )
    """<p>The title of the question.</p>"""
    instructions: NotRequired[
        "capo_connect.types.evaluation_form_question_instructions.EvaluationFormQuestionInstructions"
    ]
    """<p>The instructions of the section.</p>"""
    ref_id: "capo_connect.types.reference_id.ReferenceId"
    """<p>The identifier of the question. An identifier must be unique within the evaluation form.</p>"""
    not_applicable_enabled: "capo_connect.types.boolean.Boolean"
    """<p>The flag to enable not applicable answers to the question.</p>"""
    question_type: (
        "capo_connect.types.evaluation_form_question_type.EvaluationFormQuestionType"
    )
    """<p>The type of the question.</p>"""
    question_type_properties: NotRequired[
        "capo_connect.types.evaluation_form_question_type_properties.EvaluationFormQuestionTypeProperties"
    ]
    """<p>The properties of the type of question. Text questions do not have to define question type properties.</p>"""
    enablement: NotRequired[
        "capo_connect.types.evaluation_form_item_enablement_configuration.EvaluationFormItemEnablementConfiguration"
    ]
    """<p>A question conditional enablement.</p>"""
    weight: "capo_connect.types.evaluation_form_item_weight.EvaluationFormItemWeight"
    """<p>The scoring weight of the section.</p>"""
    scoring_configuration: NotRequired[
        "capo_connect.types.evaluation_form_question_scoring_configuration.EvaluationFormQuestionScoringConfiguration"
    ]
    """<p>The scoring configuration of the question.</p>"""
    metric_configuration: NotRequired[
        "capo_connect.types.evaluation_form_metric_configuration.EvaluationFormMetricConfiguration"
    ]
    """<p>The metric configuration for the question. Use this to associate a business outcome metric with the question.</p>"""

enablement instance-attribute

A question conditional enablement.

instructions instance-attribute

instructions: NotRequired[EvaluationFormQuestionInstructions]

The instructions of the section.

metric_configuration instance-attribute

metric_configuration: NotRequired[EvaluationFormMetricConfiguration]

The metric configuration for the question. Use this to associate a business outcome metric with the question.

not_applicable_enabled instance-attribute

not_applicable_enabled: Boolean

The flag to enable not applicable answers to the question.

question_type instance-attribute

The type of the question.

question_type_properties instance-attribute

question_type_properties: NotRequired[EvaluationFormQuestionTypeProperties]

The properties of the type of question. Text questions do not have to define question type properties.

ref_id instance-attribute

ref_id: ReferenceId

The identifier of the question. An identifier must be unique within the evaluation form.

scoring_configuration instance-attribute

scoring_configuration: NotRequired[EvaluationFormQuestionScoringConfiguration]

The scoring configuration of the question.

title instance-attribute

The title of the question.

weight instance-attribute

The scoring weight of the section.