Skip to content

CreateEvaluationFormRequest

Source code in docs_src/capo_connect/types/create_evaluation_form_request.py
class CreateEvaluationFormRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</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>"""
    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>"""
    auto_evaluation_configuration: NotRequired[
        "capo_connect.types.evaluation_form_auto_evaluation_configuration.EvaluationFormAutoEvaluationConfiguration"
    ]
    """<p>Configuration information about automated evaluations.</p>"""
    client_token: NotRequired["capo_connect.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>"""
    as_draft: "capo_connect.types.boxed_boolean.BoxedBoolean"
    """<p>A boolean flag indicating whether to create evaluation form in draft state.</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>"""
    review_configuration: NotRequired[
        "capo_connect.types.evaluation_review_configuration.EvaluationReviewConfiguration"
    ]
    """<p>Configuration information about evaluation reviews.</p>"""
    target_configuration: NotRequired[
        "capo_connect.types.evaluation_form_target_configuration.EvaluationFormTargetConfiguration"
    ]
    """<p>Configuration that specifies the target for the evaluation form.</p>"""
    language_configuration: NotRequired[
        "capo_connect.types.evaluation_form_language_configuration.EvaluationFormLanguageConfiguration"
    ]
    """<p>Configuration for language settings of the 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.

as_draft instance-attribute

as_draft: BoxedBoolean

A boolean flag indicating whether to create evaluation form in draft state.

auto_evaluation_configuration instance-attribute

auto_evaluation_configuration: NotRequired[EvaluationFormAutoEvaluationConfiguration]

Configuration information about automated evaluations.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

description instance-attribute

description: NotRequired[EvaluationFormDescription]

The description of the evaluation form.

instance_id instance-attribute

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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 the evaluation form.

review_configuration instance-attribute

review_configuration: NotRequired[EvaluationReviewConfiguration]

Configuration information about evaluation reviews.

scoring_strategy instance-attribute

scoring_strategy: NotRequired[EvaluationFormScoringStrategy]

A scoring strategy 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 the evaluation form.

title instance-attribute

A title of the evaluation form.