Skip to content

EvaluationForm

Source code in docs_src/capo_connect/types/evaluation_form.py
class EvaluationForm(TypedDict, closed=True):
    evaluation_form_id: "capo_connect.types.resource_id.ResourceId"
    """<p>The unique identifier for the evaluation form.</p>"""
    evaluation_form_version: "capo_connect.types.version_number.VersionNumber"
    """<p>A version of the evaluation form.</p>"""
    locked: "capo_connect.types.evaluation_form_version_is_locked.EvaluationFormVersionIsLocked"
    """<p>The flag indicating whether the evaluation form is locked for changes.</p>"""
    evaluation_form_arn: "capo_connect.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>"""
    title: "capo_connect.types.evaluation_form_title.EvaluationFormTitle"
    """<p>A title of the evaluation form.</p>"""
    description: NotRequired[
        "capo_connect.types.evaluation_form_description.EvaluationFormDescription"
    ]
    """<p>The description of the evaluation form.</p>"""
    status: (
        "capo_connect.types.evaluation_form_version_status.EvaluationFormVersionStatus"
    )
    """<p>The status of the evaluation form.</p>"""
    items: "capo_connect.types.evaluation_form_items_list.EvaluationFormItemsList"
    """<p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>"""
    scoring_strategy: NotRequired[
        "capo_connect.types.evaluation_form_scoring_strategy.EvaluationFormScoringStrategy"
    ]
    """<p>A scoring strategy of the evaluation form.</p>"""
    created_time: "capo_connect.types.timestamp.Timestamp"
    """<p>The timestamp for when the evaluation form was created.</p>"""
    created_by: "capo_connect.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>"""
    last_modified_time: "capo_connect.types.timestamp.Timestamp"
    """<p>The timestamp for when the evaluation form was last updated.</p>"""
    last_modified_by: "capo_connect.types.arn.ARN"
    """<p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>"""
    auto_evaluation_configuration: NotRequired[
        "capo_connect.types.evaluation_form_auto_evaluation_configuration.EvaluationFormAutoEvaluationConfiguration"
    ]
    """<p>The automatic evaluation configuration of an evaluation form.</p>"""
    review_configuration: NotRequired[
        "capo_connect.types.evaluation_review_configuration.EvaluationReviewConfiguration"
    ]
    """<p>Configuration for evaluation review settings of this evaluation form.</p>"""
    tags: NotRequired["capo_connect.types.tag_map.TagMap"]
    """<p>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</p>"""
    target_configuration: NotRequired[
        "capo_connect.types.evaluation_form_target_configuration.EvaluationFormTargetConfiguration"
    ]
    """<p>Configuration that specifies the target for this evaluation form.</p>"""
    language_configuration: NotRequired[
        "capo_connect.types.evaluation_form_language_configuration.EvaluationFormLanguageConfiguration"
    ]
    """<p>Configuration for language settings of this evaluation form.</p>"""
    latest_validation_status: NotRequired[
        "capo_connect.types.evaluation_form_validation_status.EvaluationFormValidationStatus"
    ]
    """<p>The status of the most recent validation run for this evaluation form. Valid values: <code>IN_PROGRESS</code>, <code>COMPLETED</code>, <code>FAILED</code>.</p>"""
    last_validation_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>The timestamp when the most recent validation was started for this evaluation form.</p>"""
    ai_version: NotRequired[
        "capo_connect.types.evaluation_form_ai_version.EvaluationFormAIVersion"
    ]
    """<p>The AI version to use for the evaluation form. This specifies which AI model version is used for automated evaluations.</p>"""

ai_version instance-attribute

ai_version: NotRequired[EvaluationFormAIVersion]

The AI version to use for the evaluation form. This specifies which AI model version is used for automated evaluations.

auto_evaluation_configuration instance-attribute

auto_evaluation_configuration: NotRequired[EvaluationFormAutoEvaluationConfiguration]

The automatic evaluation configuration of an evaluation form.

created_by instance-attribute

created_by: ARN

The Amazon Resource Name (ARN) of the user who created the evaluation form.

created_time instance-attribute

created_time: Timestamp

The timestamp for when the evaluation form was created.

description instance-attribute

description: NotRequired[EvaluationFormDescription]

The description of the evaluation form.

evaluation_form_arn instance-attribute

evaluation_form_arn: ARN

The Amazon Resource Name (ARN) for the evaluation form resource.

evaluation_form_id instance-attribute

evaluation_form_id: ResourceId

The unique identifier for the evaluation form.

evaluation_form_version instance-attribute

evaluation_form_version: VersionNumber

A version of the evaluation form.

items instance-attribute

Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

language_configuration instance-attribute

language_configuration: NotRequired[EvaluationFormLanguageConfiguration]

Configuration for language settings of this evaluation form.

last_modified_by instance-attribute

last_modified_by: ARN

The Amazon Resource Name (ARN) of the user who last updated the evaluation form.

last_modified_time instance-attribute

last_modified_time: Timestamp

The timestamp for when the evaluation form was last updated.

last_validation_time instance-attribute

last_validation_time: NotRequired[Timestamp]

The timestamp when the most recent validation was started for this evaluation form.

latest_validation_status instance-attribute

latest_validation_status: NotRequired[EvaluationFormValidationStatus]

The status of the most recent validation run for this evaluation form. Valid values: IN_PROGRESS, COMPLETED, FAILED.

locked instance-attribute

The flag indicating whether the evaluation form is locked for changes.

review_configuration instance-attribute

review_configuration: NotRequired[EvaluationReviewConfiguration]

Configuration for evaluation review settings of this evaluation form.

scoring_strategy instance-attribute

scoring_strategy: NotRequired[EvaluationFormScoringStrategy]

A scoring strategy of the evaluation form.

status instance-attribute

The status of the evaluation form.

tags instance-attribute

tags: NotRequired[TagMap]

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

target_configuration instance-attribute

target_configuration: NotRequired[EvaluationFormTargetConfiguration]

Configuration that specifies the target for this evaluation form.

title instance-attribute

A title of the evaluation form.