Creates an evaluation form in the specified Connect Customer instance¶

Description¶

Creates an evaluation form in the specified Connect Customer instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

Usage¶

connect_create_evaluation_form(InstanceId, Title, Description, Items,
  ScoringStrategy, AutoEvaluationConfiguration, ClientToken, AsDraft,
  Tags, ReviewConfiguration, TargetConfiguration, LanguageConfiguration,
  AIVersion)

Arguments¶

InstanceId

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

[required] A title of the evaluation form.
Description

The description of the evaluation form.
Items

[required] 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.
ScoringStrategy

A scoring strategy of the evaluation form.
AutoEvaluationConfiguration

Configuration information about automated evaluations.
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.
AsDraft

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

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

Configuration information about evaluation reviews.
TargetConfiguration

Configuration that specifies the target for the evaluation form.
LanguageConfiguration

Configuration for language settings of the evaluation form.
AIVersion

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

Value¶

A list with the following syntax:

list(
  EvaluationFormId = "string",
  EvaluationFormArn = "string"
)

Request syntax¶

svc$create_evaluation_form(
  InstanceId = "string",
  Title = "string",
  Description = "string",
  Items = list(
    list(
      Section = list(
        Title = "string",
        RefId = "string",
        Instructions = "string",
        Items = list(),
        Weight = 123.0,
        IsExcludedFromScoring = TRUE|FALSE,
        ScoreThresholds = list(
          list(
            PerformanceCategory = "NEEDS_IMPROVEMENT"|"EXCEEDS_EXPECTATIONS",
            MinScorePercentage = 123.0,
            MaxScorePercentage = 123.0
          )
        )
      ),
      Question = list(
        Title = "string",
        Instructions = "string",
        RefId = "string",
        NotApplicableEnabled = TRUE|FALSE,
        QuestionType = "TEXT"|"SINGLESELECT"|"NUMERIC"|"MULTISELECT"|"DATETIME",
        QuestionTypeProperties = list(
          Numeric = list(
            MinValue = 123,
            MaxValue = 123,
            Options = list(
              list(
                MinValue = 123,
                MaxValue = 123,
                Score = 123,
                AutomaticFail = TRUE|FALSE,
                AutomaticFailConfiguration = list(
                  TargetSection = "string"
                ),
                PointsConfiguration = list(
                  PointValue = 123,
                  IsBonus = TRUE|FALSE
                )
              )
            ),
            Automation = list(
              PropertyValue = list(
                Label = "OVERALL_CUSTOMER_SENTIMENT_SCORE"|"OVERALL_AGENT_SENTIMENT_SCORE"|"CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT"|"CUSTOMER_SENTIMENT_SCORE_WITH_AGENT"|"NON_TALK_TIME"|"NON_TALK_TIME_PERCENTAGE"|"NUMBER_OF_INTERRUPTIONS"|"CONTACT_DURATION"|"AGENT_INTERACTION_DURATION"|"CUSTOMER_HOLD_TIME"|"LONGEST_HOLD_DURATION"|"NUMBER_OF_HOLDS"|"AGENT_INTERACTION_AND_HOLD_DURATION"
              ),
              AnswerSource = list(
                SourceType = "CONTACT_LENS_DATA"|"GEN_AI"
              )
            )
          ),
          SingleSelect = list(
            Options = list(
              list(
                RefId = "string",
                Text = "string",
                Score = 123,
                AutomaticFail = TRUE|FALSE,
                AutomaticFailConfiguration = list(
                  TargetSection = "string"
                ),
                PointsConfiguration = list(
                  PointValue = 123,
                  IsBonus = TRUE|FALSE
                )
              )
            ),
            DisplayAs = "DROPDOWN"|"RADIO",
            Automation = list(
              Options = list(
                list(
                  RuleCategory = list(
                    Category = "string",
                    Condition = "PRESENT"|"NOT_PRESENT",
                    OptionRefId = "string"
                  )
                )
              ),
              DefaultOptionRefId = "string",
              AnswerSource = list(
                SourceType = "CONTACT_LENS_DATA"|"GEN_AI"
              )
            )
          ),
          Text = list(
            Automation = list(
              AnswerSource = list(
                SourceType = "CONTACT_LENS_DATA"|"GEN_AI"
              )
            )
          ),
          MultiSelect = list(
            Options = list(
              list(
                RefId = "string",
                Text = "string",
                Score = 123,
                AutomaticFail = TRUE|FALSE,
                AutomaticFailConfiguration = list(
                  TargetSection = "string"
                ),
                PointsConfiguration = list(
                  PointValue = 123,
                  IsBonus = TRUE|FALSE
                )
              )
            ),
            DisplayAs = "DROPDOWN"|"CHECKBOX",
            Automation = list(
              Options = list(
                list(
                  RuleCategory = list(
                    Category = "string",
                    Condition = "PRESENT"|"NOT_PRESENT",
                    OptionRefIds = list(
                      "string"
                    )
                  )
                )
              ),
              DefaultOptionRefIds = list(
                "string"
              ),
              AnswerSource = list(
                SourceType = "CONTACT_LENS_DATA"|"GEN_AI"
              )
            )
          )
        ),
        Enablement = list(
          Condition = list(
            Operands = list(
              list(
                Expression = list(
                  Source = list(
                    Type = "QUESTION_REF_ID",
                    RefId = "string"
                  ),
                  Values = list(
                    list(
                      Type = "OPTION_REF_ID",
                      RefId = "string"
                    )
                  ),
                  Comparator = "IN"|"NOT_IN"|"ALL_IN"|"EXACT"
                ),
                Condition = list()
              )
            ),
            Operator = "OR"|"AND"
          ),
          Action = "DISABLE"|"ENABLE",
          DefaultAction = "DISABLE"|"ENABLE"
        ),
        Weight = 123.0,
        ScoringConfiguration = list(
          PointsConfiguration = list(
            MaxPointValue = 123,
            MinPointValue = 123,
            IsBonus = TRUE|FALSE
          ),
          IsExcludedFromScoring = TRUE|FALSE,
          ScoreThresholds = list(
            list(
              PerformanceCategory = "NEEDS_IMPROVEMENT"|"EXCEEDS_EXPECTATIONS",
              MinScorePercentage = 123.0,
              MaxScorePercentage = 123.0
            )
          )
        ),
        MetricConfiguration = list(
          MetricType = "BUSINESS_OUTCOME",
          MetricName = "string"
        )
      )
    )
  ),
  ScoringStrategy = list(
    Mode = "QUESTION_ONLY"|"SECTION_ONLY"|"POINTS_BASED",
    Status = "ENABLED"|"DISABLED",
    ScoreThresholds = list(
      list(
        PerformanceCategory = "NEEDS_IMPROVEMENT"|"EXCEEDS_EXPECTATIONS",
        MinScorePercentage = 123.0,
        MaxScorePercentage = 123.0
      )
    )
  ),
  AutoEvaluationConfiguration = list(
    Enabled = TRUE|FALSE
  ),
  ClientToken = "string",
  AsDraft = TRUE|FALSE,
  Tags = list(
    "string"
  ),
  ReviewConfiguration = list(
    ReviewNotificationRecipients = list(
      list(
        Type = "USER_ID",
        Value = list(
          UserId = "string"
        )
      )
    ),
    EligibilityDays = 123
  ),
  TargetConfiguration = list(
    ContactInteractionType = "AGENT"|"AUTOMATED"|"CUSTOMER"
  ),
  LanguageConfiguration = list(
    FormLanguage = "de-DE"|"en-US"|"es-ES"|"fr-FR"|"it-IT"|"pt-BR"|"ja-JP"|"ko-KR"|"zh-CN"|"ms-MY"
  ),
  AIVersion = "string"
)